Search shipments

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.

Creating the t token

The t parameter must be Base64-encoded JSON containing the search query and either the customer's email or phone. The query can be an order name or tracking code and overrides the searchTerm in the URL.

Use JSON.stringify so the value passed to btoa is valid JSON:

const t = btoa(
  JSON.stringify({
    email: "[email protected]",
    query: "1049"
  })
)

Then include the token as a query parameter:

const url = `https://api.wonderment.com/2022-10/shipments/search/1049?t=${encodeURIComponent(t)}`
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.

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