Articles in this section

Migrate your BigCommerce API v2 endpoints to v3

BigCommerce has deprecated some v2 APIs and their endpoints and replaced them with v3 APIs and endpoints. Even though you can use the existing endpoints, all BigCommerce administrators should migrate the existing endpoints to the new endpoints at the earliest opportunity.

Celigo will remove the deprecated endpoints in a future platform release when BigCommerce stops providing support/service to v2 APIs.

This article explains how to find deprecated endpoints in your existing flows and replace them with new endpoints.

Additional references:

  •  

BigCommerce replacement API names

The following table lists the deprecated API relative URLs:

Deprecated API relative URL Replacement
/v2/brands v3 Catalog Brands
/v2/customers v3 Customers
/v2/products v3 Catalog Products
/v2/categories Catalog v3 Categories
/v2/options

Catalog v3 Product Modifiers, Catalog v3 Product Variant Options. See the Accessing product options callout.

/v2/option_sets

Catalog v3 Product Modifiers, Catalog v3 Product Variant Options.

The option_sets endpoint is intentionally not available in the v3 Catalog API. For more information, see v2 vs v3 Catalog APIs.

/v2/redirects Redirects v3
/v2/pages Pages v3

Changes to make in integrator.io

A. Find the endpoints in the existing flows

To find an export/import that uses a BigCommerce connection:

  1. Sign in to your integrator.io account.
  2. Navigate to Resources > Connections.
  3. Search for an existing BigCommerce connection. From the Actions overflow ... menu, select Used by. A list of all items that use this connection appears.

Tip: Open each item in a separate tab so you don’t lose your place.

  1. Review the configuration for any of the deprecated endpoints and replace them with the endpoints provided in the table below.

B. Update flows to use replacement endpoints

Notes:
  • When you encounter a deprecated endpoint, first copy the path parameter and search parameter values from your export/import bubbles to a reference document as a backup when replacing the endpoint.
  • Find the import mappings of the deprecated endpoints and replace them with the latest.
  • Instead of v2 options, you can replace them with Catalog v3 Product Modifiers, Catalog v3 Product Variant Options. See the Accessing product options callout.
  • option_sets endpoint is intentionally not available in the v3 Catalog API. For more information, see v2 vs v3 Catalog APIs.

For each export/import that is using a deprecated API, find its corresponding replacement API in the chart below, and select the new API name and operation.

Deprecated (API version v2) Replacement (API version v3)

API name

API endpoint

API name

API endpoint

Brands Single Brand on ID Catalog: Brands Get a Brand
Create Create a Brand
Update Update a Brand
Create or Update Create or Update Brand
Delete Delete
Customers List Customers Customers Get all Customers
Create or Update Customer Create or Update Customer
Update Customer Update Customers
Create Customer Create Customers
Delete a Customer

Delete Customers

List Customer Addresses List Customer Addresses
Create a Customer Address Create a Customer Address
Products List all Products Catalog: Products List Product
Delete Product Delete a Product
Get a Product Get a Product
Create or Update Product Create or Update Product
Update Product Update a Product
Create Product Create a Product
Products List Options Catalog: Product Options Get all Product Options
Get an Option Get a Product Option
Create an Option Create a Product Option
Update an Option Update a Product Option
Create or Update Option Create or Update a Product Option
Delete Delete
Catalog: Product Modifiers Get all Product Modifiers
Get a Modifier
List Option Sets  
Get an Option Set  
Products

List Categories

Catalog: Category List Categories
Get a Category Get a Category
Create a Category Create a Category
Update a Category Update a Category
Create or Update Category Create or Update Category
Delete Category Delete a Category
Customers List Customer Addresses Customer Address List Customer Addresses
Create a Customer Address Create a Customer Address
Update a Customer Address Update a Customer Address
Create or Update Customer Address Create or Update Customer Address
Delete a Customer Address Delete a Customer Address
Store Content List Redirects Redirects Get Redirects
Get a Redirect Get Redirects
Create a Redirects Upsert Redirects
Update a Redirects Upsert Redirects
Create or Update Redirects Upsert Redirects
Delete a Redirects Delete Redirects

Find each export/import of the flows that use a BigCommerce connection; if it has the endpoint marked [Deprecated] follow the steps and update accordingly:

If the existing export is configured as follows:

  • API version: v2
  • API name: Brands
  • API endpoint: Single brand based on ID (DEPRECATED)
BG1.png Export used in the deprecated operation

Then, convert it according to the above table, as follows, and as shown in the images below:

  • API version: v3
  • API name: Catalog: Brands
  • API endpoint: Get a Brand
BG2.png Export used in the replacement operation
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.