Rivier/ Reference/ shop

Ship whole lines of a paid order with a carrier and tracking

post/shop/orders/{id}/ship

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_shop_order_ship
Graphql
Mutation.shipShopOrder
Sdk
shop.order.ship
Cli
shop order ship
Events
shop.order.shipped

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • lineIdslist of string (uuid)required
  • carrierstring
    Default: . At most 80 characters.
  • trackingstring
    Default: . At most 120 characters.

Responses

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