Skip to content
Documentation
Contact
← Back to documentation
Technical Reference

BigCommerce

BigCommerce is a leading e-commerce platform that enables businesses to create and manage online stores.

CategoryOther
Authenticationcustom
Version0.2.0
Published scopes0 published scopes
Last updatedSeptember 19, 2026

Overview

BigCommerce

This CDK catalogue package is pinned to @activepieces/piece-bigcommerce@0.2.0 and declares 16 declared actions and 11 declared triggers. Its definition is derived from the exact reviewed Activepieces source.

Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.

Technical guide

Technical reference

  • Package: @activepieces/piece-bigcommerce@0.2.0
  • Exact artifact digest: sha256:632ef22b26875662e4a42759c79589fd0c0a315d1d2a7273abcaa1b355257439
  • Source: the exact reviewed Activepieces source
  • Authentication, action and trigger schemas are taken from the exact pinned package.

Capability summary

Authenticationcustom
Supported objects27
Supported actions16
Triggers11

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • Markdown Optional
  • Store Hash Required
  • Access Token Required · protected credential

Supported objects

ObjectReadWriteNotes
Create Customer Yes No
Create a Product Yes No
Update a Product Yes No
Delete a Product Yes No
Get Order Yes No
List Orders Yes No
List Categories Yes No
Create Blog Post Yes No
Create Customer Address Yes No
Search Customer Yes No
Search Product Yes No
Search Customer Address Yes No
Find or Create Customer Yes No
Find or Create Product Yes No
Find or Create Customeru2019s Address Yes No
Custom API Call Yes No
Abandoned Cart Yes No Trigger contract validated offline; live event delivery is tracked separately.
Cart Created Yes No Trigger contract validated offline; live event delivery is tracked separately.
Customer Address Created Yes No Trigger contract validated offline; live event delivery is tracked separately.
Customer Address Updated Yes No Trigger contract validated offline; live event delivery is tracked separately.
Customer Created Yes No Trigger contract validated offline; live event delivery is tracked separately.
Customer Updated Yes No Trigger contract validated offline; live event delivery is tracked separately.
Order Created Yes No Trigger contract validated offline; live event delivery is tracked separately.
Order Updated Yes No Trigger contract validated offline; live event delivery is tracked separately.
Order Status Updated Yes No Trigger contract validated offline; live event delivery is tracked separately.
Product Created Yes No Trigger contract validated offline; live event delivery is tracked separately.
Shipment Created Yes No Trigger contract validated offline; live event delivery is tracked separately.

Supported actions

Create Customer · Read

Creates a customer

create_customer · Risk: low · Retry: safe

Inputs

  • email · string · Required, Customer email address
  • first_name · string · Required, Customer first name
  • last_name · string · Required, Customer last name
  • company · string · Optional, Customer company name
  • phone · string · Optional, Customer phone number
  • notes · string · Optional, Customer notes
Create a Product · Read

Creates a Product

create_aproduct · Risk: low · Retry: safe

Inputs

  • name · string · Required, Name of the product
  • type · string · Required, Type of product
  • sku · string · Optional, Product SKU
  • description · string · Optional, Product description
  • weight · number · Required, Product weight
  • price · number · Required, Product price
  • brand_id · number · Optional, Brand ID
Update a Product · Read

Updates an existing Product

update_aproduct · Risk: low · Retry: safe

Inputs

  • productId · string · Required, The ID of the product to update
  • name · string · Optional, Name of the product
  • type · string · Optional, Type of product
  • sku · string · Optional, Product SKU
  • description · string · Optional, Product description
  • weight · number · Optional, Product weight
  • price · number · Optional, Product price
  • brand_id · number · Optional, Brand ID
Delete a Product · Read

Deletes an existing Product

delete_aproduct · Risk: low · Retry: safe

Inputs

  • productId · string · Required, The ID of the product to delete
Get Order · Read

Gets details of an order

get_order · Risk: low · Retry: safe

Inputs

  • orderId · string · Required, The ID of the order to retrieve
List Orders · Read

Lists all orders

list_orders · Risk: low · Retry: safe

