Articles in this section

Supported BigCommerce APIs

When you configure an export, import, or another type of flow step using the form view designed for the BigCommerce connector, the following API operations are supported:

The following operations are available when you select v2 as the API version.
API Operation Export Import
Products [DEPRECATED] List Products [DEPRECATED] X  

Get a Product [DEPRECATED]

X  

List Categories [DEPRECATED]

X  

Get a Category [DEPRECATED]

X  

List Bulk Pricing Rules [DEPRECATED]

X  

Get a Product Bulk Pricing Rule [DEPRECATED]

X  

Get a Count of Bulk Pricing Rules [DEPRECATED]

X  

List Configurable Fields [DEPRECATED]

X  

Get a Configurable Field [DEPRECATED]

X  

Get a Count of Configurable Fields [DEPRECATED]

X  

List Custom Fields [DEPRECATED]

X  

Get a Custom Field [DEPRECATED]

X  

Get a Count of Custom Fields [DEPRECATED]

X  

List Options [DEPRECATED]

X  

Get an Option [DEPRECATED]

X  

Get a Count of Options [DEPRECATED]

X  

List Option Values [DEPRECATED]

X  

Get an Option Value [DEPRECATED]

X  

List Product Options [DEPRECATED]

X  

Get a Product Option [DEPRECATED]

X  

List Option Sets [DEPRECATED]

X  

Get an Option Set [DEPRECATED]

X  

Get a Count of Option Sets [DEPRECATED]

X  

List Option Set Options [DEPRECATED]

X  

Get an Option Set Option [DEPRECATED]

X  

List Product Reviews [DEPRECATED]

X  

Get a Product Review [DEPRECATED]

X  

List Product Rules [DEPRECATED]

X  

Get a Product Rules [DEPRECATED]

X  

List Product SKUs [DEPRECATED]

X  

Get a Product SKU [DEPRECATED]

X  

Create Product [DEPRECATED]

  X

Update Product [DEPRECATED]

  X

Create or Update Product [DEPRECATED]

  X

Delete Product [DEPRECATED]

  X

Delete All Products [DEPRECATED]

  X

Create a Product Bulk Pricing Rule [DEPRECATED]

  X

Update a Product Bulk Pricing Rule [DEPRECATED]

  X

Create or Update Product Bulk Pricing Rule [DEPRECATED]

  X

Delete Product Bulk Pricing Rules [DEPRECATED]

  X

Delete Multiple Product Bulk Pricing Rules [DEPRECATED]

  X

Create a Category [DEPRECATED]

  X

Update a Category [DEPRECATED]

  X

Create or Update Category [DEPRECATED]

  X

Delete Category [DEPRECATED]

  X

Delete All Category [DEPRECATED]

  X

Create a Custom Field [DEPRECATED]

  X

Update a Custom Field [DEPRECATED]

  X

Create or Update Custom Field [DEPRECATED]

  X

Delete Custom Field [DEPRECATED]

  X

Delete Multiple Custom Field [DEPRECATED]

  X

Create an Option [DEPRECATED]

  X

Update an Option [DEPRECATED]

  X

Create or Update Option [DEPRECATED]

  X

Delete an Option [DEPRECATED]

  X

Delete All Options [DEPRECATED]

  X

Create an Option Set [DEPRECATED]

  X

Update an Option Set [DEPRECATED]

  X

Create or Update Option Set [DEPRECATED]

  X

Delete an Option Set [DEPRECATED]

  X

Delete All Option Set [DEPRECATED]

  X

Create an Option Set Option [DEPRECATED]

  X

Update an Option Set Option [DEPRECATED]

  X

Create or Update Option Set Option [DEPRECATED]

  X

Delete an Option Set Option [DEPRECATED]

  X

Delete Multiple Option Set Options [DEPRECATED]

  X

Create an Option Value [DEPRECATED]

  X

Update an Option Value [DEPRECATED]

  X

Create or Update Option Value [DEPRECATED]

  X

