Sign in
latestOpenAPI 3.0.32026-07-26170311887.2 KB

71d737a5fcbf

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}

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"
          ]
        }
      }
    ]
  }
}