API ReferenceDocs
API Reference
Dashboard
These docs are for v2023.01. Click to read the latest docs for v2024.09.

Create a Shipping Rule

post
https://enterprise-api.easyship.com/2023-09/organizations//shipping_rules

Create a shipping rule for a specific organization.

Required authorization scope: enterprise.shipping_rule

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

Organization ID provided when creating an organization

Body 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*
string
enum
required
Allowed:
options
object
required
actions
array of objects
required
length ≥ 1
actions*
string
enum
required
Allowed:
options
object
required
Responses

Updated 10 months ago

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

Updated 10 months ago