List Shipping Methods in Zone

GET

https://api.bigcommerce.com/stores/:store_hash/v2/shipping/zones/:zone_id/methods

GET

/stores/:store_hash/v2/shipping/zones/:zone_id/methods

curl https://api.bigcommerce.com/stores/store_hash/v2/shipping/zones/1/methods \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

[
  {
    "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,
          "shipping_cost": 8,
          "upper_limit": 20
        },
        {
          "lower_limit": 20,
          "shipping_cost": 8,
          "upper_limit": 40
        },
        {
          "lower_limit": 40,
          "shipping_cost": 8,
          "upper_limit": 60
        },
        {
          "lower_limit": 60,
          "shipping_cost": 8,
          "upper_limit": 80
        }
      ]
    },
    "type": "weight"
  },
  {
    "channel_ids": [
      1
    ],
    "enabled": true,
    "handling_fees": {
      "fixed_surcharge": 0
    },
    "id": 4,
    "is_fallback": false,
    "name": "UPS®",
    "settings": {
      "carrier_options": {
        "delivery_services": [
          "Express",
          "Ground",
          "Next_Day_Air",
          "Saver",
          "Standard"
        ],
        "destination_type": "residential",
        "include_package_value": "1",
        "packaging": [],
        "packaging_type": "2c",
        "packing_method": "combined",
        "show_transit_time": "1"
      }
    },
    "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.

Path parameters

zone_idintegerRequired

ID of the shipping zone.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

channel_idslist of integersOptional

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

enabledbooleanOptional

Whether or not this shipping zone method is enabled.

handling_feesobjectOptional

idintegerOptionalRead-only

Shipping method ID. Read-only.

is_fallbackbooleanOptional

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

namestringOptional

Display name for shipping method.

settingsobjectOptional

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

typeenumOptional