Subcategories - Resolved

Returns the organization's effective subcategory set: every custom subcategory the org has created, unioned with every global (canonical) subcategory. Each row is tagged type: custom | canonical and carries isExcluded, isShadowed, and the shownInProductDropdown rollup. With no parameters only rows where shownInProductDropdown is true are returned, which is the set a product picker should offer. Use id + type from this response when assigning a subcategory on product create/update: customSubCategoryId for custom rows, productSubCategoryId for canonical rows.

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

Limited Release

General Availability expected late Q3 '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 (canonicals that are shadowed by a custom, and 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