APappdirect
Navigation

List all product tags

Changed on

This call lists all product groups (attributes, categories, and customer tags) that are used on your marketplace.

get/marketplace/v1/navigator

Request

Query parameters

plnumber[]

The IDs of the product line to filter on. This is an optional parameter

localestring

Specify the locale context

Response

Product tags information

categorySortOrder'MANUAL' | 'NONE'

Category sort order types

Example response

{
  "attributeGroups": [
    {
      "attribute": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ],
      "id": 12345,
      "name": "...",
      "showOnNavigation": true,
      "vendorTaggable": true
    },
    {
      "attribute": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ],
      "id": 12345,
      "name": "...",
      "showOnNavigation": true,
      "vendorTaggable": true
    }
  ],
  "categories": [
    {
      "id": 12345,
      "name": "...",
      "numTaggedProducts": 12345,
      "subCategories": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ]
    },
    {
      "id": 12345,
      "name": "...",
      "numTaggedProducts": 12345,
      "subCategories": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ]
    }
  ],
  "categorySortOrder": "NONE",
  "customerTagGroups": [
    {
      "customerTags": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ],
      "hideOnNavigation": true,
      "id": 12345,
      "name": "..."
    },
    {
      "customerTags": [
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        },
        {
          "id": 12345,
          "name": "...",
          "numTaggedProducts": 12345
        }
      ],
      "hideOnNavigation": true,
      "id": 12345,
      "name": "..."
    }
  ],
  "platforms": [
    {
      "attributeDefinition": [
        {
          "createdOn": 12345,
          "hint": "...",
          "isRequired": true,
          "key": "...",
          "label": "...",
          "lastModified": 12345,
          "option": [
            {},
            {}
          ],
          "order": 12345,
          "type": "...",
          "uuid": "..."
        },
        {
          "createdOn": 12345,
          "hint": "...",
          "isRequired": true,
          "key": "...",
          "label": "...",
          "lastModified": 12345,
          "option": [
            {},
            {}
          ],
          "order": 12345,
          "type": "...",
          "uuid": "..."
        }
      ],
      "createdOn": 12345,
      "description": "...",
      "iconUrl": "...",
      "isVersionSupported": true,
      "lastModified": 12345,
      "name": "...",
      "numTaggedProducts": 12345,
      "uuid": "..."
    },
    {
      "attributeDefinition": [
        {
          "createdOn": 12345,
          "hint": "...",
          "isRequired": true,
          "key": "...",
          "label": "...",
          "lastModified": 12345,
          "option": [
            {},
            {}
          ],
          "order": 12345,
          "type": "...",
          "uuid": "..."
        },
        {
          "createdOn": 12345,
          "hint": "...",
          "isRequired": true,
          "key": "...",
          "label": "...",
          "lastModified": 12345,
          "option": [
            {},
            {}
          ],
          "order": 12345,
          "type": "...",
          "uuid": "..."
        }
      ],
      "createdOn": 12345,
      "description": "...",
      "iconUrl": "...",
      "isVersionSupported": true,
      "lastModified": 12345,
      "name": "...",
      "numTaggedProducts": 12345,
      "uuid": "..."
    }
  ],
  "vendors": [
    {
      "name": "...",
      "uuid": "..."
    },
    {
      "name": "...",
      "uuid": "..."
    }
  ]
}

Changes