Articles in this section

Available BigCommerce APIs

When you configure an export, import, or other type of flow step using the prebuilt BigCommerce connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the BigCommerce API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Abandoned cart Get an abandoned cart X  
Access tokens Create a payment access token   X
Brands v2 [deprecated] Create brand [deprecated]   X
Delete [deprecated]   X
Delete all [deprecated]   X
List of all brands [deprecated] X  
Single brand based on ID [deprecated] X  
Update brand [deprecated]   X
Cart items Add cart line items   X
Delete cart line item   X
Update cart line item   X
Cart redirect URL's Create cart redirect URL   X
Carts Create a cart   X
Delete a cart   X
Get a cart X  
Update customer ID   X
Catalog: Brands Create a brand   X
Delete a brand   X
Get a brand X  
List of all brands X  
Update a brand   X
Catalog: Brands metafields Create a brand metafields   X
Delete a brand metafields   X
Get a brand metafields   X
Catalog: Category Create a category   X
Delete a category   X
Get a category X  
Get category tree X  
List categories X  
Update a category   X
Catalog: Product bulk pricing rules Create a bulk pricing rule   X
Delete a bulk pricing rule   X
Get a bulk pricing rule X  
List bulk pricing rules X  
Update a bulk pricing rule   X
Catalog: Product complex rules Create a complex rule   X
Delete a complex rule   X
Get a complex rule X  
Get complex rules X  
Update a complex rule   X
Catalog: Product custom fields Create a custom fields   X
Delete a custom field   X
Get a custom field X  
List custom fields X  
Update a custom field   X
Catalog: Product image Get a product image X  
Get all product images X  
Catalog: Product images Create a product image   X
Delete a product image   X
Update a product image   X
Catalog: Product metafields Create a product metafield   X
Delete a product metafield   X
Get a product metafield X  
Get all product metafields X  
Update a product metafield   X
Catalog: Product modifier values Create modifier values   X
Delete a modifier value   X
Get a modifier value X  
Get all modifier values X  
Update a modifier values   X
Catalog: Product modifiers Create a product modifier   X
Delete a product modifier   X
Get a modifier X  
Get all product modifiers X  
Update a product modifier   X
Catalog: Product option values Create a product option values   X
Delete a product option value   X
Get a product option value X  
Get all product option values X  
Update a product option value   X
Catalog: Product options Create a product option   X
Delete a product option   X
Get a product option X  
Get all product options X  
Update a product option   X
Catalog: Product reviews Create a product review   X
Delete a product review   X
Get a product review X  
Get product reviews X  
Update a product review   X
Catalog: Product variants Create a product variant   X
Delete a product variant   X
Get a product variant X  
Get all product variants X  
Update a product variant   X
Catalog: Product variants metafields Create a product variant metafield   X
Delete a variant metafield   X
Get a product variant metafields X  
Get all product variant metafields X  
Update a product variant metafield   X
Catalog: Product videos Create a product video   X
Delete a product video   X
Get a product video X  
Get all product videos X  
Update a product video   X
Catalog: Products Create a product   X
Delete a product   X
Get a product X  
List products X  
Update a product   X
Catalog: Summary Get a catalog summary X  
Catalog: Variants Get all variants X  
Update variants   X
Catalog: Brand metafields Get a brand metafields X  
Get all brand metafields X  
Catalog: Category metafield Create a category metafield   X
Delete a category metafield   X
Get a category metafield X  
Get all category metafields X  
Update a category metafield   X
Channel currency assignments Create channel currency assignments   X
Create multiple channels currency assignments   X
Delete channel currency assignment   X
Get all assignments X  
Get channel assignments X  
Update channel currency assignments   X
Update multiple channels currency assignments   X
Channel listing Create channel listings   X
Get a channel listing X  
Get channel listing X  
Update channel listings   X
Channel site Create a channel site   X
Delete a channel site   X
Get a channel site X  
Update channel site   X
Channels Create a channel   X
Get a channel X  
Get channels X  
Update a channel   X
Checkout billing address Add checkout billing address   X
Update checkout billing address   X
Checkout consignments Add consignment to checkout   X
Delete checkout consignment   X
Update checkout consignment   X
Checkout coupons Add coupon to checkout   X
Update checkout coupon   X
Checkout order Create an order   X
Checkouts Get a checkout X  
Currency v2 Create a currency   X
Delete a currency   X
Delete multiple currencies   X
Get a currency X  
List currencies X  
Update a currency   X
Customer address Create a customer address   X
Delete a customer address   X
List customer addresses X  
Update a customer address   X
Customer attribute values Delete customer attribute values   X
Get all customer attribute values X  
Upsert customer attribute values   X
Customer attributes Create a customer attribute   X
Delete a customer attribute   X
Get all customer attributes X  
Update a customer attribute   X
Customer consent Get customer consent X  
Update customer consent   X
Customer form field values Get customer form field values X  
Upsert customer form field values   X
Customers Create customers   X
Delete customers   X
Get all customers X  
Update customers   X
Customers v2 Count of total no.of customers [deprecated] X  
Create a customer address [deprecated]   X
Create a customer groups   X
Create customer [deprecated]   X
Delete a customer [deprecated]   X
Delete a customer address [deprecated]   X
Delete a customer groups   X
Delete all customer [deprecated]   X
Delete all customer addresses [deprecated]   X
Delete all customer groups   X
Get a count of customer addresses [deprecated] X  
Get a count of customer groups X  
Get a customer address [deprecated] X  
Get a customer group X  
List customer addresses [deprecated] X  
List customer groups X  
List customers [deprecated] X  
Single customer based on ID [deprecated] X  
Update a customer address [deprecated]   X
Update a customer groups   X
Update customer [deprecated]   X
Geography v2 Get a country X  
Get a state X  
List countries X  
List states X  
Marketing v2 Create a banner   X
Create a coupon   X
Create a gift certificate   X
Delete a banner   X
Delete a coupon   X
Delete a gift certificate   X
Delete all banner   X
Delete all coupon   X
Delete all gift certificate   X
Get a banner X  
Get a count of coupons X  
Get a coupon X  
Get a gift certificate X  
List banners X  
List coupons X  
List gift certificates X  
Update a banner   X
Update a coupon   X
Update a gift certificate   X
Metafields Create metafield   X
Delete a metafield   X
Get metafields X  
Get metafields X  
Update metafields   X
Order refunds Create a refund   X
Create a refund quote   X
Get refunds for orders X  
Orders v2 Create an order   X
Create a shipment   X
Delete an order   X
Delete a shipment   X
Delete all orders   X
Delete all shipments   X
Get a count of order products X  
Get a count of order shipping address X  
Get a count of orders X  
Get a count of shipments X  
Get a count of shipments per order X  
Get a shipment X  
Get an order X  
Get an order coupon X  
Get an order message X  
Get an order products X  
Get an order shipping address X  
Get an order status X  
Get an order taxes X  
List order coupons X  
List order messages X  
List order products X  
List order shipping addresses X  
List order statuses X  
List order taxes X  
List orders X  
List shipments X  
Update order   X
Update shipment   X
Payment processing methods Get accepted payment methods X  
Payment v2 List payment methods X  
Placements Create a placement   X
Delete a placement   X
Get a placement X  
Get all placements X  
Update a placement   X
Price list records Delete a price list record   X
Delete a price record currency code   X
Get a price record by currency code X  
Get all price list records X  
Get price record by variant ID X  
Upsert price list records   X
Price lists Create a price list   X
Delete a price list   X
Get a price list X  
Get all price lists X  
Update a price list   X
Price lists assignment Create price list assignments   X
Delete price list assignment   X
Price lists assignments Get price lists assignments X  
Products Delete customs information   X
Update customs information   X
Products v2 [deprecated] Create a category [deprecated]   X
Create a custom field [deprecated]   X
Create a product bulk pricing rule [deprecated]   X
Create a product review [deprecated]   X
Create a product rule [deprecated]   X
Create a product SKU [deprecated]   X
Create an option [deprecated]   X
Create an option set [deprecated]   X
Create an option set option [deprecated]   X
Create an option value [deprecated]   X
Create product [deprecated]   X
Delete all categories [deprecated]   X
Delete all option [deprecated]   X
Delete all option set [deprecated]   X
Delete all products [deprecated]   X
Delete an option [deprecated]   X
Delete an option set [deprecated]   X
Delete an option set option [deprecated]   X
Delete an option value [deprecated]   X
Delete a product SKU [deprecated]   X
Delete category [deprecated]   X
Delete custom field [deprecated]   X
Delete multiple custom field [deprecated]   X
Delete multiple option set options [deprecated]   X
Delete multiple option value [deprecated]   X
Delete multiple product bulk pricing rules [deprecated]   X
Delete multiple product reviews [deprecated]   X
Delete multiple product rule [deprecated]   X
Delete multiple product SKU [deprecated]   X
Delete product [deprecated]   X
Delete product bulk pricing rules [deprecated]   X
Delete product reviews [deprecated]   X
Delete product rule [deprecated]   X
Get a category [deprecated] X  
Get a configurable field [deprecated] X  
Get a count of bulk pricing rules [deprecated] X  
Get a count of configurable fields [deprecated] X  
Get a count of custom fields [deprecated] X  
Get a count of option sets [deprecated] X  
Get a count of options [deprecated] X  
Get a custom field [deprecated] X  
Get a product [deprecated] X  
Get a product bulk pricing rule [deprecated] X  
Get a product option [deprecated] X  
Get a product review [deprecated] X  
Get a product rules [deprecated] X  
Get a product SKU [deprecated] X  
Get an option [deprecated] X  
Get an option set [deprecated] X  
Get an option set option [deprecated] X  
Get an option value [deprecated] X  
List bulk pricing rules [deprecated] X  
List categories [deprecated] X  
List configurable fields [deprecated] X  
List custom fields [deprecated] X  
List option set options [deprecated] X  
List option sets [deprecated] X  
List option values [deprecated] X  
List options [deprecated] X  
List product options [deprecated] X  
List product reviews [deprecated] X  
List product rules [deprecated] X  
List product SKUs [deprecated] X  
List products [deprecated] X  
Update a category [deprecated]   X
Update a custom field [deprecated]   X
Update a product bulk pricing rule [deprecated]   X
Update a product reviews [deprecated]   X
Update a product rule [deprecated]   X
Update a product SKU [deprecated]   X
Update an option [deprecated]   X
Update an option set [deprecated]   X
Update an option set option [deprecated]   X
Update an option value [deprecated]   X
Update product [deprecated]   X
Redirects Delete redirects   X
Get redirects X  
Upsert redirects   X
Scripts Create a script   X
Delete a script   X
Get a script X  
Get all scripts X  
Update a script   X
Settings: Storefront category Delete category   X
Get a banner X  
Get a category settings X  
Get a gift certificate X  
List banners X  
List gift certificates X  
Update a category settings   X
Shipping method v2 Create a shipping method   X
Delete a shipping method   X
Update a shipping method   X
Shipping methods v2 Get a shipping method X  
List shipping methods X  
Shipping zone v2 Create a shipping zone   X
Delete a shipping zone   X
Update a shipping zone   X
Shipping zones v2 Get a shipping zone X  
List shipping zones X  
Shipping: Products Get customs information X  
Site routes Create a site route   X
Delete a site route   X
Get a site route X  
Get a site's routes X  
Update a site route   X
Sites Create a site   X
Delete a site   X
Get a site X  
Get sites X  
Update a site   X
Store content v2 Create a blog post   X
Create a page [deprecated]   X
Create a redirect [deprecated]   X
Delete a blog post   X
Delete a page [deprecated]   X
Delete a redirect [deprecated]   X
Delete all blog post   X
Delete multiple redirects [deprecated]   X
Get a blog post X  
Get a count of blog posts X  
Get a count of redirects [deprecated] X  
Get a page [deprecated] X  
Get a redirect [deprecated] X  
List blog posts X  
List blog tags X  
List pages [deprecated] X  
List redirects [deprecated] X  
Update a blog post   X
Update a redirect [deprecated]   X
Store information v2 Get a store's information X  
Subscribers Create a subscriber   X
Delete a subscriber   X
Get a subscriber X  
Get subscribers X  
Update a subscriber   X
System v2 Get a timestamp X  
Tax class v2 Get a tax class X  
List tax classes X  
Theme action Activate a theme   X
Download a theme   X
Theme jobs Get a timestamp X  
Themes Get a theme X  
Get all themes X  
Transactions Get transactions X  
Webhooks Create a webhook   X
Delete a webhook   X
Get a webhook X  
Get webhooks X  
Update a webhook   X
Widget Create a widget   X
Delete a widget   X
Get a widget X  
Get all widgets X  
Update a widget   X
Widget: Templates Get all widget templates X  
Get an order X  
Widgets: Regions Get theme regions X  
Wishlists Get a wishlist X  
Get all wishlists X  
Wishlists items Add wishlist item   X
Delete wishlist item   X