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
blacklist
boolean

Blacklist the buyer's email and addresses when a dispute opens.

takeBackAccess
boolean

Hide what the order delivered from its buyer while a dispute is open, shown again if it is won.

acceptSmall
boolean

Accept a dispute answered from Shoply under acceptUnder rather than fight it.

acceptUnder
number

The amount, above 0.

Example:

10

autoSubmit
boolean

Submit the answer of a dispute answered from Shoply with a day left.

askAboveOn
boolean

Never send or accept one over askAbove by itself.

askAbove
number

The amount, above 0, up to 1,000,000.

Example:

100

emailOpened
boolean

Email the store when one opens, with its deadline.

emailClosed
boolean

Email the store how one ended.

discord
boolean

Post both to the store's Discord. Needs a webhook in its notification settings.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object