The Wherehouse Public API is in BETA. Please contact us should you wish to build a feature rich integration dev@wherehouse.co.za.

/product-batches

POST

https://api.wherehouse.co.za/v1/product-batches

Queue many product updates and get a ticket back immediately (202). Poll GET /product-batches/{ticket} for progress.

This is update only. Missing SKUs are recorded as errors on the ticket, they are not created. Max 2000 products per request.

Identify each row with code and catalogue_uid in the body (you can also set catalogue_uid once at the top level). Do not put SKUs in the URL.

Processing is rate limited so a large batch cannot starve the database. Each successful field change is written to the product change log against this API key.

Batch submit has a tighter budget than ordinary requests (10 per minute per key by default), on top of the usual 120 requests per minute.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params application/jsonRequired

Example

{
    "catalogue_uid": "demo-catalogue",
    "products": [
        {
            "code": "BLUE+RED5",
            "soh": 12,
            "retail_price": 199.99
        },
        {
            "code": "APL-IPH-34",
            "soh": 34,
            "title": "iPhone 15 Pro 256GB"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.wherehouse.co.za/v1/product-batches' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
    "catalogue_uid": "demo-catalogue",
    "products": [
        {
            "code": "BLUE+RED5",
            "soh": 12,
            "retail_price": 199.99
        },
        {
            "code": "APL-IPH-34",
            "soh": 34,
            "title": "iPhone 15 Pro 256GB"
        }
    ]
}'

Responses

🟢202Accepted

application/json

The batch was accepted and is queued.

Bodyapplication/json

Example

{
    "ticket": "3b6c1e2a-8f11-4c2d-9a44-0b1c2d3e4f55",
    "status": "queued",
    "total": 2
}

🟠400Bad Request

🟠401Unauthorized

🟠429

🔴503Service Unavailable

Modified at 2026-08-31 15:11:56

/products

/product-batches/{ticket}