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

Update a Shipping Rule

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

Update a shipping rule.

Required authorization scope: enterprise.shipping_rule

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

This API is currently in beta and is available upon request. Get in touch with your account manager or Easyship Support Team to enable it.

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
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
string
enum
required
Allowed:
options
object
required
string

Condition ID. Can update shipping rule condition.

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

Action ID. Can update shipping rule action.

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