younifyd
Menu

List Orders

List Orders

GET/orders

Use it in a workflow

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

Request

Query parameters

extorderidstring

Fetch a specific order by its external id

emailstring

Fetch all orders matching this recipient email

statusstring

Fetch all orders with this status

One ofnewholdvalidatereviewreadyForFulfillmentsentForFulfillmentpartialFulfillmentfulfilledinTransitdeliveredrefundedcancelled

requireShippingLabelsboolean

Filter orders by shipping labels requirement

sincestring (date-time)

Fetch all orders created after this date-time

untilstring (date-time)

Fetch all orders created before this date-time

updatedsincestring (date-time)

Fetch all orders updated after this date-time

updateduntilstring (date-time)

Fetch all orders updated before this date-time

timestampboolean

if set to true use timestamp instead of create time

skipinteger (int32)

Skip this many orders

countinteger (int32)

Return at most this many orders

orderstring

List sort order

keysstring

Fields to retrieve

Response

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

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

Was this page helpful?