retrieve any shipments for orderID, * also supports tracking codes or encoded tokens.
Sample Call
Use these values to generate a test API call, or replace with your own orders and API key.
Ensure both fields are populated and then click 'try it' to run and return a result.
| Token | Use this in header | sk_live_3233_eb8ac6b8f65c8ff63454328f6a60e04da45cac57414ca4744c4ae94e82b258e5 |
| searchTerm | Use this in param field | preview |
If your store has Tracking Page Authentication enabled, requests must use an encoded token for the SearchTerm, passed as in a query variable named t. For example, https://api.wonderment.com/2022-10/shipments/search?t=eyJxdWVyeSI6ImV0YzEwMDAiLCJlbWFpbCI6ImJyaWFuQHdvbmRlcm1lbnQuY29tIn0. This is in addition to the store's API key above.
Encoded tokens are a simple base64 encoding of the order or tracking number, and the customer's associated email address or phone number from their order. You can learn more about generating the encoded token and example code for doing so on the Wonderment docs site.
Possible values of the status and substatus fields
The status field has a limited list of possible values:
PRE_TRANSIT
TRANSIT
SHIPMENT_STALLED
ATTEMPTED_DELIVERY
DELIVERED
RETURNED
ERROR
SHIPMENT_CREATED
READY_FOR_PICKUP
OUT_FOR_DELIVERY
CANCELLED (With USPS only)
CONFIRMED (With USPS only)
The substatus field is passed along from the carrier. There is not a list of valid statuses here, because carriers may add or remove possible statuses at any time, without warning, and currently contains thousands of possible values across all supported carriers. Because of this limitation, you can use the substatus field in messaging, but we encourage you not to build business logic that depends on specific substatus values.