Docs
Management API
Shipping V2
Shipping Zones

Shipping Zones

Get All Shipping Zones

GET /shipping/zones

Request

Returns a list of all Shipping Zones.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

Response

Body

array | application/json

  • id    integer

    Zone ID
    Example: 1

  • name    string

    Zone name. Required for PUT requests.
    Example: United States

  • type    string

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

Example 1: Zones are Country Zones

Example 2: Zone is Selection of States in a Country

Create a Shipping Zone

POST /shipping/zones

Request

Creates a Shipping Zone.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • name    string
    required

    Zone name. Required for PUT requests.
    Example: United States

  • type    string
    required

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations. BigCommerce has a platform limit of 40000 zip type locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

Type: ZIP

Type: Country

Type: State

Type: Global

Response

Body

object | application/json

  • id    integer

    Zone ID.
    Example: 1

  • name    string

    Zone name.
    Example: United States

  • type    string

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

Get a Shipping Zone

GET /shipping/zones/{id}

Request

Returns a single Shipping Zone.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in path - integer
    required
    ID of the shipping zone.

example

Response

Body

object | application/json

  • id    integer

    Zone ID
    Example: 1

  • name    string

    Zone name.
    Example: United States

  • type    string

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

example

Update a Shipping Zone

PUT /shipping/zones/{id}

Request

Updates a Shipping Zone.

Required Fields

  • name

Read Only Fields

  • id

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in path - integer
    required
    ID of the shipping zone.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • id    integer
    read-only

    Zone ID. Read-only.
    Example: 1

  • name    string
    required

    Zone name. Required for PUT requests.
    Example: United States

  • type    string

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations. BigCommerce has a platform limit of 40000 zip type locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

example

Response

Body

object | application/json

  • id    integer
    read-only

    Zone ID. Read-only.
    Example: 1

  • name    string
    required

    Zone name. Required for PUT requests.
    Example: United States

  • type    string

    Allowed: zip | country | state | global

  • locations    array[object]

    Array of zone locations.

  • free_shipping    object

  • handling_fees

    Any of:

    • fixed_surcharge      string

      Flat-rate handling fee applied to shipping cost.
      Example: 0

    • display_separately      boolean

      Indicates whether store displays handling fee separately at checkout.
      Example: true

  • enabled    boolean

    Whether this shipping zone is enabled.
    Example: true

example

Delete a Shipping Zone

DELETE /shipping/zones/{id}

Request

Deletes a Shipping Zone.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • id in path - integer
    required
    ID of the shipping zone.

example

Response

Did you find what you were looking for?
Delete a Shipping MethodGet All Shipping Zones