List Purple Dot Release Budgets
GET/api/purple-dot/:instance/release-budgets
Per external Purple Dot SKU (several Purple Dot SKUs can map to one SKU.io product; each pre-order line's allocated units count toward its own SKU): the number of held pre-order units Purple Dot may export now as SKU.io computes it (computed_units), the value Purple Dot last acknowledged (available_units, null before the first acknowledged push), and the held and allocated units behind it. In allocation release mode the budget is the units SKU.io has set aside from stock in the supply warehouses; in shelf mode it is their sellable on-hand. A bundle's budget is the minimum across its components.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
In shelf mode the shelf units go to the SKUs in pre-order queue order, each up to its held units, and the rest to the product's primary SKU. A SKU that no longer applies to its product is listed with computed_units 0 until its zero is acknowledged, then dropped.
status: pushed (acknowledged), pending (Purple Dot did not acknowledge the last push; it is retried automatically with backoff, sending the value computed at retry time; next_retry_at is the next attempt), rejected (Purple Dot refused the value with a 4xx; not retried automatically), or null when nothing was sent yet. last_error carries the last failure. id is null for a SKU never sent; key (product id + SKU) is unique per row.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.