Products

Manage products in batch

Create, update, or delete products in a catalog with a single request. Processing is asynchronous: use the handles in the response to check the request status.

Request

Manage products in batch request:

Headers

Manage products in batch headers:

Parameters

Manage products in batch parameters:

Body

Manage products in batch body fields:

Product request object

Product data object

Fields marked as required are only validated when method is CREATE.

Example

Complete Manage products in batch example:

💾
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": "ENGLISH_COURSE_001",
            "data": {
                "name": "Intensive English course",
                "description": "Live 3-hour classes on Saturdays.",
                "availability": "in stock",
                "condition": "new",
                "price": "1000.00",
                "currency": "MXN",
                "image_url": "https://www.example.com/images/english-course-001.png",
                "url": "https://www.example.com/courses/intensive-english",
                "brand": "Example Academy"
            }
        },
        {
            "method": "UPDATE",
            "retailer_id": "ENGLISH_COURSE_002",
            "data": {
                "availability": "out of stock"
            }
        },
        {
            "method": "DELETE",
            "retailer_id": "ENGLISH_COURSE_003"
        }
    ]
}'

Response

Manage products in batch response:

Validation status object

Validation error object

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

Manage localized products in batch

Create, update, or delete localized information (by language or country) for products that already exist in the catalog. Processing is asynchronous: use the handles in the response to check the request status.

Request

Manage localized products in batch request:

Headers

Manage localized products in batch headers:

Parameters

Manage localized products in batch parameters:

Body

Manage localized products in batch body fields:

Localized request object

Localization object

Localized data object

Send only the fields that change for the given localization.

Example

Complete Manage localized products in batch example:

💾
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": "ENGLISH_COURSE_001",
                "title": "Intensive English course",
                "description": "Live 3-hour classes on Saturdays."
            }
        },
        {
            "method": "CREATE",
            "localization": {
                "type": "COUNTRY",
                "value": "US"
            },
            "data": {
                "id": "ENGLISH_COURSE_001",
                "availability": "in stock",
                "price": "59.99 USD"
            }
        }
    ]
}'

Response

Manage localized products in batch response:

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

Check batch request status

Returns the result of a product batch or localized product batch request.

Request

Check batch request status request:

Headers

Check batch request status headers:

Parameters

Check batch request status parameters:

Example

Complete Check batch request status example:

💾
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}}'

Response

Check batch request status response:

Batch status object

Batch error object

Request with no errors:

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

Request with errors:

💾
{
    "data": [
        {
            "handle": "AcxExampleHandle0002aBcDeFgHiJkLmNoPqRsTuVwXyZ",
            "status": "finished",
            "errors_total_count": 1,
            "errors": [
                {
                    "line": 0,
                    "id": "ENGLISH_COURSE_001",
                    "message": "Invalid value: The value passed at position 0 (id=ENGLISH_COURSE_001) is invalid."
                }
            ]
        }
    ]
}

List products

Request

List products request:

Headers

List products headers:

Parameters

List products parameters:

Example

Complete List products example:

💾
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}}'

Response

List products response:

The service returns a list of products.

💾
[
    {
        "id": "7001234567890123",
        "name": "Intensive English course",
        "retailerId": "ENGLISH_COURSE_001",
        "imageUrl": "https://www.example.com/images/english-course-001.png",
        "inventory": 100,
        "availability": "in stock",
        "price": "$1,000.00",
        "currency": "MXN",
        "condition": "new",
        "description": "Live 3-hour classes on Saturdays.",
        "url": "https://www.example.com/courses/intensive-english"
    }
]