BigCommerce

Manage products, orders, and customers on BigCommerce stores.

Detail	Value
Category	E-commerce
Base URL	https://api.bigcommerce.com/stores/{store_hash}/v3
Authentication	API Key
Endpoints	5
Connector key	bigcommerce

Using BigCommerce in a workflow

1. Go to Connections and click New Connection.
2. Pick BigCommerce from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET /catalog/products	List products
POST /catalog/products	Create a product
GET /catalog/products/{product_id}	Get a product
GET /orders	List orders
GET /customers	List customers

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /catalog/products

List products

Detail	Value
Operation ID	ecommerce.listProducts
Method	GET
Path	/catalog/products

Parameters

Name	Location	Type	Required
limit	query	integer	No
page	query	integer	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your BigCommerce connection from the Connection dropdown.
3. In the Operation dropdown, select ecommerce.listProducts.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream BigCommerce API reference.

POST /catalog/products

Create a product

Detail	Value
Operation ID	ecommerce.createProduct
Method	POST
Path	/catalog/products

Parameters

No parameters.

Request Body

Field	Type
name	string
price	number
type	string
weight	number

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your BigCommerce connection from the Connection dropdown.
3. In the Operation dropdown, select ecommerce.createProduct.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream BigCommerce API reference.

GET /catalog/products/{product_id}

Get a product

Detail	Value
Operation ID	ecommerce.getProduct
Method	GET
Path	/catalog/products/{product_id}

Parameters

Name	Location	Type	Required
product_id	path	string	Yes

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your BigCommerce connection from the Connection dropdown.
3. In the Operation dropdown, select ecommerce.getProduct.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream BigCommerce API reference.

GET /orders

List orders

Detail	Value
Operation ID	ecommerce.listOrders
Method	GET
Path	/orders

Parameters

Name	Location	Type	Required
limit	query	integer	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your BigCommerce connection from the Connection dropdown.
3. In the Operation dropdown, select ecommerce.listOrders.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream BigCommerce API reference.

GET /customers

List customers

Detail	Value
Operation ID	ecommerce.listCustomers
Method	GET
Path	/customers

Parameters

Name	Location	Type	Required
limit	query	integer	No

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your BigCommerce connection from the Connection dropdown.
3. In the Operation dropdown, select ecommerce.listCustomers.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream BigCommerce API reference.