This article explains how to set up your BigCommerce account to integrate with Ometria's website personalisation features.
Before you begin
Get in touch with your Customer Success Representative (or your Technical Projects Manager if you're still onboarding).
They can help guide you through the process and make sure BigCommerce is properly integrated with Ometria's website personalisation features.
Authentication
You'll need an API account in BigCommerce before you can connect.
Go to your BigCommerce Dashboard > Settings and scroll down to the API section.
Select Store-level API accounts.
Create an API account and specify the scopes that you need.
BigCommerce will provide you with the following details to authenticate your API calls:
- Client ID
- Client Secret
- Access token
Store hash
To find your store hash, go to the Store-level API accounts > Create API account.
Your store hash is under the API Path field.
| Property | Type | Description |
channel_id |
Integer | Must be a valid channel ID on the store (required). |
expires_at |
Integer | Unix timestamp (required). |
allowed_cors_origins |
Array (string) | Allowed origins for cross origin requests (required). |
Response
{
"data": {
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJjaWQiOjEsImNvcnMiOlsiaHR0cHM6Ly9hZHZhbmNlZGNvbW1lcmNlLm15YmlnY29tbWVyY2UuY29tIl0sImVhdCI6MjE0NzQ4MzY0NywiaWF0IjoxNjg3NDk0NzE2LCJpc3MiOiJCQyIsInNpZCI6MTAwMjg1NzEzMCwic3ViIjoiOWtqaDVvZmZ3Zzl2cWtzZ2ZhemcyNndlZzZ0dzN3MyIsInN1Yl90eXBlIjoyLCJ0b2tlbl90eXBlIjoxfQ.8v4nrcdxF7ZQPAff9YhQPWdxj_iMqT0N0cqd3M1FZVMbepiKAnUjgyvMDFP0Iy6ScTwxajwVwKTz5jyQOldztg"
},
"meta": {}
}Rate limits
| API | Rate limit |
| Store-level API accounts | 50 |
| API Calls (Trial Stores, Standard and Plus plans) | 20,000 per hour |
| API Calls (Pro plans) | 60,000 per hour |
| API Calls (Enterprise) | Unlimited* |
Endpoints for product data
| Data | Endpoint |
| All Products | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products |
| Bulk Pricing Rules | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/bulk-pricing-rules |
| Category Assignments | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/category-assignments |
| Complex Rules | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/complex-rules |
| Custom Fields | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/custom-fields |
| Images | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/images |
| Metafields | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/metafields |
| Reviews | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/reviews |
| Videos | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/videos |
| Product Modifiers | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/modifiers |
| Product Variants | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/variants |
| Product Variant Options | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/products/[product_id]/options |
Endpoints for Category Data
| Data | Endpoint |
| All Categories | https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/categories |
| Metafields | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/categories/[category_id]/metafields |
| Sort Order | https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/categories/[category_id]/products/sort-order |
Comments
0 comments
Article is closed for comments.