IMS Documentation
IMS Business API v1

Errors & Rate Limits

HTTP status behavior is intentionally consistent so integrations can distinguish authentication, authorization, validation and throttling failures.

Common responses

StatusErrorMeaning
400invalid_company, invalid_page, invalid_page_size, date_range_required, invalid_date_range and endpoint-specific validation codesThe request is authenticated but invalid. Correct the request before retrying.
401unauthorizedAPI key is invalid or inactive (including revoked/expired key behavior).
403forbiddenThe client is valid but does not have the required scope.
404company_not_foundThe company is unavailable or the client is not authorized for it.
429rate_limit_exceededThe client exceeded its configured minute or daily request limit.

Rate-limit response

{
  "error": "rate_limit_exceeded",
  "message": "The API client has exceeded its minute request limit.",
  "retryAfterSeconds": 60
}

When throttled, wait for the supplied retry period and honor the HTTP Retry-After header. Do not continuously retry a 429 response.

Validation examples

{
  "error": "forbidden",
  "message": "The API client does not have the inventory.read scope."
}
{
  "error": "company_not_found",
  "message": "The company does not exist or this API client does not have access to it."
}