Skip to main content
POST
Node.js

Authorizations

Authorization
string
header
required

A buyer's token, from Sign in with the code: Authorization: Bearer shoply_ct_.... It reaches that buyer's own orders at one store, and no route that takes a key.

Path Parameters

storeId
string
required

The store's ID, from Settings, General in its dashboard. It is not a secret: a page may show it.

Body

application/json
amount
number
required

How much, in the store's currency, up to their affiliate balance.

Example:

25

details
string
required

How they want to be paid, in their own words.

Example:

"PayPal: ada@example.com"

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object