Productos

Gestionar productos por lote

Crea, actualiza o elimina productos de un catálogo en una sola petición. El procesamiento es asíncrono: usa los handles de la respuesta para consultar el estatus de la petición.

Petición

Petición de Gestionar productos por lote:

Encabezados

Encabezados de Gestionar productos por lote:

Parámetros

Parámetros de Gestionar productos por lote:

Cuerpo

Campos del cuerpo de Gestionar productos por lote:

Objeto product request

Objeto product data

Los campos marcados como obligatorios solo se validan cuando method es CREATE.

Ejemplo

Ejemplo completo de Gestionar productos por lote:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}/items_batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "requests": [
        {
            "method": "CREATE",
            "retailer_id": "CURSO_INGLES_001",
            "data": {
                "name": "Curso intensivo de inglés",
                "description": "Clases en vivo de 3 horas los sábados.",
                "availability": "in stock",
                "condition": "new",
                "price": "1000.00",
                "currency": "MXN",
                "image_url": "https://www.example.com/images/curso-ingles-001.png",
                "url": "https://www.example.com/cursos/ingles-intensivo",
                "brand": "Academia Ejemplo"
            }
        },
        {
            "method": "UPDATE",
            "retailer_id": "CURSO_INGLES_002",
            "data": {
                "availability": "out of stock"
            }
        },
        {
            "method": "DELETE",
            "retailer_id": "CURSO_INGLES_003"
        }
    ]
}'

Respuesta

Respuesta de Gestionar productos por lote:

Objeto validation status

Objeto validation error

💾
{
    "handles": [
        "AcxExampleHandle0001aBcDeFgHiJkLmNoPqRsTuVwXyZ"
    ]
}

Gestionar productos localizados por lote

Crea, actualiza o elimina la información localizada (por idioma o país) de productos que ya existen en el catálogo. El procesamiento es asíncrono: usa los handles de la respuesta para consultar el estatus de la petición.

Petición

Petición de Gestionar productos localizados por lote:

Encabezados

Encabezados de Gestionar productos localizados por lote:

Parámetros

Parámetros de Gestionar productos localizados por lote:

Cuerpo

Campos del cuerpo de Gestionar productos localizados por lote:

Objeto localized request

Objeto localization

Objeto localized data

Envía solo los campos que cambian para la localización indicada.

Ejemplo

Ejemplo completo de Gestionar productos localizados por lote:

💾
curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/catalog/{{waba_id}}/{{catalog_id}}/localized_items_batch' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "item_type": "PRODUCT_ITEM",
    "requests": [
        {
            "method": "CREATE",
            "localization": {
                "type": "LANGUAGE",
                "value": "en_XX"
            },
            "data": {
                "id": "CURSO_INGLES_001",
                "title": "Intensive English course",
                "description": "Live 3-hour classes on Saturdays."
            }
        },
        {
            "method": "CREATE",
            "localization": {
                "type": "COUNTRY",
                "value": "US"
            },
            "data": {
                "id": "CURSO_INGLES_001",
                "availability": "in stock",
                "price": "59.99 USD"
            }
        }
    ]
}'

Respuesta

Respuesta de Gestionar productos localizados por lote:

💾
{
    "handles": [
        "AcxExampleHandle0002aBcDeFgHiJkLmNoPqRsTuVwXyZ"
    ]
}

Consultar estatus de petición por lote

Consulta el resultado de una petición de productos por lote o de productos localizados por lote.

Petición

Petición de Consultar estatus de petición por lote:

Encabezados

Encabezados de Consultar estatus de petición por lote:

Parámetros

Parámetros de Consultar estatus de petición por lote:

Ejemplo

Ejemplo completo de Consultar estatus de petición por lote:

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

Respuesta

Respuesta de Consultar estatus de petición por lote:

Objeto batch status

Objeto batch error

Petición sin errores:

💾
{
    "data": [
        {
            "handle": "AcxExampleHandle0001aBcDeFgHiJkLmNoPqRsTuVwXyZ",
            "status": "finished",
            "errors_total_count": 0,
            "errors": []
        }
    ]
}

Petición con errores:

💾
{
    "data": [
        {
            "handle": "AcxExampleHandle0002aBcDeFgHiJkLmNoPqRsTuVwXyZ",
            "status": "finished",
            "errors_total_count": 1,
            "errors": [
                {
                    "line": 0,
                    "id": "CURSO_INGLES_001",
                    "message": "Valor no válido: El valor pasado en la posición 0 (id=CURSO_INGLES_001) no es válido."
                }
            ]
        }
    ]
}

Listar productos

Petición

Petición de Listar productos:

Encabezados

Encabezados de Listar productos:

Parámetros

Parámetros de Listar productos:

Ejemplo

Ejemplo completo de Listar productos:

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

Respuesta

Respuesta de Listar productos:

El servicio responde con una lista de productos.

💾
[
    {
        "id": "7001234567890123",
        "name": "Curso intensivo de inglés",
        "retailerId": "CURSO_INGLES_001",
        "imageUrl": "https://www.example.com/images/curso-ingles-001.png",
        "inventory": 100,
        "availability": "in stock",
        "price": "$1,000.00",
        "currency": "MXN",
        "condition": "new",
        "description": "Clases en vivo de 3 horas los sábados.",
        "url": "https://www.example.com/cursos/ingles-intensivo"
    }
]