storefront

Typed navigation tree for this storefront (categories + links + groups)

The storefront's full header navigation. Channels with a custom nav tree get it as authored (categories, links, and non-clickable groups); channels without one get their category tree in the same typed shape, so storefront code renders one contract either way.

get/api/v1/storefront/navigation

Request

  • Base URL: https://api.foundryims.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.foundryims.com/api/v1/storefront/navigation
  • Auth: HTTP bearer

Response

idstring required
type'CATEGORY' | 'LINK' | 'GROUP' required

CATEGORY nodes have a slug that resolves against /storefront/categories/:slug; LINK nodes carry an href for the storefront to render; GROUP nodes are non-clickable headings.

namestring required
slugstring nullable required
hrefstring nullable required
openInNewTabboolean required
positionnumber required

Sort order within siblings (lower = earlier). Nodes and children arrays are already returned in this order.

productCountnumber nullable required

CATEGORY nodes: number of products listed on this storefront under the node (its categories plus their descendants). Always ≥1 for returned nodes unless the node is kept only as a parent of non-empty children. null for LINK and GROUP nodes.

childrenStorefrontNavNodeDto[] required circular

Example response

[
  {
    "slug": "towing",
    "href": "/blog",
    "productCount": 42
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.