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
name
string
required

The category's name.

Example:

"Software"

slug
string

The last part of its address on the storefront. Left out, it is made from the name.

description
string

What the category's page says under its name.

visibility
enum<string>
default:public

public is listed on the storefront. unlisted is reached by its link. private is not shown.

Available options:
public,
unlisted,
private

Whether themes that feature a category may feature this one.

productIds
string[]

The products in it, in the order the category lists them.

seoTitle
string

The category's own title in search results, up to 70 characters. Empty is its name.

seoDescription
string

Its own description in search results, up to 200 characters. Empty is its description.

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object