Create a Shipping Rule

Create a shipping rule.

Required authorization scope: public.shipping_rule:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Shipping Rule Create Params

string
required

Shipping Rule name

string
required

Shipping Rule description

boolean

Recalculate all shipments affected by this shipping rule

integer

The smaller value represent the higher priority. High priority shipping rule would be execute first.

conditions
array of objects
required
length ≥ 1
conditions*

Condition that matches the destination country of the orders

string
enum
required
Allowed:
options
object
required
actions
array of objects
required
length ≥ 1
actions*

Never add specific courier services

string
enum
required
Allowed:
options
object
required
Responses

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json