Correct the contact or delivery address of an order that has not shipped

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:write

Mcp

rivier_shop_order_update

Sdk

shop.order.update

Cli

shop order update

Events

shop.order.updated

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• contactobject
  • namestring
    At most 160 characters.
  • emailstring (email)
    At most 254 characters.
  • phonestring
    Pattern: ^+?[0-9 ()-]{6,20}$.
• shippingAddressobject
  • namestring
    At most 160 characters.
  • line1stringrequired
    At most 200 characters.
  • line2string
    At most 200 characters.
  • citystringrequired
    At most 100 characters.
  • regionstring
    Default: . At most 40 characters.
  • postalCodestringrequired
    At most 20 characters.
  • countrystringrequired
    Pattern: ^[A-Z]{2}$.

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