Administrar catálogos

Last update: 4 days ago by Irais Aguirre

Resumen para integración
URL base: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: de administración, en el encabezado Authorization: Bearer {{admin-token}} (cómo generarlo)
Endpoints en esta página:
POST /v1/catalog/{{waba_id}}: Crear catálogo
GET /v1/catalog/{{waba_id}}: Listar catálogos
POST /v1/catalog/{{waba_id}}/{{catalog_id}}: Actualizar catálogo
DELETE /v1/catalog/{{waba_id}}/{{catalog_id}}: Eliminar catálogo

Crea, lista, actualiza y elimina los catálogos de tu cuenta de WhatsApp Business (WABA). Si la petición es correcta, todos los servicios responden con el código HTTP 200.

Crear catálogo

Petición

Petición de Crear catálogo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}
Método	POST
Tipo	application/json

Encabezados

Encabezados de Crear catálogo:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Crear catálogo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio

Cuerpo

Campos del cuerpo de Crear catálogo:

Nombre	Descripción	Tipo	Requerimientos
name	Nombre del catálogo.	String	Obligatorio. No puede estar vacío.
vertical	Sector del catálogo. Los valores pueden ser: adoptable_pets commerce destinations flights generic home_listings hotels local_service_businesses offer_items offline_commerce transactable_items vehicles La lista y el valor por defecto (`commerce`) los valida Meta de forma posterior, no este servicio.	String	Opcional. El valor por defecto es `commerce`.

Ejemplo

Ejemplo completo de Crear catálogo:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "name": "Catálogo de cursos",
    "vertical": "commerce"
}'

Respuesta

Respuesta de Crear catálogo:

Nombre	Descripción	Tipo
id	ID del catálogo creado.	String

{
    "id": "1234567890123456"
}

Listar catálogos

Devuelve los catálogos activos que creaste para la WABA con el servicio Crear catálogo.

Petición

Petición de Listar catálogos:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}
Método	GET

Encabezados

Encabezados de Listar catálogos:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Listar catálogos:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio

Ejemplo

Ejemplo completo de Listar catálogos:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Listar catálogos:

El servicio responde con una lista de catálogos.

Nombre	Descripción	Tipo
id	ID del catálogo.	String
name	Nombre del catálogo.	String
vertical	Sector del catálogo.	String

[
    {
        "id": "1234567890123456",
        "name": "Catálogo de cursos",
        "vertical": "commerce"
    },
    {
        "id": "6543210987654321",
        "name": "Catálogo de libros",
        "vertical": "commerce"
    }
]

Actualizar catálogo

Cambia el nombre de un catálogo.

Petición

Petición de Actualizar catálogo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}
Método	POST
Tipo	application/json

Encabezados

Encabezados de Actualizar catálogo:

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Actualizar catálogo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
catalog_id	ID del catálogo.	String	Obligatorio

Cuerpo

Campos del cuerpo de Actualizar catálogo:

Nombre	Descripción	Tipo	Requerimientos
name	Nuevo nombre del catálogo.	String	Obligatorio. No puede estar vacío.

Nota: los campos desconocidos en el cuerpo de la petición se rechazan. El DTO es estricto (@JsonIgnoreProperties(ignoreUnknown = false)), por lo que un error de escritura en el nombre de un campo o cualquier propiedad adicional devuelve un error 400.

Ejemplo

Ejemplo completo de Actualizar catálogo:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "name": "Catálogo de cursos 2026"
}'

Respuesta

Respuesta de Actualizar catálogo:

Nombre	Descripción	Tipo
success	Indica si la operación se realizó con éxito.	Boolean

{
    "success": true
}

Eliminar catálogo

Petición

Petición de Eliminar catálogo:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}
Método	DELETE

Encabezados

Encabezados de Eliminar catálogo:

Nombre	Descripción	Tipo	Requerimientos
Authorization	Token de administración. Consulta Generar Token de Autenticación.	String	Obligatorio

Parámetros

Parámetros de Eliminar catálogo:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
catalog_id	ID del catálogo a eliminar.	String	Obligatorio
allowDeleteCatalogWithLiveProductSet	Si el catálogo tiene conjuntos de productos activos, la eliminación se bloquea. Envía `true` para eliminarlo de todos modos. Se envía como parámetro de consulta (query).	Boolean	Opcional. El valor por defecto es `false`.

Ejemplo

Ejemplo completo de Eliminar catálogo:

curl --location --request DELETE 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}?allowDeleteCatalogWithLiveProductSet=true' \
--header 'Authorization: Bearer {{admin-token}}'

Respuesta

Respuesta de Eliminar catálogo:

Nombre	Descripción	Tipo
success	Indica si la operación se realizó con éxito.	Boolean

{
    "success": true
}

Whatsapp — Anterior

Catálogos

Vincular catálogos