Storefront APIs
Store Settings

Store Settings

Get All Available Currencies

GET /stores/currencies

Request

Returns a list of the currencies currently enabled on a BigCommerce store. If the channelId parameter is provided, the response will also include a list of currencies currently enabled for the associated storefront channel.

Note: This endpoint is available with or without a Bearer Token. To use the endpoint without a token, the storeHash parameter is required.

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

Authentication

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

Parameters

  • channelId in query - string
    The ID for a specific storefront channel. Including this parameter adds a list of channel-specific currencies to the response.
  • storeHash in query - string

    The unique store hash for the BigCommerce store.

    If a Bearer Token is provided with the request, the store's information is pulled using the token, and including the parameter will have no effect. If the Bearer Token is omitted this parameter is required to complete the request.

example

Response

OK

Body

object | application/json
Response body for the request.
  • code
    integer

    HTTP response code for the request.

    Default: 200

  • message
    string

    Message indicating the status of the request.

    Default: SUCCESS

  • data
    object

    Data associated with the response.

With Channel ID

Without Channel ID

Get All Store-Level Order Statuses

GET /stores/order-statuses

Request

Returns a list of all order statuses, including status codes and custom status names. For more information about order statuses generally, see Order Status or Order Statuses.

Equivalent Storefront GraphQL API Query: orderStatuses. For more information, see the GraphQL Playground.

Authentication

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

example

Response

OK

Body

object | application/json
Response body for the request.
  • code
    integer

    HTTP response code for the request.

    Default: 200

  • message
    string

    Message indicating the status of the request.

    Default: SUCCESS

  • data
    object

    Data associated with the response.

example

Did you find what you were looking for?