Shipping Rules

List all Shipping Rules

Retrieve a list of an organization's shipping rules.

Required authorization scope: enterprise.shipping_rule:read

get/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

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

Response

shipping rule list

Example response

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

Changes

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