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.

provider
string
required

The processor, by its payment method's name in "List payment methods".

Body

application/json
share
integer

Its share of the month's volume, as a whole percent from 0 to 100, for mode share.

Example:

50

capMonth
number

The most it is given in a UTC month, in the store's currency. Empty for no cap.

capDay
number

The most it is given in a UTC day. No more than capMonth.

minOrder
number

The smallest order it is given.

maxOrder
number

The largest order it is given. At least minOrder.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object