younifyd
Menu

List Shipments

List Shipments

GET/shipments

Use it in a workflow

  1. Add a step and choose the Pipe17 connector.
  2. Pick the List Shipments action (under Shipments).
  3. Fill in the fields below, then reference the result from later steps as {{listShipments.response.data}}.

Request

Query parameters

extorderidstring

Shipments of specific order

statusstring

Shipments with this status

One ofpendingInventorypendingShippingLabelreadyForFulfillmentsentToFulfillmentfulfilledpartialFulfillmentcancelled

ordertypestring

Shipments with this order type

One ofsalestransferpurchase

sincestring (date-time)

Shipments created after this date-time

untilstring (date-time)

Shipments created before this date-time

updatedsincestring (date-time)

Shipments updated after this date-time

updateduntilstring (date-time)

Shipments updated before this date-time

skipinteger (int32)

Skip this many shipments

countinteger (int32)

Return at most this many shipments

orderstring

List sort order

keysstring

Fields to retrieve

Response

Returns 200 with a any. Read it in later steps with {{listShipments.response.data.<field>}}.

Need more? See the Pipe17 guide for connection setup and behaviour shared by every action.

Was this page helpful?
List Shipments — Pipe17 — Documentation