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

Whether the programme is on.

defaultCommission
number

The commission a new affiliate gets, in percent: above 0, up to 90.

defaultDiscount
number

The discount a new affiliate's link gives buyers, in percent: 0 to 90.

selfSignup
boolean

Whether a customer may join from the customer panel.

Whether an affiliate may change the code their link ends in.

toStore
boolean

Whether an affiliate may move commission to their store balance.

payouts
boolean

Whether an affiliate may ask for a payout.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object
meta
object