Reference.
The codes, flows, and data tables you'll come back to as you integrate.
Updated June 11, 20261 min read
Status
Shipment status codes
The full status catalogue with pre/post-shipping classification, plus the canonical state-machine flow.
Order status codes
The full Order status catalogue, what each status means and which are terminal.
Fulfillment order status codes
What each fulfillment order status means, when it's reached, and which are terminal.
Line item status codes
The leaf state that drives fulfillment order and Order statuses.
Return request statuses
The lifecycle of a return request from creation to resolution.
Webhook events
Shipment webhook events
Status, metadata, and reason-code triggers for shipment webhooks.
Order webhook events
Order and fulfillment-order lifecycle triggers and the camelCase envelope.
Return webhook events
Status and item-level triggers for return-request webhooks.
Inventory webhook events
The single inventory trigger, snake_case envelope, and tenant scoping.
Errors
Error codes
Every error code Carriyo can return during shipment creation/update, with severity and resolution guidance.
Reason codes
Additional context attached to exceptional statuses (delays, failures, cancellations).
Validation errors
Carriyo's two layers of validation (creation hard checks and booking soft checks).
Data
Geo list
The Carriyo standardized list of states, cities, and areas for countries with complex addressing.
Confused cities (Saudi Arabia)
A watch list of similar-sounding city names that commonly cause misrouting.
Contact data validation
Recommended libraries, formats, and best practices for validating phone numbers and email addresses before sending them to Carriyo.