Errors

The API uses standard HTTP status codes. Error bodies are JSON.

Error bodies

Most errors carry a detail message:

Response

{ "detail": "Authentication credentials were not provided." }

When request fields fail validation, the body lists the problems by field:

Response

{ "target_url": ["Enter a valid URL."], "event_types": ["At least one event type is required."] }

Code	Meaning
`200` `201`	Success. 201 means something was created.
`202`	Accepted and queued, for bulk events and webhook tests.
`204`	Success with no body, for deletes.
`400`	The request is invalid: a malformed GTIN, a missing field, an unknown choice, or a write without an Idempotency-Key.
`401`	No valid access token: missing, invalid or expired.
`403`	The token is valid but lacks the scope, partner type or environment the endpoint needs, or the record belongs to someone else.
`404`	Not found, including records you can't see, so a record's existence is never revealed.
`409`	A request with the same Idempotency-Key is still running, or the record already exists.
`413`	Too many events in one bulk request.
`422`	The Idempotency-Key was already used for a different request: another body or another endpoint. Use a new key.
`429`	Rate limit exceeded. See Rate limits.
`503`	From the health endpoint only: a service is down.

Each endpoint in the API reference lists the codes it can return.

Partner API v1. The API reference is generated from the API's own code.