Delete an Option Value [DEPRECATED]

  X

Delete Multiple Option Value [DEPRECATED]

  X

Create a Product Review [DEPRECATED]

  X

Update a Product Reviews [DEPRECATED]

  X

Create or Update Product Reviews [DEPRECATED]

  X

Delete Product Reviews [DEPRECATED]

  X

Delete Multiple Product Reviews [DEPRECATED]

  X

Create a Product Rule [DEPRECATED]

  X

Update a Product Rule [DEPRECATED]

  X

Create or Update Product Rule [DEPRECATED]

  X

Delete Product Rule [DEPRECATED]

  X

Delete Multiple Product Rule [DEPRECATED]

  X

Create a Product SKU [DEPRECATED]

  X

Update a Product SKU [DEPRECATED]

  X

Create or Update Product SKU [DEPRECATED]

  X

Delete a Product SKU [DEPRECATED]

  X

Delete Multiple Product SKU [DEPRECATED]

  X
Brands [DEPRECATED]

List of all Brands [DEPRECATED]

X  

Single Brand based on ID [DEPRECATED]

X  

Create [DEPRECATED]

  X

Update [DEPRECATED]

  X

Create or Update [DEPRECATED]

  X

Delete [DEPRECATED]

  X

Delete All [DEPRECATED]

  X
Store Content 

List Blog Posts

X  

Get a Blog Post

X  

Get a Count of  Blog Posts

X  

List Blog Tags

X  

List Pages [DEPRECATED]

X  

Get a Page [DEPRECATED]

X  

List Redirects [DEPRECATED]

X  

Get a Redirect [DEPRECATED]

X  

Get a Count of Redirects [DEPRECATED]

X  

Create a Blog Post

  X

Update a Blog Post

  X

Create or Update Blog Post

  X

Delete a Blog Post

  X

Delete All Blog Posts

  X

Create a Redirects [DEPRECATED]

  X

Update a Redirects [DEPRECATED]

  X

Create or Update Redirects [DEPRECATED]

  X

Delete a Redirects [DEPRECATED]

  X

Delete Multiple Redirects [DEPRECATED]

  X

Create a Page [DEPRECATED]

  X

Delete a Page [DEPRECATED]

  X
Currency

List Currencies

X  

Get a Currency

X  

Create a Currency

  X

Update a Currency

  X

Create or Update Currency

  X

Delete a Currency

  X

Delete Multiple currencies

X  
Customers

Single Customer based on ID [DEPRECATED]

X  

Count of Total no. of customers [DEPRECATED]

X  

List Customers [DEPRECATED]

X  

List Customer Addresses [DEPRECATED]

X  

Get a Customer Address [DEPRECATED]

X  

Get a Count of Customer Addresses [DEPRECATED]

X  

List Customer Groups

X  

Get a Customer Group

X  

Get a Count of Customer Groups

X  

Create Customer [DEPRECATED]

  X

Update Customer [DEPRECATED]

  X

Update Customer Group

   

Create or Update Customer [DEPRECATED]

  X

Delete a Customer [DEPRECATED]

  X

Delete All Customer [DEPRECATED]

  X

Create a Customer Groups

  X

Update a Customer Groups 

  X

Create or Update Customer Group 

  X

Delete a Customer Groups 

  X

Delete All Customer Groups

  X

Create a Customer Address [DEPRECATED]

  X

Update a Customer Address [DEPRECATED]

  X

Create or Update Customer Address [DEPRECATED]

  X

Delete a Customer Address [DEPRECATED]

  X

Delete All Customer Addresses [DEPRECATED]

  X
Geography

List Countries

X  

Get a Country

X  

List States

X  

Get a State

X  
Marketing

List Coupons

X  

Get a Coupon

X  

Get a Count of Coupons

X  

List Banners

X  

Get a Banner

X  

List Gift Certificates

X  

Get a Gift Certificate

X  

Create a Coupon

  X

Update a Coupon

  X

Create or Update Coupon

  X

