Skip to main content
POST
Test channel restrictions against a sample order

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

channelId
integer
required

Channel ID

Body

application/json
restrictions
object[] | null

Optional unsaved restriction ruleset to test instead of the channel's saved rules.

country
string | null
Example:

"AE"

state
string | null
Example:

"Dubai"

postal_code
string | null
city
string | null
order_total
number | null
weight
number | null
currency
string | null
sku
string | null
tag_names
string[] | null

Response

Evaluation result

data
object