Test Purple Dot Token
POST/api/purple-dot/test
Check a Purple Dot Private API token without saving it. With include_unmatched: true the answer also lists the store's Waitlist variants that no SKU.io product matches under sku_match_key.
inventory:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body: access_token (string, required, 8–255), shopify_integration_instance_id (integer, optional), sku_match_key (sku | barcode | shopify_variant_gid, optional), include_unmatched (boolean, optional). A rejected token answers 422 with code invalid_token; Purple Dot unreachable answers 503 network_error. Requires integrations.create.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Content
Response Headers
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.