Delete a Coupon

  X

Delete All Coupon

  X

Create a Banner

  X

Update a Banner

  X

Create or Update Banner

  X

Delete a Banner

  X

Delete All Banner

  X

Create a Gift Certificate

  X

Update a Gift Certificate

  X

Create or Update Gift Certificate

  X

Delete a Gift Certificate

  X

Delete All Gift Certificate

  X
Payment

List Payment Methods

X  
Shipping Zones

List Shipping Zones

X  

Get a Shipping Zone

X  

Create a Shipping Zone

  X

Update a Shipping Zone

  X

Create or Update Shipping Zone

  X

Delete a Shipping Zone

  X
Shipping Methods

List Shipping Methods

X  

Get a Shipping Method

X  

Create a Shipping Method

  X

Update a Shipping Method

  X

Create or Update Shipping Method

  X

Delete a Shipping Method

  X
Store Information

Get a Store's Information

X  
System

Get a Timestamp

X  
Tax Class

List Tax Classes

X  

Get a Tax Class

X  
Orders

List Orders

X  

Get an Order

X  

Get a Count of Orders

X  

List Order Coupons

X  

Get an Order Coupon

X  

List Order Messages

X  

Get an Order Message

X  

List Order Products

X  

Get an Order Products

X  

Get a Count of Order Products

X  

List Order Shipping Addresses

X  

Get an Order Shipping Address

X  

Get a Count of Order Shipping Address

X  

List Order Statuses

X  

Get an Order Status

X  

List Order Taxes

X  

Get an Order Taxes

X  

List Shipments

X  

Get a Shipment

X  

Get a Count of Shipments

X  

Get a Count of Shipments per Order

X  

Create an Order

  X

Update Order

  X

Create or Update Orders

  X

Delete an Order

  X

Delete All Orders

  X

Create a Shipment

  X

Update Shipment

  X

Create or Update Shipment

  X

Delete a Shipment

  X

Delete All Shipments

  X
Categories

List Categories [DEPRECATED]

X  

Get a Category [DEPRECATED]

X  
The following operations are available when you select v3 as the API version.
API Operation Export Import
Catalog: Brands

List of all Brands

X  

Get a Brand

X  

Create a Brand

  X

Update a Brand

  X

Create or Update Brand

  X

Delete a Brand

  X
Catalog: Brand Metafields

Get all Brand Metafields

X  

Get a Brand Metafields 

X  

Create a Brand Metafields

  X

Get a Brand Metafields

  X

Create or Update Brand Metafields

  X

Delete a Brand Metafields

  X
Catalog: Category Metafield

Get all Category Metafields

X  

Get a Category Metafield

X  

Create a Category Metafield

  X

Update a Category Metafield

  X

Create or Update Category Metafield

  X

Delete a Category Metafield

  X
Catalog: Products

List Products

X  

Get a Product

X  

Create a Product

  X

Update a Product

  X

Create or Update Product

  X

Delete a Product

  X
Catalog: Category

List Categories

X  

Get a Category

X  

Get Category Tree

X  

Create a Category 

  X

Update a Category

  X

Create or Update Category

  X

Delete a Category

  X
Catalog: Product Bulk Pricing Rules

List Bulk Pricing Rules

X  

Get a Bulk Pricing Rule

X  

Create a Bulk Pricing Rule

  X

Update a Bulk Pricing Rule

  X

Create or Update Bulk Pricing Rule

  X

Delete a Bulk Pricing Rule

  X
Catalog: Product Complex Rules

Get Complex Rules

X  

Get a Complex Rule

X  

Create a Complex Rule

  X

Update a Complex Rule

  X

Create or Update Complex Rule

  X

Delete a Complex Rule

  X
Catalog: Product Custom Fields

List Custom Fields

X  

Get a Custom Field

X  

Create a Custom Fields

  X

Update a Custom Field

  X

Create or Update Custom Field

  X

Delete a Custom Field

  X
Catalog: Product Image