Inputs

  • customer_id · number · Optional, Filter by customer ID
  • status_id · number · Optional, Filter by status ID
List Categories · Read

Lists all categories

list_categories · Risk: low · Retry: safe

Inputs

  • name · string · Optional, Filter by category name
Create Blog Post · Read

Creates a blog post

create_blog_post · Risk: low · Retry: safe

Inputs

  • title · string · Required, Blog post title
  • body · string · Required, Blog post content (HTML supported)
  • author · string · Optional, Author name
  • url · string · Optional, URL for the public blog post. Example - /blog/welcome-bigcommerce/
  • published_date · string · Optional, Published Date for the blog post. Example - Wed, 10 Aug 2022 15:39:15 -0500
  • meta_description · string · Optional, Description text for this blog postu2019s element.
  • meta_keywords · string · Optional, Comma seperated (,) Keywords for this blog postu2019s element. Eg welcome, bigcommerce
  • tags · array · Optional, Array of tags
  • is_published · boolean · Optional, Whether the post is published
Create Customer Address · Read

Creates a customer's address

create_customer_address · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, Select the customer
  • first_name · string · Required
  • last_name · string · Required
  • address1 · string · Required
  • address2 · string · Optional
  • city · string · Required
  • state_or_province · string · Required
  • postal_code · string · Required
  • country_code · string · Required, ISO 3166-1 alpha-2 country code
  • phone · string · Optional
Search Customer · Read

Searches for a registered customer

search_customer · Risk: low · Retry: safe

Inputs

  • email · string · Optional, Customer email to search for
  • phone · string · Optional, Phone Number to search for
  • name · string · Optional, Customer name to search for
Search Product · Read

Searches for a product in the catalog

search_product · Risk: low · Retry: safe

Inputs

  • name · string · Optional, Product name to search for
  • sku · string · Optional, Product SKU to search for
  • type · string · Optional
  • brand_id · string · Optional, Brand ID to search for
  • weight · number · Optional
  • price · number · Optional
Search Customer Address · Read

Searches for a customeru2019s address

search_customer_address · Risk: low · Retry: safe

Inputs

  • customer_ids · array · Optional, Select the customers
  • name · string · Optional, Customer name to search for
Find or Create Customer · Read

Finds or creates a customer

find_or_create_customer · Risk: low · Retry: safe

Inputs

  • email · string · Required, Customer email address
  • first_name · string · Required, Customer first name
  • last_name · string · Required, Customer last name
  • company · string · Optional, Customer company name
  • phone · string · Optional, Customer phone number
  • notes · string · Optional, Customer notes
Find or Create Product · Read

Finds or creates a product

find_or_create_product · Risk: low · Retry: safe

Inputs

  • name · string · Required
  • sku · string · Optional
  • type · string · Required
  • weight · number · Required
  • price · number · Required
  • description · string · Optional
  • brand_id · number · Optional, Brand ID
Find or Create Customeru2019s Address · Read

Finds or creates a customeru2019s address

find_or_create_customers_address · Risk: low · Retry: safe

Inputs

  • customer_id · string · Required, Select the customer
  • first_name · string · Required
  • last_name · string · Required
  • address1 · string · Required
  • address2 · string · Optional
  • city · string · Required
  • state_or_province · string · Required
  • postal_code · string · Required
  • country_code · string · Required, ISO 3166-1 alpha-2 country code
  • phone · string · Optional
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Triggers

Abandoned Cart · Webhook

Triggers when a cart is abandoned

Cart Created · Webhook

Triggers when a new cart is created

Customer Address Created · Webhook

Triggers when a new customer address is created

Customer Address Updated · Webhook

Triggers when a new customer address is updated

Customer Created · Webhook

Triggers when a new customer is created

Customer Updated · Webhook

Triggers when a customer is updated

Order Created · Webhook

Triggers when a new order is created

Order Updated · Webhook

Triggers when an order is updated

Order Status Updated · Webhook

Triggers when an order status has changed

Product Created · Webhook

Triggers when a new product is created

Shipment Created · Webhook

Triggers when a new shipment is created

Setup

Setup

Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.

Limitations

The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.

github.com