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/{ticket}

GET

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

Poll the status of a product update batch you submitted. Tickets belong to the API key's subscription and expire after 7 days.

errors is a sample of the first 100 item failures (product_not_found, catalogue_not_found, validation_error). Unchanged rows count as skipped.

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 *****************

Path Params

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/3b6c1e2a-8f11-4c2d-9a44-0b1c2d3e4f55' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200OK

application/json

Current batch status.

Bodyapplication/json

Example

{
    "ticket": "3b6c1e2a-8f11-4c2d-9a44-0b1c2d3e4f55",
    "status": "completed",
    "total": 2,
    "processed": 2,
    "updated": 1,
    "skipped": 0,
    "invalid": 1,
    "errors": [
        {
            "code": "MISSING-SKU",
            "catalogue_uid": "demo-catalogue",
            "error": "product_not_found",
            "message": "No product with code \"MISSING-SKU\" was found in this catalogue."
        }
    ]
}

🟠401Unauthorized

🟠404Record Not Found

🟠429

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

/product-batches

/orders