Errors

Error Response Structure

json

{
  "timestamp": "2024-06-15",
  "message": "001 - importer_countries size limit exceeded! (Max size: 10)",
  "code": "001"
}

Code	Meaning	When
200	OK	Request processed successfully
400	Bad Request	Malformed request syntax
401	Unauthorized	Missing or invalid `X-API-KEY` / `X-SIGNATURE`
403	Forbidden	Authenticated but not permitted for this action
404	Not Found	Business rule violation or resource not found
500	Internal Server Error	Unexpected server-side error

Business rule violations return HTTP 404 with the error response structure above.

Code	Name	Description
001	SIZE_LIMIT	A set field exceeds the maximum of 10 items
002	NOT_NULL	A required field is null
003	MUST_PARAMETER	At least one filter parameter is required
004	NOT_PARAMETER_CANNOT_USE_ALONE	NOT operator cannot be used without a positive parameter
005	MIN_CHARACTERS	Field value must be at least 2 characters
006	UNEXPECTED_PARAMETER	Parameter not allowed for this request or account
007	DATA_NOT_FOUND	The requested resource was not found
008	UNAUTHORIZED_USER	Not authorized to query on behalf of the specified user
009	MIN_3_CHARACTERS	Field value must be at least 3 characters
010	EXPORTER_COUNTRY_PARAMETER	`exporter_countries` requires at least one additional parameter
011	NOT_AUTHORIZED_PARAMETER	Parameter not permitted for this account
012	HS_CODE_LIMIT_EXCEEDED	HS code search count exceeds the assigned account limit
013	UNAUTHORIZED_HS_CODE_LENGTH	HS code digit length not permitted for this account
014	CREDIT_LIMIT_EXCEEDED	API usage credit limit has been reached
015	MINUTELY_REQUEST_LIMIT_EXCEEDED	Per-minute request rate limit exceeded
016	DAILY_REQUEST_LIMIT_EXCEEDED	Daily request quota exceeded
017	HS_CODE_CHARS_NUMERIC	HS code must contain only numeric characters
018	COUNTRY_CHARS_ALPHABETIC	Country code must contain only alphabetic characters
019	ACCOUNT_EXPIRED	Account subscription has expired
020	ACCOUNT_NOT_ACTIVE_UNTIL	Account is not yet active