EAeasyship
Shipping Rules

Update a Shipping Rule

Changed on

Update a shipping rule.

Required authorization scope: public.shipping_rule:write

patch/2024-09/shipping_rules/{shipping_rule_id}

Request

  • Base URL
    https://public-api.easyship.com
  • URL
    https://public-api.easyship.com/2024-09/shipping_rules/{shipping_rule_id}
  • Auth
    HTTP bearer

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

  • b47b54b748a7Revision changes
    • breaking

      the request property /////////// became required

    • breaking

      the /////////// request property's minItems was increased to 1

    • breaking

      removed subschema #1 subschema #2 from the ////////// request property oneOf list

    • breaking

      the /////////// request property type changed from string to array

    • breaking

      added subschema #1 subschema #2 to the /////////// response property oneOf list for the response status

    • breaking

      the //////////// response's property type changed from string to array for status

    • warning

      added the new -1.00 enum value to the ///////////// response property for the response status

    • info

      added the new -1.00 enum value to the request property ////////////

    • info

      added subschema #1 subschema #2 to the ////////// request property oneOf list

    • info

      the response property //////////// became required for the status

    • info

      removed subschema #1 subschema #2 from the /////////// response property oneOf list for the response status