EAeasyship
Shipping Rules

Update a Shipping Rule

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.

patch/2024-11/shipping_rules/{shipping_rule_id}

Request

  • Base URL
    https://enterprise-api.easyship.com
  • URL
    https://enterprise-api.easyship.com/2024-11/shipping_rules/{shipping_rule_id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://enterprise-api.easyship.com/oauth2/token scopes: enterprise.shipping_rule

Path parameters

shipping_rule_idstring required

Shipping Rule ID provided when creating

Request body

nameName (unresolved $ref)
descriptionDescription (unresolved $ref)
recalculate_shipmentsboolean

Recalculate all shipments affected by this shipping rule

priorityinteger

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

Response

shipping rule successfully updated

Example response

{
  "shipping_rule": {
    "conditions": [
      {
        "options": {
          "states": [
            "39-AB"
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.