Navlinks

Get all NavLinks for a store

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

node_idstringRequired

tag_idstring · flake-idRequiredExample: 411486491630370816

parent_node_idstring · nullableOptional

tag_slugstringRequired

namestringRequired

orderinteger · nullableOptional

default

Error response

application/json

get/v1/stores/{storeId}/navlinks

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/navlinks HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

[
  {
    "node_id": "text",
    "tag_id": "411486491630370816",
    "parent_node_id": null,
    "tag_slug": "text",
    "name": "text",
    "order": null
  }
]

Create a new NavLink for a store

post

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

tag_idstring · flake-idRequiredExample: 411486491630370816

parent_node_idstringOptional

orderinteger · nullableOptional

Responses

200

OK

application/json

node_idstringRequired

tag_idstring · flake-idRequiredExample: 411486491630370816

parent_node_idstring · nullableOptional

tag_slugstringRequired

namestringRequired

orderinteger · nullableOptional

default

Error response

application/json

post/v1/stores/{storeId}/navlinks

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/navlinks HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "tag_id": "411486491630370816",
  "parent_node_id": "text",
  "order": null
}

application/jsontext/jsonapplication/*+json

{
  "node_id": "text",
  "tag_id": "411486491630370816",
  "parent_node_id": null,
  "tag_slug": "text",
  "name": "text",
  "order": null
}

Get a NavLink by ID for a store

get

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

navLinkIdstring · flake-idRequiredExample: 411486491630370816

Responses

200

OK

application/json

node_idstringRequired

tag_idstring · flake-idRequiredExample: 411486491630370816

parent_node_idstring · nullableOptional

tag_slugstringRequired

namestringRequired

orderinteger · nullableOptional

default

Error response

application/json

get/v1/stores/{storeId}/navlinks/{navLinkId}

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/navlinks/{navLinkId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

{
  "node_id": "text",
  "tag_id": "411486491630370816",
  "parent_node_id": null,
  "tag_slug": "text",
  "name": "text",
  "order": null
}

Delete a NavLink for a store

delete

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

navLinkIdstring · flake-idRequiredExample: 411486491630370816

Responses

204

No Content

No content

default

Error response

application/json

delete/v1/stores/{storeId}/navlinks/{navLinkId}

HTTPcURLJavaScriptPython

DELETE /v1/stores/{storeId}/navlinks/{navLinkId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Accept: */*

No content

Update a NavLink By ID for a store

patch

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

navLinkIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

tag_idstring · flake-idOptionalExample: 411486491630370816

parent_node_idstringOptional

orderinteger · nullableOptional

Responses

200

OK

application/json

node_idstringRequired

tag_idstring · flake-idRequiredExample: 411486491630370816

parent_node_idstring · nullableOptional

tag_slugstringRequired

namestringRequired

orderinteger · nullableOptional

default

Error response

application/json

patch/v1/stores/{storeId}/navlinks/{navLinkId}

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/navlinks/{navLinkId} HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "tag_id": "411486491630370816",
  "parent_node_id": "text",
  "order": null
}

application/jsontext/jsonapplication/*+json

{
  "node_id": "text",
  "tag_id": "411486491630370816",
  "parent_node_id": null,
  "tag_slug": "text",
  "name": "text",
  "order": null
}

Update the sort orders of NavLinks for a Store

patch

Authorizations

APIKey

AuthorizationstringRequired

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

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Bodyobject · UpdateNavLinkOrderChangeDto[]

application/jsontext/jsonapplication/*+json

node_idstring · flake-idRequiredExample: 411486491630370816

orderinteger · int32Required

Responses

204

No Content

No content

default

Error response

application/json

patch/v1/stores/{storeId}/navlinks/sort-orders

HTTPcURLJavaScriptPython

PATCH /v1/stores/{storeId}/navlinks/sort-orders HTTP/1.1
Authorization: APIKey TOKEN_HERE
Content-Type: application/json
Accept: */*
Content-Length: 44

[
  {
    "node_id": "411486491630370816",
    "order": 1
  }
]

application/jsontext/jsonapplication/*+json

No content