Update a Shipping Rule

patch

https://public-api.easyship.com/2024-09/shipping_rules/{shipping_rule_id}

Update a shipping rule.

Required authorization scope: public.shipping_rule:write

Path Params

shipping_rule_id

string

required

Shipping Rule ID provided when creating

Body Params

name

string

Shipping Rule name

description

string

Shipping Rule description

recalculate_shipments

boolean

Recalculate all shipments affected by this shipping rule

priority

integer

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

conditions

array of objects

length ≥ 1

conditions

type

string

enum

required

Allowed:

options

object

required

uuid

actions

array of objects

length ≥ 1

actions

type

string

enum

required

Allowed:

options

object

required

uuid

Responses

Language

Credentials

Bearer

token

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200shipping rule successfully updated

403unauthorized