Top Categories
==============

This service provides a list of top categories to be used with the categories service.
Top Categories provide various sorting, grouping and visibility options for
categories, part types and products

.. grid:: 2
    :margin: 0
    :padding: 0

    .. grid-item::
        :columns: 10

        .. code-block:: none
            :caption: Service Endpoint

            GET https://api.groupvan.com/v2_1/catalog/top_categories

    .. grid-item::
        :columns: 2

        .. button-link:: https://v21-groupvan-api.dev.groupvan.com/v2_1/docs#/Catalog/post_catalog_categories
            :color: success
            :shadow:

            Try it

Top Category Options
--------------------

By default, GroupLink provides two (2) top categories for application parts

- Main Categories
- Total Job

.. note::

    Additional application & non-application top categories may be returned
    depending on your account's configuration.

Requesting Top Categories
~~~~~~~~~~~~~~~~~~~~~~~~~

Start by sending a GET request to the service endpoint.

.. code-block:: json
    :caption: Example Response

    [
        {
            "id": 300000000,
            "name": "Total Job",
            "taxonomy": "app"
        },
        {
            "id": 300000001,
            "name": "Main Categories",
            "taxonomy": "app"
        },
        {
            "id": 300000002,
            "name": "Custom Categories",
            "taxonomy": "app"
        },
        {
            "id": 57,
            "name": "Commodities",
            "taxonomy": "non"
        }
    ]

The ``id`` and ``taxonomy`` of the desired **Top Category** will be used in
the :doc:`categories` service