Errors
Northbeam uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Northbeam’s servers. We suggest gracefully handling errors that may be returned by Northbeam.
Attributes
status: string
The error code.
response: json-encoded string or string
For some known or common errors, we will return a json-encoded string that represents an array of objects with an “order_id”, human readable “message”, and the “json_path” of the failing attributes. For other errors, we may simple return an error string in a human readable format.
Common errors
- A 400 "Bad Request" error with no additional error message is normally due to JSON being malformed. Please ensure that you are sending properly formed JSON blobs.
Updated about 15 hours ago