List Shipments

The store's shipments, oldest first: the tracking feed. Poll it on a schedule with updated_at_start, and for each shipment write every parcel's tracking number to each order in its orders.

  • Overlap the window. Start each poll a few minutes before the last successful one started.
  • Deduplicate on shipment id. A shipment can appear in more than one poll.
  • Read every page. Send limit on the first request, then keep requesting with cursor set to the response's next_cursor while has_next_page is true. Save your updated_at_start window only after the last page.
  • Voided labels disappear. A replacement label is a new shipment with a new id.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The store ID your customer sent you with the credentials. It must belong to the same store as the username.

Query Params
string

The next_cursor from the previous page. Leave it out for the first page. Keep the same filters and limit on every page.

integer
1 to 500
Defaults to 25

Results per page. Default 25, maximum 500. Send it on every request, including the first page.

date-time

RFC 3339. Only results updated at or after this time, including changes the warehouse made. Anything else returns 400 {"errors": "supplied updated time is invalid"}.

date-time

RFC 3339. Only results updated at or before this time.

string
length ≥ 1

Only results for this order number.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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