BigCommerce

Create products, list products, and manage orders in BigCommerce.

E-commerceAPI key11 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (11)
findOrCreateProduct
createAProduct
createBlogPost
createCustomer
createCustomerAddress
custom_api_call
findOrCreateCustomer
findOrCreateCustomersAddress
searchCustomer
searchCustomerAddress
searchProduct
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("bigcommerce", "findOrCreateProduct", {
    "name": "<product name>",
    "type": "physical",
    "weight": 1,
    "price": 1
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("BigCommerce answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "bigcommerce-findorcreateproduct",
  name: "BigCommerce: Find or Create Product",
  description: "Calls BigCommerce when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("bigcommerce", {
      "action": "findOrCreateProduct",
      "name": "<product name>",
      "type": "physical",
      "weight": 1,
      "price": 1
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/bigcommerce/findOrCreateProduct" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"name":"<product name>","type":"physical","weight":1,"price":1}}'

Actions

findOrCreateProductin catalog

Find or Create Product. Finds or creates a product

Input	Type	Description
`name`required	text	Product Name
`sku`optional	text	SKU
`type`required	one of "physical" \| "digital"	Product Type
`weight`required	number	Weight
`price`required	number	Price
`description`optional	long text	Description
`brand_id`optional	number	Brand ID

createAProduct

Create a Product. Creates a Product

Input	Type	Description
`name`required	text	Name of the product
`type`required	one of "physical" \| "digital"	Type of product
`sku`optional	text	Product SKU
`description`optional	long text	Product description
`weight`required	number	Product weight
`price`required	number	Product price
`brand_id`optional	number	Brand ID

createBlogPost

Create Blog Post. Creates a blog post

Input	Type	Description
`title`required	text	Blog post title
`body`required	long text	Blog post content (HTML supported)
`author`optional	text	Author name
`url`optional	text	URL for the public blog post. Example - /blog/welcome-bigcommerce/
`published_date`optional	date-time (ISO)	Published Date for the blog post. Example - Wed, 10 Aug 2022 15:39:15 -0500
`meta_description`optional	long text	Description text for this blog post’s <meta/> element.
`meta_keywords`optional	long text	Comma seperated (,) Keywords for this blog post’s <meta/> element. Eg welcome, bigcommerce
`tags`optional	array	Array of tags
`is_published`optional	boolean	Whether the post is published

createCustomer

Create Customer. Creates a customer

Input	Type	Description
`email`required	text	Customer email address
`first_name`required	text	Customer first name
`last_name`required	text	Customer last name
`company`optional	text	Customer company name
`phone`optional	text	Customer phone number
`notes`optional	long text	Customer notes

createCustomerAddress

Create Customer Address. Creates a customer's address

Input	Type	Description
`customer_id`required	id (picked from your account)	Select the customer
`first_name`required	text	First Name
`last_name`required	text	Last Name
`address1`required	text	Address Line 1
`address2`optional	text	Address Line 2
`city`required	text	City
`state_or_province`required	text	State/Province
`postal_code`required	text	Postal Code
`country_code`required	text	ISO 3166-1 alpha-2 country code
`phone`optional	text	Phone

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

findOrCreateCustomer

Find or Create Customer. Finds or creates a customer

Input	Type	Description
`email`required	text	Customer email address
`first_name`required	text	Customer first name
`last_name`required	text	Customer last name
`company`optional	text	Customer company name
`phone`optional	text	Customer phone number
`notes`optional	long text	Customer notes

findOrCreateCustomersAddress

Find or Create Customer’s Address. Finds or creates a customer’s address

Input	Type	Description
`customer_id`required	id (picked from your account)	Select the customer
`first_name`required	text	First Name
`last_name`required	text	Last Name
`address1`required	text	Address Line 1
`address2`optional	text	Address Line 2
`city`required	text	City
`state_or_province`required	text	State/Province
`postal_code`required	text	Postal Code
`country_code`required	text	ISO 3166-1 alpha-2 country code
`phone`optional	text	Phone

searchCustomer

Search Customer. Searches for a registered customer

Input	Type	Description
`email`optional	text	Customer email to search for
`phone`optional	text	Phone Number to search for
`name`optional	text	Customer name to search for

searchCustomerAddress

Search Customer Address. Searches for a customer’s address

Input	Type	Description
`customer_ids`optional	ids (picked from your account)	Select the customers
`name`optional	text	Customer name to search for

searchProduct

Search Product. Searches for a product in the catalog

Input	Type	Description
`name`optional	text	Product name to search for
`sku`optional	text	Product SKU to search for
`type`optional	one of "physical" \| "digital"	Product Type
`brand_id`optional	text	Brand ID to search for
`weight`optional	number	Weight
`price`optional	number	Price

Details

Id: bigcommerce
Category: E-commerce
Tags: store, products, orders, enterprise
Package: @activepieces/piece-bigcommerce@0.1.4
Tier: Community