Rivier/ Reference/ shop

Change a shipping rate, or archive it

patch/shop/rates/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.rate.update
Cli
shop rate update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • namestring
    At most 120 characters.
  • amountMinorinteger
    At least 0. At most 9007199254740991.
  • minWeightGinteger
    At least 0.
  • maxWeightGinteger or null
  • freeOverMinorinteger or null
  • positioninteger
    At least 0. At most 1000.
  • statusstring
    One of: active, archived.

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