Skip to main content
All Partner API responses use a consistent envelope format.

Response envelope

Success

{
  "success": true,
  "message": "...",
  "data": {}
}

Error

{
  "success": false,
  "message": "Error description",
  "errorCode": "ERROR_CODE"
}
FieldTypeDescription
successbooleantrue for success, false for error
messagestringHuman-readable status or error description
dataobjectResponse payload (present on success)
errorCodestringMachine-readable error code (present on error)

HTTP status codes

StatusMeaning
200Request succeeded
400Bad request — invalid or missing parameters
401Unauthorized — missing, expired, or invalid token
404Resource not found (e.g., tracking ID does not exist)
500Internal server error