Store adapter — BigCommerce¶

The adapter object contains properties for connecting to the BigCommerce API.

Parent object: a store with property "platform" : "big_commerce"

Required properties¶

The following adapter properties are required for BigCommerce stores.

`access_token`¶

Property	`access_token`
Name	BigCommerce Access Token
Data type	string
Required?	Yes

`store_hash`¶

Property	`store_hash`
Name	Store Hash
Description	The Store Hash is the part of the API Path, as listed in BigCommerce Dashboard > Advanced Settings > API Accounts, that follows `/stores/` and precedes `/v3/`
Data type	string
Example	If the API path is `https://api.bigcommerce.com/stores/1234567890/v3/`, then the Store Hash is `1234567890`
Required?	Yes

Optional properties¶

The following adapter properties are optional for BigCommerce stores.

`client_id`¶

Property	`client_id`
Name	Client ID
Data type	string

Example¶

Example: create a new BigCommerce store

cURL

curl -X POST \
    -H "Authorization: Bearer $JWT_TOKEN" \
    -H "Content-Type: application/json" \
    https://api.getdropstream.com/stores \
    -d @- <<EOF
{ "customer_id": "3775",
  "name": "Your BigCommerce Store",
  "platform": "big_commerce",
  "adapter": {
    "access_token": "abc123",
    "store_hash": "abc123",
    "client_id": "abc123"
  }
}
EOF

For details about this request type, see: Create a new store.