| Fields | Description |
|---|---|
| easyship_shipment_id | Unique shipment reference number generated by Easyship |
| platform_order_number | Order number on the sales platform. This number can be used to track the associated shipment |
| origin | Origin country name |
| destination | Destination country name |
| status | Current 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_number | Checkpoint'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. |
| -- handler | Name of courier handling the shipment at the checkpoint |
| -- message | Status message at the checkpoint |
| -- location | Location of the checkpoint |
| -- city | City of the checkpoint |
| -- country_name | Country name of the checkpoint |
| -- country_alpha3 | Country ISO 3166-1 alpha-3 code of the checkpoint |
| -- state | State of the checkpoint |
| -- postal_code | Postal code of the checkpoint |
| -- checkpoint_time | Date 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_status | Each 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. |