Skip to main content
PUT
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.

ruleId
string
required

The rule.

Body

application/json
kind
enum<string>
required

What it looks at: the buyer's country, or the order's amount.

Available options:
country,
amount
action
enum<string>
required

only: such orders go to this processor and no other. never: they never go to it.

Available options:
only,
never
provider
string
required

The processor the rule is about, one in the routing.

Example:

"nmi"

countries
string[]

For country: up to 100 countries, as two-letter codes.

Example:
amountOp
enum<string>

For amount: whether it is about orders over the amount or under it.

Available options:
over,
under
amount
number

For amount: the amount, in the store's currency.

Example:

200

Response

It worked.

success
boolean
message
unknown
code
unknown
data
object