Create Product with BigCommerce API

Pipedream makes it easy to connect APIs for BigCommerce and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Product with the BigCommerce API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Chase Roberts
@chsrbrts
@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨
@heyellieday
Evaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley
@MBraedley
Update: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting
@mrthomascutting
Want quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts
@mattdotroberts
day 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭
@auchenberg
Yahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑
@raymondcamden
Awesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero
@nachocaballero
I couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow
@jyksnw
Developed a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana
@steven_terrana
@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD
@DotDotJames
Want to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin
@Atinux
GitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul
@raul_predescu
If you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc
@bitfalls
So @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich
@ZachLanich
Um, wow 🤯 @pipedream
Steven Bell
@bellontech
I just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸
@_jayhack_
Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴‍♂️🌳
@philsturgeon
For context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.

Getting Started#

Create a workflow to Create Product with the BigCommerce API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Product action
1. Connect your BigCommerce account
2. Configure Name
3. Select a Type
4. Optional- Configure SKU
5. Optional- Configure Description
6. Configure Weight
7. Optional- Configure Width
8. Optional- Configure Depth
9. Optional- Configure Height
10. Configure Price
11. Optional- Configure Cost Price
12. Optional- Configure Retail Price
13. Optional- Configure Sale Price
14. Optional- Configure Map Price
15. Optional- Select a Tax class id
16. Optional- Configure Product tax code
17. Optional- Select one or more Categories
18. Optional- Select a Brand Id
19. Optional- Configure Inventory Level
20. Optional- Configure Inventory Warning Level
21. Optional- Select a Inventory Tracking
22. Optional- Configure Fixed cost shipping price
23. Optional- Configure Is free shipping
24. Optional- Configure Is visible
25. Optional- Configure Is Featured
26. Optional- Select one or more Related Products
27. Optional- Configure Warranty
28. Optional- Configure Bin picking number
29. Optional- Configure Layout File
30. Optional- Configure UPC
31. Optional- Configure Seach keywords
32. Optional- Select a Availability
33. Optional- Configure Availability description
34. Optional- Select a Gift wrapping options type
35. Optional- Configure Gift wrapping options list
36. Optional- Configure Sort order
37. Optional- Select a Condition
38. Optional- Configure Is condition shown
39. Optional- Configure Order quantity minimum
40. Optional- Configure Order quantity maximum
41. Optional- Configure Page title
42. Optional- Configure Meta keywords
43. Optional- Configure Meta description
44. Optional- Configure View count
45. Optional- Configure Preorder release date
46. Optional- Configure Preorder message
47. Optional- Configure Is preorder only
48. Optional- Configure Is preorder hidden
49. Optional- Configure Price hidden label
50. Optional- Select a Open graph type
51. Optional- Configure Open graph title
52. Optional- Configure Open graph description
53. Optional- Configure Open graph use meta description
54. Optional- Configure Open graph use product name
55. Optional- Configure Open graph use image
56. Optional- Configure Brand name
57. Optional- Configure GTIN
58. Optional- Configure MPN
59. Optional- Configure Reviews rating sum
60. Optional- Configure Reviews count
61. Optional- Configure Total sold
62. Optional- Configure Images
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Product with BigCommerce API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + BigCommerce

Try it

Create Product with BigCommerce API on New Message from Discord API

Discord + BigCommerce

Try it

Create Product with BigCommerce API on New Message In Channels from Slack API

Slack + BigCommerce

Try it

Create Product with BigCommerce API on New Message in Channel from Discord Bot API

Discord Bot + BigCommerce

Try it

Create Product with BigCommerce API on New Submission from Typeform API

Typeform + BigCommerce

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Product on BigCommerce

