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.

affiliateId
string
required

The affiliate.

Body

application/json
code
string

What their link ends in: 2 to 40 letters, digits and dashes. One affiliate a code in a store.

Example:

"ada"

commission
number

The share of each order they earn, in percent: above 0, up to 90. It is taken on what the buyer paid for the products, after every discount, before fees and tax.

Example:

10

discount
number
default:0

What their link takes off for the buyer, in percent: 0 to 90.

active
boolean

Whether their link works. Switched off, it takes nothing off and earns nothing.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object
meta
object