gatsby-source-bigcommerce-v2
This unofficial source plugin makes BigCommerce API data available in GatsbyJS sites. Currently in active development.
DEPRECATION NOTICE
This plugin @epicdesignlabs/gatsby-source-bigcommerce is no longer maintained and now officially deprecated. Please use this unofficial, but currently maintained gatsby-source-bigcommerce-v2 plugin instead as Im still currently maintaining this plugin.
Features
Provide support for the following features:
- Support for both
v2andv3bigcommerceAPI versions - Multiple
bigcommerceAPI versions - Multiple, additional custom headers
- Custom request timeout in all
bigcommerceAPI requests - Data caching on subsequent
gatsbysource plugin runs - Request timeouts in all
bigcommerceAPI requests - Throttling, debouncing, and adjusting the number of concurrent
bigcommerceAPI requests - Option for opting out of type inference for
optimizely/episerverAPIgatsbynodes or add customgatsbynode schemas foroptimizely/episerverAPIgatsbynodes - Support for various response types:
json,xml
Installation and Setup
For npm:
npm install gatsby-source-bigcommerce-v2For yarn:
yarn add gatsby-source-bigcommerce-v2Setup this plugin in gatsby-config.js as follows (*required fields):
module.exports = {
// ...
plugins: [
// ...
{
resolve: "gatsby-source-bigcommerce-v2",
options: {
auth: {
client_id: process.env.BIGCOMMERCE_API_CLIENT_ID // The client ID of your BigCommerce store.,
secret: process.env.BIGCOMMERCE_API_SECRET_KEY // The secret key of your BigCommerce store.,
access_token: process.env.BIGCOMMERCE_API_ACCESS_TOKEN // The access token of your BigCommerce store.,
store_hash: process.env.BIGCOMMERCE_API_STORE_HASH // The store hash of your BigCommerce store.,
},
endpoints: [
{
nodeName: "BigCommerceProducts",
endpoint: "/v3/catalog/products?include=variants,images,custom_fields,bulk_pricing_rules,primary_image,videos,options,modifiers",
schema: null
},
{
nodeName: "BigCommerceCategories",
endpoint: "/v3/catalog/categories",
schema: null
},
{
nodeName: "BigCommerceStore",
endpoint: "/v2/store",
schema: `
type BigCommerceStore implements Node {
account_uuid: String
domain: String
secure_url: String
control_panel_base_url: String
}
`
}
]
}
}
]
};Configuration Options
Additional Headers
Add additional headers to the request as follows:
options: {
// ...
auth: {
headers: {
// Single header
"X-Custom-Header": "Custom Value",
// Mutiple headers
"Access-Control-Allow-Headers": "Custom Value",
"Access-Control-Allow-Credentials": "Custom Value",
"Access-Control-Allow-Origin": "Custom Value",
"Access-Control-Allow-Methods": "Custom Value"
}
}
}Endpoints
Add a single or multiple endpoints. Also supports v2 and v3 API endpoint versions. You can find a list of endpoints here.
Note: The
endpointsshould start with/<BIGCOMMERCE_ENDPOINT_VERSION>/**/*as the base URL will be added automatically to thebigcommercehostnamevalue.
options: {
// ...
endpoints: [
// Single endpoint
{
nodeName: "BigCommerceProducts",
endpoint: "/v3/catalog/products?include=variants,images,custom_fields,bulk_pricing_rules,primary_image,videos,options,modifiers",
schema: null
},
// Multiple endpoints
{
nodeName: "BigCommerceCategories",
endpoint: "/v3/catalog/categories",
schema: null
},
{
nodeName: "BigCommerceStore",
endpoint: "/v2/store",
schema: `
type BigCommerceStore implements Node {
account_uuid: String
domain: String
secure_url: String
control_panel_base_url: String
}
`
}
];
}Global Schema
Add a global schema to all endpoints. This will be merged with the endpoint schema. This is useful for adding global types that affect multiple endpoints.
options: {
// ...
globals: {
schema: `
type BigCommerceId {
bigcommerce_id: Int
}
`
},
endpoints: [
{
nodeName: "BigCommerceProducts",
endpoint: "/v3/catalog/products?include=variants,images,custom_fields,bulk_pricing_rules,primary_image,videos,options,modifiers",
schema: null
},
{
nodeName: "BigCommerceCategories",
endpoint: "/v3/catalog/categories",
schema: null
},
{
nodeName: "BigCommerceStore",
endpoint: "/v2/store",
schema: `
type BigCommerceStore implements Node {
account_uuid: String
domain: String
secure_url: String
control_panel_base_url: String
}
`
}
]
}Response Type
Set the response type for the BigCommerce API requests. Supports json, xml.
Default: json.
options: {
// ...
response_type: "json";
}Request Timeout
Set a custom request timeout for the Optimizely/Episerver API requests (in milliseconds).
Default: 60000 (60 seconds).
options: {
// ...
request_timeout: 60000;
}Request Throttling
Set a custom request throttling interval for the Optimizely/Episerver API requests (in milliseconds).
Default: 500 (0.5 seconds).
options: {
// ...
request_throttle_interval: 500;
}Request Debouncing
Set a custom request debouncing interval for the Optimizely/Episerver API requests (in milliseconds).
Default: 500 (0.5 seconds).
options: {
// ...
request_debounce_interval: 500;
}Request Concurrency
Set a custom request concurrency for the Optimizely/Episerver API requests.
Default: 100.
options: {
// ...
request_concurrency: 100;
}How to Query
Assuming you correctly setup the plugin in gatsby-config.js and you have a BigCommerceProducts node name and its valid endpoint:
options: {
// ...
endpoints: {
BigCommerceProducts: "/v3/catalog/products?include=variants,images,custom_fields,bulk_pricing_rules,primary_image,videos,options,modifiers";
}
}you can query the data as follows:
{
allBigCommerceProducts {
edges {
nodes {
name
price
id
sku
variants {
id
product_id
price
cost_price
image_url
sku
}
reviews_count
reviews_rating_sum
page_title
images {
id
description
product_id
date_modified
}
bigcommerce_id
brand_id
custom_url {
url
}
categories
availability
}
}
}
}Contributing
Please feel free to contribute! PRs are always welcome.
License
This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.
Author
Credits
Thanks to all the contributors of the original plugin gatsby-source-bigcommerce and node-bigcommerce for the great work.
![dependabot[bot]](https://avatars.githubusercontent.com/u/49699333?size=120)
