Skip to main content

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.

Required scope: inventory:write

Grant 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​

OK

Response Headers
    Content-Type