Reference

Reference Values

These values are used by Open API requests, job responses, and webhook payloads. Status and reason values are tenant-scoped; the values below are enabled by default, and your organization may enable additional codes.

Default `normalized_status` Codes

Code	Label	Description
`info_recv`	Info Received	Job information has been received.
`custom_clearing`	Custom Clearing	The shipment is in customs clearance.
`customs_cleared`	Customs Cleared	Customs clearance is complete.
`at_warehouse`	At Warehouse	The shipment has arrived at the warehouse.
`out_for_delivery`	Out For Delivery	The shipment is out for delivery.
`completed`	Completed	The delivery job has been completed.
`failed`	Delivery Failed	The delivery attempt failed.
`on_hold`	On Hold	The delivery job is on hold.
`cancelled`	Cancelled	The delivery job has been cancelled.
`cargo_not_found_during_unloading`	Cargo Not Found During Unloading	The cargo was not found during unloading.

Default `failure_reason` Codes

Code	Use With	Label
`recipient_not_available`	`failed`	Recipient Not Available
`wrong_incomplete_address`	`failed`	Wrong/Incomplete Address
`customer_requested_another_delivery_time`	`failed`	Customer Requested Another Delivery Time
`waiting_time_exceeded`	`failed`	Waiting Time Exceeded
`recipient_refused`	`failed`	Recipient Refused
`cannot_contact_customer`	`failed`	Cannot Contact Customer
`payment_not_ready`	`failed`	Payment Not Ready
`vehicle_breakdown`	`failed`	Vehicle Breakdown
`bad_weather`	`failed`	Bad Weather
`vehicle_cannot_access_address`	`failed`	Vehicle Cannot Access Address
`others`	`failed`	Others
`on_hold_customer_requested_another_delivery_time`	`on_hold`	Customer Requested Another Delivery Time
`on_hold_payment_not_ready`	`on_hold`	Payment Not Ready
`on_hold_awaiting_agent_update`	`on_hold`	Awaiting Agent Update
`on_hold_others`	`on_hold`	Others

Boolean Flags

Field	Values	Description
`scheduled_delivery_pending`	`true` or `false`	Whether the scheduled delivery date is still pending confirmation.

Webhook Values

Field	Allowed values
`event`	`delivery_job.created`, `delivery_job.updated`, `delivery_job.status_changed`
`organization.type`	`upstream`, `agent`, `contractor`