Skip to main content
POST
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
productIds
string[]
required

The products, by ID. Up to 250.

visibility
enum<string>

A visibility for all of them.

Available options:
public,
unlisted,
private
isBestSeller
boolean

Whether all of them are marked as best sellers.

paymentMethods
object

A payment method's name, and block or allow. block adds the method to each product's blocked list. allow takes it off the product and off every variant of it.

Example:
deliveryInstructions
string

Instructions for every variant of all of them, up to 5,000 characters, in place of what each has. Empty takes them off. A variant's own instructions are not touched.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object