View as Markdown
BigCommerce icon

BigCommerce ACTION

Create Product

Create a product. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BigCommerce account once, then configure and run Create Product from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "bigcommerce-create-product",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bigcommerce: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    type: "Type",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Product inputs
Property Type Description
name Name string
The product name. >= 1 characters <= 250 characters
Required
type Type string
The product type. One of: physical - a physical stock unit, digital - a digital download. Allowed values: physical digital Example: physical
Required
sku SKU string
User defined product code/stock keeping unit (SKU). >= 0 characters <= 255 characters Example: SM-13
Optional
description Description string
The product description, which can include HTML formatting.
Optional
weight Weight any
Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store >= 0 and <= 9999999999
Required
width Width any
Width of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Optional
depth Depth any
Depth of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Optional
height Height any
Height of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Optional
price Price any
The price of the product. The price should include or exclude tax, based on the store settings. >= 0
Required
cost_price Cost Price any
The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store. >=0
Optional
retail_price Retail Price any
The retail cost of the product. If entered, the retail cost price will be shown on the product page. >=0
Optional
sale_price Sale Price any
If entered, the sale price will be used instead of value in the price field when calculating the product's cost. >=0
Optional
map_price Map Price integer
Minimum Advertised Price
Optional
tax_class_id Tax class id integer
The ID of the tax class applied to the product. (NOTE: Value ignored if automatic tax is enabled.) >= 0 and <= 1000000000
Optional Dynamic
product_tax_code Product tax code string
Accepts AvaTax System Tax Codes, which identify products and services that fall into special sales-tax categories. By using these codes, merchants who subscribe to BigCommerce's Avalara Premium integration can calculate sales taxes more accurately. Stores without Avalara Premium will ignore the code when calculating sales tax. Do not pass more than one code. The codes are case-sensitive. For details, please see Avalara's documentation. >= 0 characters <= 255 characters
Optional
categories Categories integer[]
An array of IDs for the categories to which this product belongs. When updating a product, if an array of categories is supplied, all product categories will be overwritten. Does not accept more than 1,000 ID values.
Optional Dynamic
brand_id Brand Id integer
A product can be added to an existing brand during a product /PUT or /POST. >= 0 and <= 1000000000
Optional Dynamic
inventory_level Inventory Level integer
Current inventory level of the product. Simple inventory tracking must be enabled (See the inventory_tracking field) for this to take any effect. >= 0 and <= 1000000000
Optional
inventory_warning_level Inventory Warning Level integer
Inventory warning level for the product. When the product's inventory level drops below the warning level, the store owner will be informed. Simple inventory tracking must be enabled (see the inventory_tracking field) for this to take any effect. >= 0 and <= 1000000000
Optional
inventory_tracking Inventory Tracking string
The type of inventory tracking for the product. Values are: none - inventory levels will not be tracked; product - inventory levels will be tracked using the inventory_level and inventory_warning_level fields; variant - inventory levels will be tracked based on variants, which maintain their own warning levels and inventory levels. Allowed values: none, product, variant
Optional
fixed_cost_shipping_price Fixed cost shipping price any
A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation. >= 0
Optional
is_free_shipping Is free shipping boolean
Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero.
Optional
is_visible Is visible boolean
Flag to determine whether the product should be displayed to customers browsing the store. If true, the product will be displayed. If false, the product will be hidden from view.
Optional
is_featured Is Featured boolean
Flag to determine whether the product should be included in the featured products panel when viewing the store.
Optional
related_products Related Products integer[]
An array of IDs for the related products.
Optional Dynamic
warranty Warranty string
Warranty information displayed on the product page. Can include HTML formatting. >= 0 characters and <= 65535 characters
Optional
bin_picking_number Bin picking number string
The BIN picking number for the product. >= 0 characters and <= 255 characters
Optional
layout_file Layout File string
The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. >= 0 characters and <= 500 characters
Optional
upc UPC string
The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations. >= 0 characters and <= 255 characters
Optional
search_keywords Seach keywords string
A comma-separated list of keywords that can be used to locate the product when searching the store. >= 0 characters and <= 65535 characters
Optional
availability Availability string
Availability of the product. (Corresponds to the product's Purchasability section in the control panel.) Supported values: available - the product is available for purchase; disabled - the product is listed on the storefront, but cannot be purchased; preorder - the product is listed for pre-orders. Allowed values: available, disabled or preorder
Optional
availability_description Availability description string
Availability text displayed on the checkout page, under the product title. Tells the customer how long it will normally take to ship this product, such as: 'Usually ships in 24 hours.' >= 0 characters and <= 255 characters
Optional
gift_wrapping_options_type Gift wrapping options type string
Type of gift-wrapping options. Values: any - allow any gift-wrapping options in the store; none - disallow gift-wrapping on the product; list – provide a list of IDs in the gift_wrapping_options_list field. Allowed values: any, none or list
Optional
gift_wrapping_options_list Gift wrapping options list string[]
A list of gift-wrapping option IDs.
Optional
sort_order Sort order integer
Priority to give this product when included in product lists on category pages and in search results. Lower integers will place the product closer to the top of the results. >= -2147483648 and <= 2147483647
Optional
condition Condition string
The product condition. Will be shown on the product page if the is_condition_shown field's value is true. Possible values: New, Used, Refurbished. Allowed values: New, Used and Refurbished
Optional
is_condition_shown Is condition shown boolean
Flag used to determine whether the product condition is shown to the customer on the product page.
Optional
order_quantity_minimum Order quantity minimum integer
The minimum quantity an order must contain, to be eligible to purchase this product. >= 0 and <= 1000000000
Optional
order_quantity_maximum Order quantity maximum integer
The maximum quantity an order can contain when purchasing the product. >= 0 and <= 1000000000
Optional
page_title Page title string
Custom title for the product page. If not defined, the product name will be used as the meta title. >= 0 characters and <= 255 characters
Optional
meta_keywords Meta keywords string[]
Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
Optional
meta_description Meta description string
Custom meta description for the product page. If not defined, the store's default meta description will be used. >= 0 characters and <= 65535 characters
Optional
view_count View count integer
The number of times the product has been viewed. >= 0 and <= 1000000000
Optional
preorder_release_date Preorder release date string
Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.
Optional
preorder_message Preorder message string
Custom expected-date message to display on the product page. If undefined, the message defaults to the storewide setting. Can contain the %%DATE%% placeholder, which will be substituted for the release date. >= 0 characters and <= 255 characters
Optional
is_preorder_only Is preorder only boolean
If set to true then on the preorder release date the preorder status will automatically be removed. If set to false, then on the release date the preorder status will not be removed. It will need to be changed manually either in the control panel or using the API. Using the API set availability to available.
Optional
is_price_hidden Is preorder hidden boolean
False by default, indicating that this product's price should be shown on the product page. If set to true, the price is hidden. (NOTE: To successfully set is_price_hidden to true, the availability value must be disabled.)
Optional
price_hidden_label Price hidden label string
By default, an empty string. If is_price_hidden is true, the value of price_hidden_label is displayed instead of the price. (NOTE: To successfully set a non-empty string value with is_price_hidden set to true, the availability value must be disabled.) >= 0 characters and <= 200 characters
Optional
open_graph_type Open graph type string
Type of product, defaults to product. Allowed values: product, album, book, drink, food, game, movie, song OR tv_show
Optional
open_graph_title Open graph title string
Title of the product, if not specified the product name will be used instead.
Optional
open_graph_description Open graph description string
Description to use for the product, if not specified then the meta_description will be used instead.
Optional
open_graph_use_meta_description Open graph use meta description boolean
Flag to determine if product description or open graph description is used.
Optional
open_graph_use_product_name Open graph use product name boolean
Flag to determine if product name or open graph name is used.
Optional
open_graph_use_image Open graph use image boolean
Flag to determine if product image or open graph image is used.
Optional
brand_name Brand name string
It performs a fuzzy match and adds the brand. eg. "Common Good" and "Common good" are the same. Brand name does not return as part of a product response. Only the brand_id.
Optional
gtin GTIN string
Global Trade Item Number
Optional
mpn MPN string
Manufacturer Part Number
Optional
reviews_rating_sum Reviews rating sum any
The total rating for the product.
Optional
reviews_count Reviews count integer
The number of times the product has been rated.
Optional
total_sold Total sold integer
The total quantity of this product sold.
Optional
images Images string[]
Array of image strings. They can be either local paths or URLs. Limit of 8MB per file. If it is a URL it has a 255 character limit. Supported image file types are BMP, GIF, JPEG, PNG, WBMP, XBM, and WEBP. If it is a local path it should be previously downloaded to Pipedream E.g. (/tmp/my-image.png). Download a file to the /tmp directory
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
bigcommerce-create-product
Version
0.0.4
App
BigCommerce
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes