Rivier/ Reference/ shop

One order with its lines, money and the terms it was sold under

get/shop/orders/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:read
Mcp
rivier_shop_order_get
Graphql
Query.shopOrder
Sdk
shop.order.get
Cli
shop order get

Parameters

  • idstring (uuid)required
    In the path

Responses

  • 200application/json
    Success
    • 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

This page as Markdown