The email of the customer. Must be unique.

The first name of the customer.

The last name of the customer.

The company of the customer.

The phone number of the customer.

The IP address from which this customer was registered.

The customer notes.

The tax exempt category code for the customer.

ID of the group which this customer belongs to.

The unique numeric ID of the customer.

If true, this customer will be forced to change password on next login.

New password for customer.

It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.

Values must be separated by a comma.

Channel ID of the customer that has created the form.

Arrays of channels the customer can access. Values must be separated by a comma.

The form field name. Values must be separated by a comma.

Values must be separated by a comma.

API docs for BigCommerce are located here https://developer.bigcommerce.com/api/

Requests can only be made to domains associated by this application.

These params will be URL-encoded and appended to the URL when making the request.

Authentication headers are included automatically

Zapier will apply these optional headers and values to the request in addition to any headers created as part of the authentication mechanism.

Zapier will pass this along raw. If you would like to provide complex JSON, try a "Code by Zapier" step to build the structure and pass it along here. For example, {"foo": "bar"} is perfectly valid.

The email of the customer. Must be unique.

The company of the customer.

The unique numeric ID of the customer.

Filter customers by customer group.

The first name of the customer.

The last name of the customer.

The phone number of the customer.

The IP address from which this customer was registered.

The customer notes.

The tax exempt category code for the customer.

ID of the group which this customer belongs to.

If true, this customer will be forced to change password on next login.

New password for customer.

It determines if the customer is signed up to receive either product review or abandoned cart emails or receive both emails.

Values must be separated by a comma.

Channel ID of the customer that has created the form.

Arrays of channels the customer can access. Values must be separated by a comma.

The form field name. Values must be separated by a comma.

Values must be separated by a comma.

The product name.

User defined product code/stock keeping unit (SKU).

Filter items by ID.

The product type. One of: physical - a physical stock unit, digital - a digital download.

The product description, which can include HTML formatting.

Weight of the product, which can be used when calculating shipping costs. This is based on the unit set on the store.

Width of the product, which can be used when calculating shipping costs.

Depth of the product, which can be used when calculating shipping costs.

Height of the product, which can be used when calculating shipping costs.

The price of the product. The price should include or exclude tax, based on the store settings.

The cost price of the product. Stored for reference only; it is not used or displayed anywhere on the store.

The retail cost of the product. If entered, the retail cost price will be shown on the product page.

If entered, the sale price will be used instead of value in the price field when calculating the product’s cost.

Minimum Advertised Price

The ID of the tax class applied to the product.

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.

An array of IDs for the categories to which this product belongs.

Current inventory level of the product.

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.

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.

A fixed shipping cost for the product. If defined, this value will be used during checkout instead of normal shipping-cost calculation.

Flag used to indicate whether the product has free shipping. If true, the shipping cost for the product will be zero

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.

Flag to determine whether the product should be included in the featured products panel when viewing the store.

An array of IDs for the related products.

Warranty information displayed on the product page. Can include HTML formatting.

The BIN picking number for the product.

The layout template file used to render this product category. This field is writable only for stores with a Blueprint theme applied. For stores with a Stencil theme applied, see Custom Template Associations.

The product UPC code, which is used in feeds for shopping comparison sites and external channel integrations.

A comma-separated list of keywords that can be used to locate the product when searching the store.

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.'

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.

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.

A list of gift-wrapping option IDs.

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.

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.

Flag used to determine whether the product condition is shown to the customer on the product page.

The minimum quantity an order must contain, to be eligible to purchase this product.

The maximum quantity an order can contain when purchasing the product.

Custom title for the product page. If not defined, the product name will be used as the meta title.

Custom meta keywords for the product page. If not defined, the store's default keywords will be used.

Custom meta description for the product page. If not defined, the store's default meta description will be used.

The number of times the product has been viewed.

Pre-order release date. See the availability field for details on setting a product's availability to accept pre-orders.

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.

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.

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.).

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.).

Product URL on the storefront.

Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

Type of product, defaults to product.

Title of the product, if not specified the product name will be used instead.

Description to use for the product, if not specified then the meta_description will be used instead.

Flag to determine if product description or open graph description is used.

Flag to determine if product name or open graph name is used.

Flag to determine if product image or open graph image is used.

Global Trade Item Number.

Manufacturer Part Number.

The total (cumulative) rating for the product.

The number of times the product has been rated.

The total quantity of this product sold.

The unique numeric ID of the custom field. Must be separated by commas

The name of the field, shown on the storefront, orders, etc. Must be separated by commas

The value of the field, requested on the storefront, orders, etc. Must be separated by commas

Unique ID of the Bulk Pricing Rule. Must be separated by commas

The minimum inclusive quantity of a product to satisfy this rule. Must be separated by commas

The maximum inclusive quantity of a product to satisfy this rule. Must be separated by commas

The type of adjustment that is made. Must be separated by commas

The discount can be a fixed dollar amount or a percentage. Must be separated by commas

The local path to the original image file uploaded to BigCommerce. Must be separated by commas

Flag for identifying whether the image is used as the product's thumbnail. Must be separated by commas

