List Shipping Methods in Zone | BigCommerce Developer Center

import requests
url = "https://api.bigcommerce.com/stores/store_hash/v2/shipping/zones/zone_id/methods"
headers = {"X-Auth-Token": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "channel_ids": [
      2,
      3
    ],
    "enabled": true,
    "handling_fees": {
      "fixed_surcharge": 0
    },
    "id": 1,
    "is_fallback": false,
    "name": "Flat Rate",
    "settings": {
      "rate": 12
    },
    "type": "perorder"
  },
  {
    "channel_ids": [
      1,
      3
    ],
    "enabled": false,
    "handling_fees": {
      "fixed_surcharge": 0
    },
    "id": 2,
    "is_fallback": false,
    "name": "Pickup In Store",
    "settings": {},
    "type": "total"
  },
  {
    "channel_ids": [
      1
    ],
    "enabled": true,
    "handling_fees": {
      "fixed_surcharge": 0
    },
    "id": 3,
    "is_fallback": false,
    "name": "Ship by Weight",
    "settings": {
      "default_cost": 0,
      "default_cost_type": "fixed_amount",
      "range": [
        {
          "lower_limit": 0,
          "upper_limit": 20,
          "shipping_cost": 8
        },
        {
          "lower_limit": 20,
          "upper_limit": 40,
          "shipping_cost": 8
        },
        {
          "lower_limit": 40,
          "upper_limit": 60,
          "shipping_cost": 8
        },
        {
          "lower_limit": 60,
          "upper_limit": 80,
          "shipping_cost": 8
        }
      ]
    },
    "type": "weight"
  },
  {
    "channel_ids": [
      1
    ],
    "enabled": true,
    "handling_fees": {
      "fixed_surcharge": 0
    },
    "id": 4,
    "is_fallback": false,
    "name": "UPS®",
    "settings": {
      "carrier_options": {
        "include_package_value": "1",
        "show_transit_time": "1",
        "destination_type": "residential",
        "packing_method": "combined",
        "packaging_type": "2c",
        "delivery_services": [
          "Express",
          "Ground",
          "Next_Day_Air",
          "Saver",
          "Standard"
        ],
        "packaging": []
      }
    },
    "type": "upsready"
  }
]

Returns a list of Shipping Methods in a zone. Default sorting is by shipping method ID, from lowest to highest.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | | - | - | - | | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

zone_idstringRequired

Response

channel_idslist of integers

List of channels associated to a method. When creating a new method, all available channels are associated by default. (Optional)

enabledboolean

Whether or not this shipping zone method is enabled.

handling_feesobject

idintegerRead-only

Shipping method ID. Read-only.

is_fallbackboolean

Whether or not this shipping method is a fallback method used when advanced shipping rules are unavailable.

namestring

Display name for shipping method.

settingsobject

Depends on the shipping method type. See the supported settings object.

typeenum