Description:Create a product. [See the docs here](https://developer.bigcommerce.com/api-reference/366928572e59e-create-a-product)

Version:0.0.3

Key:bigcommerce-create-product

View on GitHub

Code#

import common from "../common/product.mjs";

export default {
  ...common,
  key: "bigcommerce-create-product",
  name: "Create Product",
  description:
    "Create a product. [See the docs here](https://developer.bigcommerce.com/api-reference/366928572e59e-create-a-product)",
  version: "0.0.3",
  type: "action",
  methods: {
    ...common.methods,
    createProduct(args = {}) {
      return this.app._makeRequest({
        method: "POST",
        path: "/catalog/products",
        ...args,
      });
    },
    getRequestFn() {
      return this.createProduct;
    },
    getRequestFnArgs(args = {}) {
      return args;
    },
    getSummary(response) {
      return `Successfully created product with ID \`${response.data.id}\``;
    },
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
BigCommerce	`app`	`app`	This component uses the BigCommerce app.
Name	`name`	`string`	The product name. >= 1 characters <= 250 characters
Type	`type`	`string`	Select a value from the drop down menu:`physicaldigital`
SKU	`sku`	`string`	User defined product code/stock keeping unit (SKU). >= 0 characters <= 255 characters Example: SM-13
Description	`description`	`string`	The product description, which can include HTML formatting.
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
Width	`width`	`any`	Width of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Depth	`depth`	`any`	Depth of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Height	`height`	`any`	Height of the product, which can be used when calculating shipping costs. >= 0 and <= 9999999999
Price	`price`	`any`	The price of the product. The price should include or exclude tax, based on the store settings. >= 0
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
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
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
Map Price	`map_price`	`integer`	Minimum Advertised Price
Tax class id	`tax_class_id`	`integer`	Select a value from the drop down menu.
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
Categories	`categories`	`integer[]`	Select a value from the drop down menu.
Brand Id	`brand_id`	`integer`	Select a value from the drop down menu.
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
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
Inventory Tracking	`inventory_tracking`	`string`	Select a value from the drop down menu:`noneproductvariant`
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
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.
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.
Is Featured	`is_featured`	`boolean`	Flag to determine whether the product should be included in the featured products panel when viewing the store.
Related Products	`related_products`	`integer[]`	Select a value from the drop down menu.
Warranty	`warranty`	`string`	Warranty information displayed on the product page. Can include HTML formatting. >= 0 characters and <= 65535 characters
Bin picking number	`bin_picking_number`	`string`	The BIN picking number for the product. >= 0 characters and <= 255 characters
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
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
Seach keywords	`search_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
Availability	`availability`	`string`	Select a value from the drop down menu:`availabledisabledpreorder`
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
Gift wrapping options type	`gift_wrapping_options_type`	`string`	Select a value from the drop down menu:`anynonelist`
Gift wrapping options list	`gift_wrapping_options_list`	`string[]`	A list of gift-wrapping option IDs.
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
Condition	`condition`	`string`	Select a value from the drop down menu:`NewUsedRefurbished`
Is condition shown	`is_condition_shown`	`boolean`	Flag used to determine whether the product condition is shown to the customer on the product page.
Order quantity minimum	`order_quantity_minimum`	`integer`	The minimum quantity an order must contain, to be eligible to purchase this product. >= 0 and <= 1000000000
Order quantity maximum	`order_quantity_maximum`	`integer`	The maximum quantity an order can contain when purchasing the product. >= 0 and <= 1000000000
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
Meta keywords	`meta_keywords`	`string[]`	Custom meta keywords for the product page. If not defined, the store's default keywords will be used.
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
View count	`view_count`	`integer`	The number of times the product has been viewed. >= 0 and <= 1000000000
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.
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
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.
Is preorder hidden	`is_price_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.)
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
Open graph type	`open_graph_type`	`string`	Select a value from the drop down menu:`productalbumbookdrinkfoodgamemoviesongtv_show`
Open graph title	`open_graph_title`	`string`	Title of the product, if not specified the product name will be used instead.
Open graph description	`open_graph_description`	`string`	Description to use for the product, if not specified then the meta_description will be used instead.
Open graph use meta description	`open_graph_use_meta_description`	`boolean`	Flag to determine if product description or open graph description is used.
Open graph use product name	`open_graph_use_product_name`	`boolean`	Flag to determine if product name or open graph name is used.
Open graph use image	`open_graph_use_image`	`boolean`	Flag to determine if product image or open graph image is used.
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.
GTIN	`gtin`	`string`	Global Trade Item Number
MPN	`mpn`	`string`	Manufacturer Part Number
Reviews rating sum	`reviews_rating_sum`	`any`	The total rating for the product.
Reviews count	`reviews_count`	`integer`	The number of times the product has been rated.
Total sold	`total_sold`	`integer`	The total quantity of this product sold.
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

Authentication#

BigCommerce uses API keys for authentication. When you connect your BigCommerce account, Pipedream securely stores the keys so you can easily authenticate to BigCommerce APIs in both code and no-code steps.