Navlinks

Get navlinks

get

Retrieves the store's navlink structure used for navigation.

Authorizations

APIKey & Customer

AuthorizationstringOptional

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

AuthorizationstringOptional

A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.

Header parameters

x-paynow-store-idstring · flake-idRequired

PayNow Store Identifier (Store ID) available in Store Settings

Responses

200

OK

application/json

Represents a navigation link in the storefront's hierarchical navigation structure.

node_idstringRequired

The unique identifier for this navigation node in the navigation tree.

parent_node_idstring · nullableOptional

The identifier of the parent navigation node, if this is a child node.

tag_idstring · flake-idRequiredExample: 411486491630370816

tag_slugstringRequired

The URL-friendly slug for the tag associated with this navigation link.

Example: perks

tag_querystring[]Required

A list containing all parent tags and this node's tag, representing the complete path in the tag hierarchy.

Example: ["perks","vip"]

namestringRequired

The display name of the associated tag shown to users in the UI.

Example: Perks

orderinteger · int32Required

The display order of this navigation link relative to its siblings.

default

Error response

application/json

get

/v1/store/navlinks

HTTPcURLJavaScriptPython

GET /v1/store/navlinks HTTP/1.1
Authorization: YOUR_API_KEY
x-paynow-store-id: text
Accept: */*

[
  {
    "node_id": "text",
    "parent_node_id": null,
    "tag_id": "411486491630370816",
    "tag_slug": "perks",
    "tag_query": [
      "perks",
      "vip"
    ],
    "name": "Perks",
    "order": 1,
    "children": [
      {
        "node_id": "text",
        "parent_node_id": null,
        "tag_id": "411486491630370816",
        "tag_slug": "perks",
        "tag_query": [
          "perks",
          "vip"
        ],
        "name": "Perks",
        "order": 1,
        "children": [
          {
            "node_id": "text",
            "parent_node_id": null,
            "tag_id": "411486491630370816",
            "tag_slug": "perks",
            "tag_query": [
              "perks",
              "vip"
            ],
            "name": "Perks",
            "order": 1,
            "children": "[Circular Reference]"
          }
        ]
      }
    ]
  }
]