Errors
Biteship uses conventional HTTP response codes to show success or failure of an API request. Codes in the 2xx range shows a success, codes for the 4xx range shows an error that resulted from the provided information (e.g. a required field was missing, wrong format, etc.), and codes in the 5xx range indicate an error with Biteship's servers.
Status
Error List Summary
200 - Works fine.
400 - Bad request. Missing required parameters or other else.
401 - Request is not authorized
402 - Payment required. Quota exhausted and wallet balance cannot cover overage.
403 - Key doesn't have access to request API calls
404 - The request is not exist
422 - Unprocessable. Subscription quota reached, or the feature is not on your plan.
429 - Too many requests in a short window (throttling). Wait and retry.
500 - Something's wrong with Biteship's internal server
This is how Biteship respond to error request
Error List Summary
{
"success": false,
"error": "Required parameter is missing"
}
Subscription errors
These apply to production (live) API keys. Quotas are monthly; see Plans & limits.
| HTTP | Code | Message | When |
|---|---|---|---|
| 422 | 42200000 | You have reached your monthly {Rates|Tracking|Maps|Orders|Returns} API limit. | Monthly quota exhausted. Rates/Tracking/Maps then attempt overage; Orders and Returns stop here. |
| 402 | 40200000 | You have reached your monthly {Rates|Tracking|Maps} API limit and do not have sufficient balance for the overage charge. Please top up your balance. | Overage would apply but Bitepoints balance is too low. Response may include amount. |
| 422 | 42200002 | This feature is not available on your current subscription plan. Please upgrade to continue. | Feature gated by plan (for example shipping label API). Includes feature_key and required_tier. |
| 422 | 42200001 | You have reached the maximum of {n} couriers for your plan. Upgrade to install more couriers. | Courier install cap. |
| 422 | 42200003 | Custom rates limit reached for your plan. | Active custom-rates cap. |
Quota reached
{
"success": false,
"code": 42200000,
"error": "You have reached your monthly Rates API limit."
}
Overage, insufficient balance
{
"success": false,
"code": 40200000,
"error": "You have reached your monthly Rates API limit and do not have sufficient balance for the overage charge (Rp5). Please top up your balance.",
"amount": 10
}
Feature not on plan
{
"success": false,
"code": 42200002,
"error": "This feature is not available on your current subscription plan. Please upgrade to continue.",
"feature_key": "order.features.is_eligible_for_shipping_label_api",
"required_tier": "grow"
}
Per-endpoint error tables (Rates, Orders, Tracking, and so on) still apply for validation and courier errors.