Get all Product Images

X  

Get a Product Image

X  

Create a Product Image

  X

Update a Product Image

  X

Create or Update a Product Image

  X

Delete a Product Image

  X
Catalog: Product Metafields

Get all Product Metafields

X  

Get a Product Metafield

X  

Create a Product Metafield

  X

Update a Product Metafield

  X

Create or Update a Product Metafield

  X

Delete a Product Metafield

  X
Catalog: Product Modifier

Get all Product Modifiers

X  

Get a Modifier

X  

Create a Product Modifier

  X

Update a Product Modifier

  X

Create or Update a Product Modifier

  X

Delete a Product Modifier

  X
Catalog: Product Modifier Values

Get all Modifier Values

X  

Get a Modifier Value

X  

Create Modifier Values

  X

Update a Modifier Values

  X

Create or Update a Modifier Values

  X

Delete a Modifier Value

  X
Catalog: Product Options

Get all Product Options

X  

Get a Product Option

X  

Create a Product Option

  X

Update a Product Option

  X

Create or Update a Product Option

  X

Delete a Product Option

  X
Catalog: Product Option Values

Get all Product Option Values

X  

Get a Product Option Value

X  

Create a Product Option Values

  X

Update a Product Option Value

  X

Create or Update a Product Option Value

  X

Delete a Product Option Value

  X
Catalog: Product Reviews

Get Product Reviews

X  

Get a Product Review

X  

Create a Product Review

  X

Update a Product Review

  X

Create or Update a Product Review

  X

Delete a Product Review

  X
Catalog: Product Variants

Get all Product Variants

X  

Get a Product Variant

X  

Create a Product Variant

  X

Update a Product Variant

  X

Create or Update a Product Variant

  X

Delete a Product Variant

  X
Catalog: Product Variants Metafields

Get All Product Variant Metafields

X  

Get a Product Variant Metafields

X  

Create a Product Variant Metafield

  X

Update a Product Variant Metafield

  X

Create or Update a Product Variant Metafield

  X

Delete a Variant Metafield

  X
Catalog: Product Videos

Get all Product Videos

X  

Get a Product Video

X  

Create a Product Video

  X

Update a Product Video

  X

Create or Update a Product Video

  X

Delete a Product Video

  X
Catalog: Summary

Get a Catalog Summary

X  
Catalog: Variants

Get all Variants

X  

Update Variants

  X
Abandoned Cart

Get an Abandoned Cart

X  
Carts

Get a Cart

X  

Create a Cart

  X

Update Customer ID

  X

Create or Update Cart

  X

Delete a Cart

  X
Cart Items

Add Cart Line Items

  X

Update Cart Line Item

  X

Create or Update Cart Item

  X

Delete Cart Line Item

  X
Channels

Get Channels

X  

Get a channel

X  

Create a Channel

  X

Update a Channel

  X

Create or Update a Channel

  X
Channel Currency Assignments

Get all Assignments

X  

Get Channel Assignments

X  

Create Multiple Channels Currency Assignments

  X

Update Multiple Channels Currency Assignments

  X

Create or Update multiple channels currency assignments

  X

Create Channel Currency Assignments

  X

Update Channel Currency Assignments

  X

Create or Update Channel Currency Assignments

  X

Delete Channel Currency Assignment

  X
Channel Listing

Get Channel Listing

X  

Get a Channel Listing

X  

Create Channel Listings

  X

Update Channel Listings

  X

Create or Update Channel Listings

  X
Channel Site

Get a Channel Site

X  

Create a Channel Site

  X

Update Channel Site

  X

Create or Update the Channel site

  X

Delete a Channel Site

  X
Checkouts

Get a Checkout

X  
Checkout Billing Address

Add Checkout Billing Address

  X

Update Checkout Billing Address

  X

Create or Update Checkout Billing Address

  X
Checkout Consignments

Add Consignment to Checkout

  X

Update Checkout Consignment

  X

Create or Update Checkout Consignment

  X

