API ReferenceDocs
API Reference
Dashboard

Update a Shipping Rule

patch
https://enterprise-api.easyship.com/2024-11/shipping_rules/

Update a shipping rule.

Required authorization scope: enterprise.shipping_rule:write

The path does not include the organization_id path parameter used for 'List all Shipping Rules' and 'Create a Shipping Rule' actions.

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

Shipping Rule ID provided when creating

Body Params

Shipping Rule Update Params

string

Shipping Rule name

string

Shipping Rule description

boolean

Recalculate all shipments affected by this shipping rule

integer

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

conditions
array of objects
length ≥ 1
conditions

Condition that matches the destination country of the orders

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

Never add specific courier services

string
enum
required
Allowed:
options
object
required
uuid
Responses

Updated 8 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 8 months ago