Docs
Management API
Shipping V3
Shipping Settings

Shipping Settings

Get Shipping Settings

GET /shipping/settings

Request

Returns the global-level shipping settings.

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

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/shipping/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    object

  • meta    object

example

{
"data": {
"checkout": {
"country_list_strategy": "DISPLAY_ALL_COUNTRIES",
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
},
"meta": {}
}

Update Shipping Settings

PUT /shipping/settings

Request

Updates the global-level shipping settings.

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

  • checkout    object

example

{
"checkout": {
"country_list_strategy": "DISPLAY_ALL_COUNTRIES",
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
}

Response

Body

object | application/json

  • data    object

  • meta    object

example

{
"data": {
"checkout": {
"country_list_strategy": "DISPLAY_ALL_COUNTRIES",
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
},
"meta": {}
}

Get Shipping Settings per Channel

GET /shipping/settings/channels/{channel_id}

Request

Returns shipping settings for a specific channel.

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.
  • channel_id in path - string
    required
    Channel ID

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/shipping/settings/channels/[channel_id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    object

  • meta    object

example

{
"data": {
"checkout": {
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
},
"meta": {}
}

Update Shipping Settings per Channel

PUT /shipping/settings/channels/{channel_id}

Request

Updates shipping settings for a specific channel.

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.
  • channel_id in path - string
    required
    Channel ID
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • checkout    object

example

{
"checkout": {
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
}

Response

Body

object | application/json

  • data    object

  • meta    object

example

{
"data": {
"checkout": {
"out_of_delivery_zone_message": "Unfortunately, one or more items in your cart can't be shipped to your location. Please choose a different delivery address."
}
},
"meta": {}
}
Did you find what you were looking for?
Upsert Customs InformationGet Shipping Settings