How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BigCommerce Categories API

The Categories API from BigCommerce — 1 operation(s) for categories.

BigCommerce Categories API is one of 161 APIs that BigCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Categories. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 1 path, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 3.0.0.

Requests are made against a single base URL, https://api.bigcommerce.com/stores/{store_hash}/v3.

4 operations 1 paths 23 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

BigCommerce Categories API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (X-Auth-Token). By default, every request must be authenticated.

  • X-Auth-Token — OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | storev2informationreadonly| | Information & Settings | mo…

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Categories 4
GET
/catalog/trees/categories
BigCommerce Get All Categories
getAllCategories 19 params → 200400500
POST
/catalog/trees/categories
BigCommerce Create Categories
createCategories 2 params body → 201207400422500
PUT
/catalog/trees/categories
BigCommerce Update Categories
updateCategories 2 params body → 200207400422500
DELETE
/catalog/trees/categories
BigCommerce Delete Categories
deleteTreeCategories 5 params → 204400500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are CategoryBase (11 properties), ErrorBasic (3 properties), PartialSuccessResponse (3 properties), MetaData (3 properties). Each schema is shown below with its type and property counts.

MetaError
MetaData
object
3 properties
parent_id
integer
The unique numeric ID of the categoryʼs parent. This field controls where the category sits in the tree of categories that organize the catalog. Required in a…
PartialSuccessResponse
object
3 properties
ErrorResponse
object
2 properties
SuccessNoContentResponse
object
1 property
url
object
If not provided, the URL is autogenerated from the category name.
2 properties
ErrorBasic
object
3 properties
CreateCategories
array
PartialSuccessNoContentResponse
object
2 properties
tree_id
integer
The ID of the Category Tree.
CategoryBase
object
11 properties
category_uuid
string
An additional unique identifier for the category. Read-Only.
MetaPagination
object
1 property
ErrorAdditional
object
1 property
UpdateCategories
array
category_id
integer
Unique ID of the Category. Increments sequentially. Read-Only.
ErrorRequest
object
1 property
name
string
The name displayed for the category. Name is unique with respect to the categoryʼs siblings. Required in a POST.
SuccessResponse
object
2 properties
CategoryList
object
2 properties
DetailedErrors
object
Each key-value pair describes a failure or partial success case.
GetCategories

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bigcommerce-categories-api-openapi.yml Raw ↑

Other APIs BigCommerce publishes across the network.

Big Commerce Inventory
Big Commerce Locations
Big Commerce Customer Segmentation
Big Commerce Promotions
Big Commerce Promotion Settings
Big Commerce Pickup Methods
Big Commerce Storefront Pickup Options
Big Commerce Transactions
BigCommerce Abandoned Cart Emails API
BigCommerce Abandoned Cart Settings API
BigCommerce Abandoned Carts API
BigCommerce Abandoned Carts Settings API
Where this information came from

This is an independent, third-party profile of BigCommerce Categories API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.