Skip to main content
New Pages Integration

BigCommerce Category Page Integration with Similar AI

Use the BigCommerce REST API and Python SDK to create category pages, assign products, and connect your store to Similar AI.

Robin AllensonBy Robin Allenson, CEO & Co-Founder
Request a Demo

How It Works

We use the official BigCommerce Python package to manage your category pages. The approach is straightforward:

  • -We create an invisible parent category page. All remaining pages are nested underneath it.
  • -Instead of publishing an app to the BigCommerce app store, we ask you to create an API token and share the credentials with us directly.

For the full onboarding flow, see the New Page onboarding checklist.

1

Create an API Token

  1. Go to Settings → Store-level API accounts.
  2. Click Create API account.
  3. For Token type, select V2/V3 API token.
  4. Fill in the account name.
  5. In the OAuth scopes section, change the Products scope from None to modify. This is required because creating category pages needs modify permissions.
  6. Click Save.
  7. Share the following three values with Similar AI: API Path, Client ID, and Access Token.
2

List All Products

Verify your API token works by fetching the product catalog. Replace dd02dnjzrx with your store ID and include your token in the X-Auth-Token header.

GET https://api.bigcommerce.com/stores/{store_id}/v3/catalog/products

Headers:
  X-Auth-Token: your-access-token
  Content-Type: application/json

If you receive a 200 response with your product list, the token is working correctly.

3

Create the Parent Category Page

Create an invisible parent category that will hold all Similar AI pages. Send a POST request to the categories endpoint:

POST https://api.bigcommerce.com/stores/{store_id}/v3/catalog/trees/categories

Body:
[
  {
    "name": "SimilarPage",
    "url": {
      "path": "/s-test-page/",
      "is_customized": false
    },
    "parent_id": 0,
    "tree_id": 1,
    "description": "<p>Category description</p>",
    "sort_order": 3,
    "page_title": "Similar Test Page",
    "meta_keywords": ["keyword1", "keyword2"],
    "meta_description": "string",
    "layout_file": "category.html",
    "is_visible": true,
    "default_product_sort": "use_store_settings"
  }
]
  • -parent_id: 0 - places this category at the top level of your catalog tree.
  • -tree_id: 1 - targets your default catalog tree. Check your store if you use multiple trees.
  • -is_visible: true - set to false if you want to hide the parent page from navigation.

Save the category ID from the response. You will need it in the next step.

4

Create Child Category Pages

Use the same endpoint to create child pages. Replace parent_id with the category ID returned in the previous step.

POST https://api.bigcommerce.com/stores/{store_id}/v3/catalog/trees/categories

Body:
[
  {
    "name": "Child Page Name",
    "url": {
      "path": "/s-test-page/child-page/",
      "is_customized": false
    },
    "parent_id": 123,
    "tree_id": 1,
    "description": "<p>Child category description</p>",
    "page_title": "Child Page Title",
    "meta_keywords": ["keyword1", "keyword2"],
    "meta_description": "Child page meta description",
    "layout_file": "category.html",
    "is_visible": true,
    "default_product_sort": "use_store_settings"
  }
]

Repeat this call for each child page you need. All child pages nest under the parent category created in step 3.

5

Assign Products to Category Pages

Once your category pages exist, assign products to them using a PUT request to the category-assignments endpoint:

PUT https://api.bigcommerce.com/stores/{store_id}/v3/catalog/products/category-assignments

Body:
[
  {
    "product_id": 456,
    "category_id": 123
  },
  {
    "product_id": 789,
    "category_id": 123
  }
]
  • -product_id - the ID of the product you want to assign. Use the product list from step 2 to find IDs.
  • -category_id - the ID of the parent or child category page where the product should appear.

You can assign multiple products in a single request by adding more objects to the array.

Ready to Connect BigCommerce with Similar AI?

We handle the API integration for you. Share your credentials and we will have your new pages live within days.

Request a Demo