Error Handling

All error responses from the SuprSync External API follow a consistent JSON format.

Error Format

{
  "error": {
    "code": 400,
    "message": "A human-readable description of what went wrong"
  }
}

HTTP Status Codes

Handling Errors

Authentication Errors (401)

Your API key or secret is missing, invalid, or has been revoked. Verify your credentials and check that the key has not been revoked.

{
  "error": {
    "code": 401,
    "message": "Invalid API credentials"
  }
}

Rate Limit Errors (429)

You've exceeded your request quota. Wait for the duration specified in the Retry-After header.

{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded"
  }
}

Not Found Errors (404)

The requested resource doesn't exist or doesn't belong to your company.

{
  "error": {
    "code": 404,
    "message": "Resource does not exist"
  }
}

Server Errors (500)

An unexpected error occurred on the server. Retry the request after a short delay. If the problem persists, contact support.

{
  "error": {
    "code": 500,
    "message": "An error occurred"
  }
}