Docs
Management API
Channels
Currency Assignments

Currency Assignments

Get All Channels Currency Assignments

GET /channels/currency-assignments

Request

Returns a list of currency assignments for all channels.

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/channels/currency-assignments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

response

{
"data": [
{
"channel_id": 1,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
},
{
"channel_id": 664177,
"enabled_currencies": [
"USD",
"GBP"
],
"default_currency": "USD"
},
{
"channel_id": 664179,
"enabled_currencies": [
"USD",
"AUD"
],
"default_currency": "USD"
},
{
"channel_id": 667159,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
}
],

Create Multiple Channels Currency Assignments

POST /channels/currency-assignments

Request

Sets enabled currencies and default currency for multiple channels. Note that currencies must be added first in the Settings > Setup > Currencies settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a 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.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

array | application/json

  • channel_id    integer
    required

    The ID of the channel.

  • enabled_currencies    array[string]
    required

    Currencies that are enabled for the specified channel in ISO 4217 three character alphabetic format.

  • default_currency    string
    required

    Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot.

Create Currency Assignments for Multiple Channels

[
{
"channel_id": 1,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
},
{
"channel_id": 664177,
"enabled_currencies": [
"USD",
"GBP"
],
"default_currency": "USD"
},
{
"channel_id": 664179,
"enabled_currencies": [
"USD",
"AUD"
],
"default_currency": "USD"
},
{
"channel_id": 667159,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
}
]

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

response

{
"data": [
{
"channel_id": 1,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
},
{
"channel_id": 664177,
"enabled_currencies": [
"USD",
"GBP"
],
"default_currency": "USD"
},
{
"channel_id": 664179,
"enabled_currencies": [
"USD",
"AUD"
],
"default_currency": "USD"
},
{
"channel_id": 667159,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
}
],

Update Multiple Channels Currency Assignments

PUT /channels/currency-assignments

Request

Updates enabled currencies and default currency for multiple channels. Note that currencies must be added first in the Settings > Setup > Currencies settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a 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.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

array | application/json

  • channel_id    integer
    required

    The ID of the channel.

  • enabled_currencies    array[string]
    required

    Currencies that are enabled for the specified channel in ISO 4217 three character alphabetic format.

  • default_currency    string
    required

    Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot.

Update Currency Assignments for Multiple Channels

[
{
"channel_id": 1,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
},
{
"channel_id": 664177,
"enabled_currencies": [
"USD",
"GBP"
],
"default_currency": "USD"
},
{
"channel_id": 664179,
"enabled_currencies": [
"USD",
"AUD"
],
"default_currency": "USD"
},
{
"channel_id": 667159,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
}
]

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

response

{
"data": [
{
"channel_id": 1,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
},
{
"channel_id": 664177,
"enabled_currencies": [
"USD",
"GBP"
],
"default_currency": "USD"
},
{
"channel_id": 664179,
"enabled_currencies": [
"USD",
"AUD"
],
"default_currency": "USD"
},
{
"channel_id": 667159,
"enabled_currencies": [
"USD"
],
"default_currency": "USD"
}
],

Get Channel Currency Assignments

GET /channels/{channel_id}/currency-assignments

Request

Returns a list of currency assignments 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 - integer
    required
    The ID of a channel.

example

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

Response

Body

object | application/json

  • data    object

    Details about currency assignments for a specific channel.

  • meta    object

    Response metadata.

response

{
"data": {
"channel_id": 1,
"enabled_currencies": [
"USD",
"GBP",
"AUD"
],
"default_currency": "USD"
},
"meta": {}
}

Create Channel Currency Assignments

POST /channels/{channel_id}/currency-assignments

Request

Sets enabled currencies and default currency for a specific channel. Note that currencies must be added first in the Settings > Setup > Currencies settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a 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 - integer
    required
    The ID of a channel.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json
Details about currency assignments for a specific channel.

  • enabled_currencies    array[string]
    required

    Currencies that are enabled for the specified channel in ISO 4217 three character alphabetic format.

  • default_currency    string
    required

    Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot.

Create Currency Assignments for a Channel

{
"enabled_currencies": [
"USD",
"GBP",
"AUD"
],
"default_currency": "USD"
}

Response

Body

object | application/json

  • data    object

    Details about currency assignments for a specific channel.

  • meta    object

    Response metadata.

response

{
"data": {
"channel_id": 1,
"enabled_currencies": [
"USD",
"GBP",
"AUD"
],
"default_currency": "USD"
},
"meta": {}
}

Update Channel Currency Assignments

PUT /channels/{channel_id}/currency-assignments

Request

Updates enabled currencies and default currency for a specific channel. Note that currencies must be added first in the Settings > Setup > Currencies settings from an active MSF-enabled BigCommerce store control panel before the currencies can be assigned to a 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 - integer
    required
    The ID of a channel.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json
Details about currency assignments for a specific channel.

  • enabled_currencies    array[string]
    required

    Currencies that are enabled for the specified channel in ISO 4217 three character alphabetic format.

  • default_currency    string
    required

    Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot.

Update Currency Assignments for a Channel

{
"enabled_currencies": [
"USD",
"GBP",
"AUD"
],
"default_currency": "USD"
}

Response

Body

object | application/json

  • data    object

    Details about currency assignments for a specific channel.

  • meta    object

    Response metadata.

response

{
"data": {
"channel_id": 1,
"enabled_currencies": [
"USD",
"GBP",
"AUD"
],
"default_currency": "USD"
},
"meta": {}
}

Delete Channel Currency Assignments

DELETE /channels/{channel_id}/currency-assignments

Request

Deletes currency assignments for a specific channel. Once done, this channel will inherit the store’s currency 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.
  • channel_id in path - integer
    required
    The ID of a channel.

example

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

Response

Body

object | application/json

  • data    integer

    The ID of the channel.

  • meta    object

    Response metadata.

response

{
"data": 1,
"meta": {}
}
Did you find what you were looking for?
Delete Multiple MetafieldsGet All Channels Currency Assignments