BigCommerce

This documentation for the BigCommerce integration describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate BigCommerce, visit our connection instructions.

Version

This integration utilizes the BigCommerce REST API v2 and v3.

Base URL

The base URL used for all BigCommerce API endpoints contains the Store hash:

https://api.bigcommerce.com/stores/store_hash

---

Authentication & Authorization

The DataGrail BigCommerce integration connects using OAuth 2.0 with the following credentials: Client ID and Client Secret.

Sensitive Credentials

Publicly exposing your API credentials can allow unauthorized access to BigCommerce API endpoints by a third party. DataGrail stores your API credentials encrypted and protected.

Scopes

The BigCommerce integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Base	Access	Deletion
store_v2_customers_read_only		✅
store_v2_orders_read_only		✅
store_v2_transactions_read_only	✅	✅
store_payments_methods_read	✅	✅
store_v2_customers	✅		✅
store_v2_orders	✅		✅

Base Scopes

All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/v3/customers	Verify connection
GET	https://login.bigcommerce.com/oauth2/authorize	Request authorization
POST	https://login.bigcommerce.com/oauth2/token	Get access token

---

Limits

Limits in BigCommerce are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's BigCommerce integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search customers using configured identifiers.
2. Search for the subscribers using configured identifiers.
3. Search orders using configured identifiers.
4. For all collected orders:
   • Fetch shipments.
   • Fetch shipping address.
   • Fetch messages.
   • Fetch refunds.
   • Fetch transactions.
   • Fetch accepted payment methods.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/v2/orders	Search all orders
GET	/v2/orders/order_id/messages	Search order messages
GET	/v2/orders/order_id/shipments	Search order shipments
GET	/v2/orders/order_id/shipping_addresses	Search a shipping address
GET	/v3/customers	Search customers
GET	/v3/customers/subscribers	Search subscribers
GET	/v3/orders/order_id/payment_actions/refunds	Search refunds
GET	/v3/orders/order_id/transactions	Search transactions
GET	/v3/payments/methods	Search payment methods

---

Deletion

DataGrail's BigCommerce integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Delete extracted customers.
2. Delete extracted subscribers.
3. Anonymize extracted orders.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
PUT	/v2/orders/order_id	Update order
DEL	/v3/customers	Delete customers
DEL	/v3/customers/subscribers/subscriber_id	Delete subscriber

---