Orders by state or customer

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:read

Mcp

rivier_shop_orders_list

Graphql

Query.shopOrders

Sdk

shop.order.list

Cli

shop order list

Parameters

• statestring
  In the query
• contactKeystring
  In the query
• limitinteger
  In the query
• beforestring (date-time)
  In the query

Responses

• 200application/json
  Success
  • orderslist of objectrequired
    • idstringrequired
    • numberstringrequired
    • statestringrequired
    • currencystringrequired
    • countrystringrequired
    • contactobjectrequired
      • emailstringrequired
      • namestringrequired
      • phonestring
    • subtotalMinornumberrequired
    • discountMinornumberrequired
    • shippingMinornumberrequired
    • taxMinornumberrequired
    • totalMinornumberrequired
    • paidMinornumberrequired
    • refundedMinornumberrequired
    • paymentRefstring or nullrequired
    • payBystring or nullrequired
    • channelstringrequired
    • createdAtstringrequired
    • updatedAtstringrequired
    • cancelledAtstring or nullrequired
    • cancelReasonstring or nullrequired
    • lineslist of objectrequired
      • idstringrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring