Errors

Understand how Partner API errors are returned and how to handle them.

The Partner API uses standard HTTP status codes to indicate whether a request succeeded or failed.
Error responses are returned as JSON with a single error field containing a human-readable message.

Example error payload:

{
  "error": "A token is not valid."
}

Common status codes

  • 400 Bad Request: The request is invalid (missing or malformed parameters).
  • 401 Unauthorized: Missing, expired, or invalid access token.
  • 403 Forbidden: Authenticated, but not allowed to perform this action.
  • 404 Not Found: The requested resource does not exist.
  • 405 Not Allowed: The HTTP method is not supported for this endpoint.
  • 429 Too Many Requests: Rate limit exceeded.
  • 500 Internal Server Error: Unexpected server error.
  • 503 Service Unavailable: Temporary outage or maintenance.

Handling errors

  • Check the HTTP status code first to determine the class of error.
  • For 4xx responses, fix the request and retry.
  • For 5xx responses, retry with backoff.
  • For 429, follow the rate‑limit guidance in the Rate Limiting page.