Vincular 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}}/{{catalog_id}}/product_catalogs: Vincular catálogo a WABA
GET /v1/catalog/{{waba_id}}/product_catalogs: Consultar catálogos vinculados a WABA
DELETE /v1/catalog/{{waba_id}}/{{catalog_id}}/product_catalogs: Desvincular catálogo de WABA
POST /v1/catalog/{{waba_id}}/{{catalog_id}}/{{phone_number_id}}: Asignar catálogo a número de teléfono
POST /v1/catalog/{{waba_id}}/{{phone_number_id}}/whatsapp_commerce_settings: Configurar opciones de comercio

Vincula, consulta y desvincula los catálogos de tu WABA, asigna un catálogo a un número de teléfono y configura sus opciones de comercio (carrito y visibilidad del catálogo). Si la petición es correcta, todos los servicios responden con el código HTTP 200.

Vincular catálogo a WABA

Petición

Petición de Vincular catálogo a WABA:


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

Encabezados

Encabezados de Vincular catálogo a WABA:

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

Parámetros

Parámetros de Vincular catálogo a WABA:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
catalog_id	ID de un catálogo creado con el servicio Crear catálogo.	String	Obligatorio

Ejemplo

Ejemplo completo de Vincular catálogo a WABA:

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

Respuesta

Respuesta de Vincular catálogo a WABA:

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

{
    "success": true
}

Consultar catálogos vinculados a WABA

Petición

Petición de Consultar catálogos vinculados a WABA:


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

Encabezados

Encabezados de Consultar catálogos vinculados a WABA:

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

Parámetros

Parámetros de Consultar catálogos vinculados a WABA:

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

Ejemplo

Ejemplo completo de Consultar catálogos vinculados a WABA:

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

Respuesta

Respuesta de Consultar catálogos vinculados a WABA:

Nombre	Descripción	Tipo
data	Catálogos vinculados a la WABA.	Lista de objetos linked catalog
paging	Información de paginación.	Objeto

Objeto linked catalog

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

{
    "data": [
        {
            "id": "1234567890123456",
            "name": "Catálogo de cursos"
        }
    ],
    "paging": {
        "cursors": {
            "before": "QVFIUjExampleBefore",
            "after": "QVFIUjExampleAfter"
        }
    }
}

Objeto paging

Nombre	Descripción	Tipo
cursors	Cursores de la página actual.	Objeto

Objeto cursors

Nombre	Descripción	Tipo
before	Cursor que apunta al inicio de la página.	String
after	Cursor que apunta al final de la página.	String

Desvincular catálogo de WABA

Petición

Petición de Desvincular catálogo de WABA:


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

Encabezados

Encabezados de Desvincular catálogo de WABA:

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

Parámetros

Parámetros de Desvincular catálogo de WABA:

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

Ejemplo

Ejemplo completo de Desvincular catálogo de WABA:

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

Respuesta

Respuesta de Desvincular catálogo de WABA:

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

{
    "success": true
}

Asignar catálogo a número de teléfono

Petición

Petición de Asignar catálogo a número de teléfono:


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

Encabezados

Encabezados de Asignar catálogo a número de teléfono:

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

Parámetros

Parámetros de Asignar catálogo a número de teléfono:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
catalog_id	ID del catálogo.	String	Obligatorio
phone_number_id	ID del número de teléfono de la WABA al que se asigna el catálogo.	String	Obligatorio

Ejemplo

Ejemplo completo de Asignar catálogo a número de teléfono:

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

Respuesta

Respuesta de Asignar catálogo a número de teléfono:

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

{
    "success": true
}

Configurar opciones de comercio

Define si el carrito de compras está habilitado y si el catálogo es visible en el perfil del número de teléfono.

Petición

Petición de Configurar opciones de comercio:


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

Encabezados

Encabezados de Configurar opciones de comercio:

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 Configurar opciones de comercio:

Nombre	Descripción	Tipo	Requerimientos
waba_id	ID de la cuenta de WhatsApp Business.	String	Obligatorio
phone_number_id	ID del número de teléfono.	String	Obligatorio

Cuerpo

Campos del cuerpo de Configurar opciones de comercio:

Nombre	Descripción	Tipo	Requerimientos
is_cart_enabled	Con `true` se habilita el carrito de compras.	Boolean	Obligatorio
is_catalog_visible	Con `true` el catálogo es visible en el perfil del número.	Boolean	Obligatorio

Ejemplo

Ejemplo completo de Configurar opciones de comercio:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{phone_number_id}}/whatsapp_commerce_settings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "is_cart_enabled": true,
    "is_catalog_visible": true
}'

Respuesta

Respuesta de Configurar opciones de comercio:

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

{
    "success": true
}

Administrar catálogos

Productos