Delete Checkout Consignment

  X
Checkout Coupons

Add Coupon to Checkout

  X

Update Checkout Coupon

  X
Checkout Order

Create an Order

  X
Customers

Get all Customers

X  

Create Customers

  X

Update Customers

  X

Create or Update Customer

  X

Delete Customers

  X
Customer Address

List Customer Addresses

X  

Create a Customer Address

  X

Update a Customer Address

  X

Create or Update Customer Address

  X

Delete a Customer Address

  X
Customer Attributes

Get all Customer Attributes

X  

Create a Customer Attributes

  X

Update a Customer Attributes

  X

Delete a Customer Attributes

  X
Customer Attribute Values

Get all Customer Attribute Values

X  

Update a Customer Attribute Values

  X

Delete Customer Attribute Values

  X
Customer Form Field Values

Get Customer Form Field Values

X  

Upsert Customer Form Field Values

  X
Customer Consent

Get Customer Consent

X  

Update Customer Consent

  X
Metafields

Get Metafields

X  

Get a Metafields

X  

Create Metafield

  X

Update Metafields

  X

Create or Update a Metafield

  X

Delete a Metafield

  X
Order Refunds

Get Refunds for Orders

X  

Create a Refund

  X

Create a Refund Quote

  X
Access Tokens

Create a Payment Access Token

  X
Transactions

Get Transactions

X  
Payment Processing Methods

Get Accepted Payment Methods

X  
Price Lists

Get all Price Lists

X  

Get a Price List

X  

Create a Price List

  X

Update a Price List

  X

Create or Update Price List

  X

Delete a Price List

  X
Price Lists Assignments

Get Price Lists Assignments

X  

Create price list assignments

  X

Delete Price List Assignment

  X
Price List Records

Get all Price List Records

X  

Get Price Record by Variant ID

X  

Get a Price Record by Currency Code

X  

Upsert Price List Records

  X

Delete a Price List Record

  X

Delete a Price Record Currency Code

  X
Redirects

Get Redirects

X  

Upsert Redirects

  X

Delete Redirects

  X
Cart Redirect URL's

Create Cart Redirect URL

  X
Scripts

Get all Scripts

X  

Get a Script

X  

Create a Script

  X

Update a Script

  X

Create or Update a Script

  X

Delete a Script

  X
Settings: Storefront Category

Update a Category Settings

  X

Delete Category

  X
Products

Update Customs Information

  X

Delete Customs Information

  X
Sites

Create a Site

  X

Update a Site

  X

Create or Update a Site

  X

Delete a Site

  X
Site Routes

Get a Site's Routes

X  

Get a Site Route

X  

Create a Site Route

  X

Update a Site Route

  X

Create or Update the Site's Routes

  X

Delete a Site Route

  X
Subscribers

Get Subscribers

X  

Get a Subscriber

X  

Create a Subscriber

  X

Update a Subscriber

  X

Create or Update a Subscriber

  X

Delete a Subscriber

  X
Themes

Get all Themes

X  

Get a Theme

X  
Theme Action

Download a Theme

  X

Activate a Theme

  X
Theme Jobs

Get a Timestamp

X  
Widgets: Regions

Get Theme Regions

X  
Widgets: Templates

Get all Widget Templates

X  

Get an Order

X  
Widget

Get all Widgets

X  

Get a Widget

X  

Create a Widget

  X

Update a Widget

  X

Create or Update a Widget

  X

Delete a Widget

  X
Placements

Get all placements

X  

Get a placements

X  

Create a Placement

  X

Update a Placement

  X

Create or Update a Placement

  X

Delete a Placement

  X
Wishlists

Get all wishlists

X  

Get a Wishlist

X  
Wishlists Items

Add Wishlist Item

  X

Delete Wishlist Item

  X
Webhooks

Get Webhooks

X  

Get a Webhook

X  

Create a Webhook

  X

Update a Webhook

  X

Create or Update a Webhook

  X

Delete a Webhook

  X
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.