Skip to main content
PUT
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Headers

Idempotency-Key
string

A word of your own for this one change, up to 180 letters, digits, dots, dashes, underscores and colons. Sent again with the same key, the request is not carried out twice: the first answer comes back, with Idempotent-Replay: true.

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Body

application/json
collect
boolean

Whether tax is charged at checkout.

included
boolean

Whether the store's prices already include the tax. Off, it is added on top.

business
boolean

Whether a business buyer's VAT number takes the tax off, when the EU's register confirms it and it is from another country than the store's.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object