Subcategories - Resolved

Every element is one of the organization's custom subcategories or one canonical subcategory; a custom shares productSubCategoryId with the canonical it maps to, and a canonical stays pickable beside its customs. The default response is the pickable set only - includeExcluded adds the excluded canonicals, includeDeleted adds soft-deleted customs. includeProductCounts adds productCount, counted direct-only: a custom element counts the products assigned to that custom and a canonical element counts only the products still on the bare canonical with no custom assigned, so a canonical and its customs never double-count and the two can be summed. The count costs an aggregate query, so ask for it only when the caller reads it. productCategoryId scopes the whole response to one category. A flag is enabled by the exact value true - every other value, 1 and TRUE included, reads as false.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🟡

Limited Release

General Availability expected Q4 '26

Path Params
string
required
Defaults to v3
Query Params
string

Scope the list to one product category. Required when includeProductCounts is true.

boolean

Also return rows hidden from the picker (excluded canonicals).

boolean

Add productCount (direct assignments only) to each row. Requires productCategoryId.

boolean

Also return soft-deleted custom subcategories as display-only rows flagged deleted: true, so a stored id can still be labelled.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json