Rivier/ Reference/ shop

Add a shipping rate to a zone (by weight, free over a total)

post/shop/rates

Before you call

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

Request bodyapplication/json, required

  • zoneIdstring (uuid)required
  • namestringrequired
    At most 120 characters.
  • currencystringrequired
    Pattern: ^[a-z]{3}$.
  • amountMinorintegerrequired
    At least 0. At most 9007199254740991.
  • minWeightGinteger
    Default: 0. At least 0.
  • maxWeightGinteger or null
  • freeOverMinorinteger or null
  • positioninteger
    Default: 0. At least 0. At most 1000.

Responses

  • 201application/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