OrganizationId is read from your JWT claims.
List categories
Retrieve all categories for your organization. The response includes the full subcategory tree, so a single call gives you everything you need to render a navigation menu.Response
Array of root category objects. Each root category contains a nested
subCategories array.Example
List subcategories
Retrieve only the direct children of a specific parent category by passing the parent category’s name in the path.Path parameters
The name of the parent category whose subcategories you want to retrieve, e.g.
Widgets. Matching is case-insensitive.Response
Returns an array of category objects that are direct children of the specified parent.Example
Building a navigation tree
TheGET /api/categories response already returns the full nested tree, so for most storefront use cases you do not need to make multiple requests. Use the subCategories array to render each level of your menu recursively.
If you are building your own flat data structure (for example, for a faceted search sidebar), use the parentId field to reconstruct the hierarchy:
- Categories with
parentId: nullare root (top-level) categories. - Categories with a non-null
parentIdare children of that parent. - The
breadcrumbfield gives you a pre-built slash-delimited path string suitable for display or URL construction.
name in the category field when creating or updating a product.
Category images are served through Cloudflare CDN. The
imageUrl is constructed automatically from your OrganizationId and the category breadcrumb. You can upload a custom category image using the Images API.The category object
Nymble Commerce’s unique identifier for the category.
The organization this category belongs to.
Display name of the category.
Space-separated path from the root category to this one, e.g.
"Widgets Industrial Widgets". Useful for constructing URL slugs and breadcrumb navigation.The
id of this category’s parent. null for root categories.Whether the category is active and visible in the storefront.
CDN URL for the category’s image at medium resolution. Substitute
/medium with /small or /large for other sizes.Nested array of child category objects. Follows the same shape recursively.