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

The address that has nothing at it, as a path on the store (/old-page). A whole address of the store is cut down to its path.

Example:

"/product/?name=old-name"

to
string
required

Where it leads, as a path on the store. A redirect never leaves the store, and never leads to an address that is itself redirected.

Example:

"/product/?name=new-name"

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object[]
meta
object