EAeasyship
Shipping Rules

Create a Shipping Rule

Create a shipping rule for a specific organization.

Required authorization scope: enterprise.shipping_rule:write

post/2024-11/organizations/{organization_id}/shipping_rules

Request

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

Path parameters

organization_idstring uuid required

Organization ID provided when creating an organization

Request body

namestring required

Shipping Rule name

descriptionstring required

Shipping Rule description

recalculate_shipmentsboolean

Recalculate all shipments affected by this shipping rule

priorityinteger

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

Example request

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

Response

shipping rule successfully created

Example response

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

Changes

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