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.

subscriptionId
string
required

One of the buyer's subscriptions, from List subscriptions.

Response

It worked.

success
boolean
required

Whether the request did what was asked.

message
string | null
required

Words for a person. Empty when it worked.

code
string | null
required

Why it was refused, as a word that does not change. Empty when it worked.

data
any
required

The thing asked for: an object, or for a list its rows.

pages
integer

For a paged list: how many pages there are.

total
integer

For a paged list: how many rows there are in all.

meta
object

Anything else the route answers beside the thing itself.