Geography

  • Host: api.bigcommerce.com/stores/{$$.env.store_hash}/v2
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json
More Info

Introduction

OAuth Scopes

UI Name Permission Parameter
Information & Settings modify store_v2_information
Information & Settings read-only store_v2_information_read_only

For more information on OAuth Scopes, see: Authentication.

Authentication

Requests can be authenticated by sending a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:

GET /stores/{$$.env.store_hash}/v3/catalog/summary
host: api.bigcommerce.com
Accept: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}
Header Parameter Description
X-Auth-Client client_id Obtained by creating an API account or installing an app in a BigCommerce control panel.
X-Auth-Token access_token Obtained by creating an API account or installing an app in a BigCommerce control panel.

For more information on Authenticating BigCommerce APIs, see: Authentication.

Available Endpoints

Resource Description
Countries A country or territory, identifiable by an ISO 3166 country code.
States A state or province, identifiable by an ISO 3166 subdivision code.