Skip to content
ZargoLogix

Status values

Every status and payment value the API can return. Values are always upper-case with underscores.

Shipment status

The data API lists shipments in every status, including DRAFT and PENDING_APPROVAL. The public tracking lookup treats those two as not found.

ValueStageMeaning
DRAFTBeforeCreated by staff and not yet confirmed.
PENDING_APPROVALBeforeA booking is waiting for our team to review it.
APPROVEDBeforeConfirmed. A tracking number is now in use.
AWAITING_PICKUPCollectionWaiting to be collected.
PICKED_UPCollectionCollected from the sender.
IN_TRANSITMovingOn its way.
CUSTOMS_PROCESSINGCustomsGoing through customs.
CUSTOMS_HOLDCustomsHeld by customs. Action may be needed.
CUSTOMS_CLEAREDCustomsCleared customs.
DELAYEDExceptionRunning later than planned.
OUT_FOR_DELIVERYDeliveryWith the courier for final delivery.
DELIVERY_ATTEMPTEDDeliveryA delivery attempt was made and did not succeed.
DELIVEREDFinalDelivered to the receiver.
RETURNEDFinalReturned to the sender.
CANCELLEDFinalCancelled, or a booking that was declined.
LOSTFinalCould not be found.
DAMAGEDFinalReported damaged.

Shipment payment status

ValueMeaning
UNPAIDNothing has been paid.
PARTIALPart of the amount has been paid.
PAIDPaid in full.

Invoice status

ValueMeaning
DRAFTBeing prepared. Not sent to the customer.
SENTIssued to the customer.
PAIDPaid in full.
OVERDUEPast its due date and not paid.
VOIDCancelled by staff with a recorded reason. Invoice numbers are never reused.

Quote status

ValueMeaning
DRAFTBeing prepared.
SENTSent to the customer.
ACCEPTEDThe customer accepted it.
REJECTEDThe customer declined it.
EXPIREDNot accepted before it was valid until.
CONVERTEDTurned into an invoice.

Transport mode

AIR, SEA, ROAD or RAIL.