The order in which the image will be displayed on the product page. Higher integers give the image a lower priority. When updating, if the image is given a lower priority, all images with a sort_order the same as or greater than the image's new sort_order value will have their sort_orders reordered. Must be separated by commas

The description for the image. Must be separated by commas

Must be a fully qualified URL path, including protocol. Must be separated by commas

The unique numeric ID of the image. Must be separated by commas

The unique numeric identifier for the product with which the image is associated. Must be separated by commas

The zoom URL for this image. By default, this is used as the zoom image on product pages when zoom images are enabled. Must be separated by commas

The standard URL for this image. By default, this is used for product-page images. Must be separated by commas

The thumbnail URL for this image. By default, this is the image size used on the category page and in side panels. Must be separated by commas

The tiny URL for this image. By default, this is the image size used for thumbnails beneath the product image on a product page. Must be separated by commas

The date on which the product image was modified. Must be separated by commas

The title for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas

The description for the video. If left blank, this will be filled in according to data on a host site. Must be separated by commas

The order in which the video will be displayed on the product page. Must be separated by commas

The video type (a short name of a host site). Must be separated by commas

The ID of the video on a host site. Must be separated by commas

The unique numeric ID of the product video; increments sequentially. Must be separated by commas

The unique numeric identifier for the product with which the image is associated. Must be separated by commas

Length of the video. This will be filled in according to data on a host site. Must be separated by commas

The cost price of the variant. Not affected by Price List prices. Must be separated by commas

This variant’s base price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s default price (set in the Product resource’s price field) will be used as the base price. Must be separated by commas

This variant’s sale price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s sale price (set in the Product resource’s price field) will be used as the sale price. Must be separated by commas

This variant’s retail price on the storefront. If a Price List ID is used, the Price List value will be used. If a Price List ID is not used, and this value is null, the product’s retail price (set in the Product resource’s price field) will be used as the retail price. Must be separated by commas

This variant’s base weight on the storefront. If this value is null, the product’s default weight (set in the Product resource’s weight field) will be used as the base weight. Must be separated by commas

Width of the variant, which can be used when calculating shipping costs. If this value is null, the product's default width (set in the Product resource's width field) will be used as the base width. Must be separated by commas

Height of the variant, which can be used when calculating shipping costs. If this value is null, the product's default height (set in the Product resource's height field) will be used as the base height. Must be separated by commas

Depth of the variant, which can be used when calculating shipping costs. If this value is null, the product's default depth (set in the Product resource's depth field) will be used as the base depth. Must be separated by commas

Flag used to indicate whether the variant has free shipping. If true, the shipping cost for the variant will be zero. Must be separated by commas

A fixed shipping cost for the variant. If defined, this value will be used during checkout instead of normal shipping-cost calculation. Must be separated by commas

If true, this variant will not be purchasable on the storefront. Must be separated by commas

If purchasing_disabled is true, this message should show on the storefront when the variant is selected. Must be separated by commas

The UPC code used in feeds for shopping comparison sites and external channel integrations. Must be separated by commas

Inventory level for the variant, which is used when the product’s inventory_tracking is set to variant. Must be separated by commas

When the variant hits this inventory level, it is considered low stock. Must be separated by commas

Identifies where in a warehouse the variant is located. Must be separated by commas

Must be separated by commas

Must be separated by commas

Title of this blog post.

URL for the public blog post.

Text body of the blog post.

Whether the blog post is published.

Description text for this blog post’s <meta/> element

Keywords for this blog post’s <meta/> element

Name of the blog post’s author

Local path to a thumbnail uploaded to /product_images/ via WebDav

Tags to characterize the blog post. Must be separated by comma

Example: Wed, 10 Aug 2022 15:39:15 -0500

The first name of the customer address.

The last name of the customer address

The company of the customer address

The address 1 line

The address 2 line

The city of the customer address

The state or province name spelled out in full. It is required for countries that need a state/province to complete an address. State or province codes not accepted.

The postal code of the customer address. It is required for countries that need postal codes to complete an address.

The country code of the customer address.

The phone number of the customer address

The address type. Residential or Commercial.

The customer ID

The unique numeric ID of the address.

The country name of the customer address

If you have required address form fields they will need to be set as optional before creating an order with the API.

If you have required address form fields they will need to be set as optional before creating an order with the API.

Filter customers by email.

Filter customers by company.

Filter customers by id.

Filter customers by customer group.

Filter items by name.

Filter items by main SKU.

Filter items by ID.

The company of the customer address

The first name of the customer address.

The last name of the customer address

The address 1 line

The address 2 line

The city of the customer address

The state or province name spelled out in full. It is required for countries that need a state/province to complete an address. State or province codes not accepted.

The postal code of the customer address. It is required for countries that need postal codes to complete an address.

The country code of the customer address.

The phone number of the customer address

The address type. Residential or Commercial.

The customer ID

The unique numeric ID of the address.

The country name of the customer address

If you have required address form fields they will need to be set as optional before creating an order with the API.

If you have required address form fields they will need to be set as optional before creating an order with the API.