FieldsDescription
easyship_shipment_idUnique shipment reference number generated by Easyship
platform_order_numberOrder number on the sales platform. This number can be used to track the associated shipment
originOrigin country name
destinationDestination country name
statusCurrent status of the shipment:
- Pending Tracking Event: No tracking event has been recorded yet
- Tracking Information Received: No tracking event has been recorded yet/the courier has acknowledged the label request
- In Transit To Customer
- Out For Delivery
- Delivered
- Exception: The shipment is on hold (e.g. customs clearance, the courier is trying to contact the receiver to get more information about the delivery address, etc.)
- Cancelled, Pending Refund
- Cancelled and Refunded
checkpoints
-- order_numberCheckpoint's index number (the lowest being the earliest). The order_number provides the most accurate order because the checkpoint_time is usually provided by the couriers in the local time of the checkpoint's location.
-- handlerName of courier handling the shipment at the checkpoint
-- messageStatus message at the checkpoint
-- locationLocation of the checkpoint
-- cityCity of the checkpoint
-- country_nameCountry name of the checkpoint
-- country_alpha3Country ISO 3166-1 alpha-3 code of the checkpoint
-- stateState of the checkpoint
-- postal_codePostal code of the checkpoint
-- checkpoint_timeDate and time the checkpoint was created. Note that the checkpoint_time is usually provided by the couriers in the local time of the checkpoint's location.
-- primary_statusEach Checkpoint has a primary_status to indicate what the main status of the Shipment was for that Checkpoint. The list of possible status messages is the same as for the current statuses of the shipment listed above.