For the complete documentation index, see llms.txt. This page is also available as Markdown.

/inventory

POST /inventory

Update the available inventory used by Purple Dot for exporting pre-orders.

Request:

  • sku - Required. The SKU for which inventory level is being updated

  • available_units - Required. The number of units of this SKU that are available

The request indicates the total number of units available, not the change since the last call, and is therefore idempotent.

Response:

  • 201 Created - Indicating the update has been received

  • sku - The SKU for which the inventory level was updated

  • available_units - The new number of units available

Examples:

curl --request POST \
     --url 'https://www.purpledotprice.com/admin/api/v1/inventory' \
     --header 'Content-Type: application/json'
     --header 'X-Purple-Dot-Access-Token: <access_token>'
     --data '{"sku": "foo", "available_units": 1}'
{
  "data": {
    "sku": "foo",
    "available_units": 1
  }
}

Last updated