API Reference

Search shipments

get
https://api.wonderment.com/2022-10/shipments/search/

Search shipments for the authenticated shop by order name or tracking code. Requests require a Wonderment API access token with shipment read access. Some shops also require customer verification with the optional t query parameter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Search shipments for the authenticated shop by order name or tracking code. Requests require a Wonderment API access token with shipment read access. The optional t query parameter is separate customer verification and is only required when customer search authentication is enabled for the shop.

Path Params
string
required

Order name or tracking code associated with the shipment.

Query Params
string

Base64-encoded customer verification payload. When provided, it can override searchTerm with its query value and should include the customer email or phone. Required only when customer search authentication is enabled for the shop.

Responses

403

Token does not include shipment read access.

Updated 22 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago