v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates a Category in the BigCommerce Catalog.

post/catalog/categories

Request body

parent_idinteger

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.

namestring

The name displayed for the category. Name is unique with respect to the category's siblings.

descriptionstring

The product description, which can include HTML formatting.

viewsinteger

Number of views the category has on the storefront.

sort_orderinteger

Priority this category will be given when included in the menu and category pages. The lower the number, the closer to the top of the results the category will be.

page_titlestring

Custom title for the category page. If not defined, the category name will be used as the meta title.

search_keywordsstring

A comma-separated list of keywords that can be used to locate the category when searching the store.

meta_keywordsstring[]

Custom meta keywords for the category page. If not defined, the store's default keywords will be used. Must post as an array like: ["awesome","sauce"].

meta_descriptionstring

Custom meta description for the category page. If not defined, the store's default meta description will be used.

layout_filestring

The layout template file used to render this category.

is_visibleboolean

Flag to determine whether the product should be displayed to customers browsing the store. If true, the category will be displayed. If false, the category will be hidden from view.

default_product_sort'use_store_settings' | 'featured' | 'newest' | 'best_selling' | 'alpha_asc' | 'alpha_desc' | 'avg_customer_review' | 'price_asc' | 'price_desc'

Determines how the products are sorted on category page load.

image_urlstring

Image URL used for this category on the storefront. Images can be uploaded via form file post to /categories/{categoryId}/image, or by providing a publicly accessible URL in this field.

Response

A category object.

metaMeta

Empty meta object; may be used later.