v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Category specification

Get specifications tree by category ID

Lists all specifications including the current category and the level zero specifications from a category by its ID.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
CatalogContentGroups

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/catalog_system/pub/specification/field/listTreeByCategoryId/{categoryId}

Path parameters

categoryIdinteger required
Example:1

Category ID.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Namestring

Specification name. Limited to 100 characters.

CategoryIdinteger

Category ID.

FieldIdinteger

Specification field ID.

IsActiveboolean

Defines if the specification is active.

IsStockKeepingUnitboolean

Defines if it is an SKU specification.