Categories
==========

This service provides category and part type data

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

    .. grid-item::
        :columns: 10

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

            POST https://api.groupvan.com/v2_1/catalog/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

Application Categories
----------------------

Requests for application categories and part types require information from the
:doc:`vehicles` and :doc:`top-categories` services.

Parameters
~~~~~~~~~~

:code:`base_vehicle_id` :bdg:`integer` :bdg-danger:`required`
    Base Vehicle ID returned from :doc:`vehicles` service, engine :code:`configuration` object

:code:`engine_key_id` :bdg:`string`
    Engine Key ID returned from :doc:`vehicles` service, engine :code:`configuration` object if
    fully qualified engine is selected

:code:`top_category_id` :bdg:`integer` :bdg-danger:`required`
    Top Category ID selected from the :doc:`top-categories` service

:code:`taxonomy` :bdg:`string` :bdg-danger:`required`
    Taxonomy of the top category selected

:code:`respponse_items` :bdg:`array` :bdg-danger:`required`
    Array of strings "top_category" and/or "category"

Examples
~~~~~~~~

.. code-block:: json 
    :caption: Example Request w/ engine selected

    {
        "base_vehicle_id": 18664,
        "engine_key_id": "18664_905_7492",
        "top_category_id": 300000000,
        "taxonomy": "app"
    }

.. code-block:: json
    :caption: Example Request w/o engine selected

    {
        "base_vehicle_id": 18664,
        "top_category_id": 300000000,
        "taxonomy": "app"
    }

Non-Application Categories
--------------------------

Requests for non-application categories and products require information from the
:doc:`top-categories` service.

Parameters
~~~~~~~~~~

:code:`top_category_id` :bdg:`integer` :bdg-danger:`required`
    Top Category ID selected from the :doc:`top-categories` service

:code:`taxonomy` :bdg:`string` :bdg-danger:`required`
    Taxonomy of the top category selected

Examples
~~~~~~~~

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

    {
        "top_category_id": 57,
        "taxonomy": "non"
    }

Response
~~~~~~~~

.. dropdown:: Response JSON

    .. code-block:: json

        {
            "categories": [
                {
                    "display_tier": "primary",
                    "id": 32,
                    "name": "A/C Compressor Replacement",
                    "part_types": [
                        {
                            "display_tier": "primary",
                            "id": 10459,
                            "name": "A/C Accumulator",
                            "popularity_group": 1,
                            "slang_list": [
                                "a/c",
                                "accum",
                                "accumulator",
                                "acum",
                                "acumulator",
                                "air conditioning",
                                "air conditionning",
                                "climate",
                                "compresor",
                                "compressor",
                                "condenser",
                                "drier",
                                "dryer",
                                "receiver drier",
                                "temperature"
                            ]
                        },
                        {
                            "display_tier": "primary",
                            "id": 6628,
                            "name": "A/C Compressor",
                            "popularity_group": 313290,
                            "slang_list": [
                                "a/c",
                                "ac compressor",
                                "accum",
                                "accumulator",
                                "acum",
                                "acumulator",
                                "air conditioning",
                                "air conditionning",
                                "climate",
                                "compresor",
                                "compressor",
                                "condenser",
                                "drier",
                                "dryer",
                                "new compressor",
                                "temperature"
                            ]
                        }
                    ]
                },
                {
                    "display_tier": "primary",
                    "id": 33,
                    "name": "A/C Condenser Replacement",
                    "part_types": [
                        {
                            "display_tier": "primary",
                            "id": 10459,
                            "name": "A/C Accumulator",
                            "popularity_group": 0,
                            "slang_list": [
                                "a/c",
                                "accum",
                                "accumulator",
                                "acum",
                                "acumulator",
                                "air conditioning",
                                "air conditionning",
                                "climate",
                                "compresor",
                                "compressor",
                                "condenser",
                                "drier",
                                "dryer",
                                "receiver drier",
                                "temperature"
                            ]
                        },
                        {
                            "display_tier": "primary",
                            "id": 6768,
                            "name": "A/C Evaporator Core",
                            "popularity_group": 0,
                            "slang_list": [
                                "a/c",
                                "air conditioning",
                                "air conditionning",
                                "climate",
                                "control",
                                "evap",
                                "evaporator",
                                "temperature"
                            ]
                        }
                    ]
                }
            ]
        }