Distribution Centre Stock

Overview

Distribution Centre Stock endpoints let you retrieve inventory by distribution centre and update stock quantities for individual or multiple products.

Authentication

All endpoints require authentication. Include your API token in the Authorization header. For more information on obtaining a token, see the Authentication guide.

List Distribution Centre Stock

Retrieve stock levels across your distribution centres.

Endpoint: GET https://curosa.com/api/v1/distribution-centre-stocks

Request

curl --location 'https://curosa.com/api/v1/distribution-centre-stocks' \
--header 'Authorization: Bearer YOUR_API_TOKEN'

Response

Returns a 200 OK response:

{
    "data": [
        {
            "distribution_centre_code": "DEMO-DC",
            "sku": "DEMO001",
            "platform_sku": "201.228.141",
            "stock_quantity": 0,
            "stock_quantity_allocated": 0,
            "stock_quantity_free": 0,
            "inbound_quantity": 0,
            "inbound_quantity_allocated": 0,
            "inbound_quantity_free": 0
        }
    ],
    "links": {
        "first": null,
        "last": null,
        "prev": null,
        "next": null
    },
    "meta": {
        "path": "https://curosa.test/api/v1/distribution-centre-stocks",
        "per_page": 100,
        "next_cursor": null,
        "prev_cursor": null
    }
}

Update Distribution Centre Stock

Update stock quantity for a single product in a distribution centre.

Endpoint: POST https://curosa.com/api/v1/distribution-centre-stocks

Request

curl --location 'https://curosa.com/api/v1/distribution-centre-stocks' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "distribution_centre_code": "DEMO-DC",
    "sku": "DEMO001",
    "stock_quantity": 10
}'

Request Body

Response

{
    "updated": [
        {
            "distribution_centre_code": "DEMO-DC",
            "platform_sku": "201.228.141",
            "sku": "DEMO001",
            "stock_quantity": 10
        }
    ],
    "errors": []
}

Bulk Update Distribution Centre Stock

Update stock quantities for multiple items in one request.

Endpoint: POST https://curosa.com/api/v1/distribution-centre-stocks/bulk-update

Request

curl --location 'https://curosa.com/api/v1/distribution-centre-stocks/bulk-update' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '[
    {
        "distribution_centre_code": "DEMO-DC",
        "sku": "DEMO001",
        "stock_quantity": 0
    },
    {
        "distribution_centre_code": "DEMO-DC",
        "sku": "DEMO004",
        "stock_quantity": 0
    }
]'

Request Body

An array of stock update objects. Each object requires:

• distribution_centre_code (string)
• sku (string)
• stock_quantity (integer)

Rate Limiting

Distribution centre stock endpoints are rate limited to 3,600 requests per hour. The current limit and remaining requests are returned in the response headers as x-ratelimit-limit and x-ratelimit-remaining.