Rivier/ Reference/ shop

Add a tax rule with its source and the date it was checked

post/shop/tax-rules

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.taxRule.create
Cli
shop tax rule create

Request bodyapplication/json, required

  • namestringrequired
    At most 120 characters.
  • countrystringrequired
    Pattern: ^[A-Z]{2}$.
  • regionstring
    Default: . At most 10 characters.
  • taxClassstring
    Default: standard. Pattern: ^[a-z][a-z0-9_]{0,29}$.
  • rateBpintegerrequired
    At least 0. At most 10000.
  • inclusiveboolean
    Default: true.
  • validFromstring or null
  • validTostring or null
  • sourceUrlstring (uri)required
    At most 500 characters.
  • verifiedOnstringrequired
    Pattern: ^\d{4}-\d{2}-\d{2}$.

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