Storefront APIs
Store

Store

Store shopping information settings.

Get Store Order Statuses Setting

GET /stores/order-statuses

Request

Get a list of all statuses of the order, including status codes and custom status names. Equivalent Storefront GraphQL API Query: orderStatuses. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/stores/order-statuses \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"orderStatuses": [
{
"systemLabel": "Incomplete",
"customLabel": "Incomplete",
"statusCode": "0"
},
{
"systemLabel": "Pending",
"customLabel": "Pending Kido Test",
"statusCode": "1"
},
{
"systemLabel": "Shipped",
"customLabel": "Shipping",
"statusCode": "2"
},
{
"systemLabel": "Partially Shipped",
"customLabel": "Partially Shipped",
"statusCode": "3"
},
{
"systemLabel": "Refunded",
"customLabel": "Refunded Test",
"statusCode": "4"

Get Store Currencies Setting

GET /stores/currencies

Request

Get store currencies config. Equivalent Storefront GraphQL API Query: currencies. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • storehash in query - string
    required
    Store Hash
  • channelId in query - string
    BigCommerce channel id

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/stores/currencies \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"currencies": [
{
"id": 1,
"is_default": false,
"last_updated": "Wed, 19 May 2021 01:35:32 +0000",
"country_iso2": "null",
"default_for_country_codes": [],
"currency_code": "USD",
"currency_exchange_rate": "0.1411948941",
"name": "USD",
"token": "$",
"auto_update": false,
"token_location": "left",
"decimal_token": ".",
"thousands_token": ",",
"decimal_places": 2,
"enabled": true,
"is_transactional": true
}
]
}
}

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?