Products
############

Query Products and Fitment 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/products

    .. grid-item::
        :columns: 2

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

            Try it

Request
-------

...

Parameters
~~~~~~~~~~

``part_types`` :bdg:`array` :bdg-danger:`required`
        An array of part types selected by the user. Returned by the :doc:`categories` service
    
    ``id`` :bdg:`integer` :bdg-danger:`required`
        ID of the part type

    ``name`` :bdg:`string` :bdg-danger:`required`
        Name of the part type

``configuration`` :bdg:`object` :bdg-danger:`required`
    The vehicle configuration object returned by the :doc:`vehicles` service when selecting a vehicle

    ``base_vehicle_id`` :bdg:`integer`
        Base Vehicle ID

    ``make_id`` :bdg:`integer`
        The ID of the vehicle's make 

    ``make_name`` :bdg:`string`
        The name of the vehicle's make 

    ``model_id`` :bdg:`integer`
        The ID of the vehicle's model 

    ``model_name`` :bdg:`string`
        The name of the vehicle's model 

    ``region_ids`` :bdg:`array`
        The region IDs the vehicle is available in
    
    ``year_id`` :bdg:`integer`
        The year of the vehicle 

``show_all`` :bdg:`integer`
    Brand display preferences. `0` default - primary brands. `1` - secondary brands

Examples
~~~~~~~~

.. code-block:: json

    {
        "part_types": [
            {
                "id": 1684,
                "name": "Disc Brake Pad Set"
            }
        ],
        "configuration": {
            "base_vehicle_id": 145155,
            "make_id": 74,
            "make_name": "Volkswagen",
            "model_id": 960,
            "model_name": "Jetta",
            "region_ids": [
                1,
                2,
                3
            ],
            "year_id": 2018
        },
        "show_all": 0
    }


Response
~~~~~~~~

.. dropdown:: Response JSON

    .. code-block:: json

        [
            {
                "attribute_families": [
                    {
                        "key": "aspiration_ids",
                        "name": "Aspiration",
                        "options": [
                            {
                                "id": 6,
                                "name": "Turbocharged"
                            }
                        ]
                    },
                    {
                        "key": "enginebase_ids",
                        "name": "EngineBase",
                        "options": [
                            {
                                "id": 2041,
                                "name": "2.5L L5"
                            },
                            {
                                "id": 6046,
                                "name": "1.4L L4"
                            },
                            {
                                "id": 5827,
                                "name": "1.8L L4"
                            },
                            {
                                "id": 975,
                                "name": "2.0L L4"
                            }
                        ]
                    },
                    {
                        "key": "enginedesignation_ids",
                        "name": "EngineDesignation",
                        "options": [
                            {
                                "id": 4996,
                                "name": "CPLA"
                            },
                            {
                                "id": 5061,
                                "name": "CPKA"
                            },
                            {
                                "id": 5065,
                                "name": "CPRA"
                            },
                            {
                                "id": 4997,
                                "name": "CPPA"
                            },
                            {
                                "id": 15477,
                                "name": "CZTA"
                            }
                        ]
                    },
                    {
                        "key": "fueltype_ids",
                        "name": "FuelType",
                        "options": [
                            {
                                "id": 5,
                                "name": "GAS"
                            }
                        ]
                    },
                    {
                        "key": "position_ids",
                        "name": "Position",
                        "options": [
                            {
                                "id": 30,
                                "name": "Rear"
                            },
                            {
                                "id": 22,
                                "name": "Front"
                            }
                        ]
                    },
                    {
                        "key": "submodel_ids",
                        "name": "SubModel",
                        "options": [
                            {
                                "id": 857,
                                "name": "GLI"
                            },
                            {
                                "id": 938,
                                "name": "Wolfsburg Edition"
                            },
                            {
                                "id": 744,
                                "name": "SEL"
                            },
                            {
                                "id": 743,
                                "name": "SE Sport"
                            },
                            {
                                "id": 141,
                                "name": "Sport"
                            },
                            {
                                "id": 49,
                                "name": "SE"
                            },
                            {
                                "id": 1,
                                "name": "S"
                            }
                        ]
                    }
                ],
                "brands": [
                    {
                        "code": "AKE",
                        "name": "Akebono"
                    },
                    {
                        "code": "BRM",
                        "name": "Brembo"
                    },
                    {
                        "code": "SPF",
                        "name": "EVS Friction"
                    },
                    {
                        "code": "SIS",
                        "name": "Silent Stop Friction"
                    },
                    {
                        "code": "SSR",
                        "name": "SST Friction"
                    }
                ],
                "part_type_id": 1684,
                "part_type_name": "Disc Brake Pad Set",
                "parts": [
                    {
                        "applications": [
                            {
                                "assets": false,
                                "display": [
                                    {
                                        "name": "EngineBase",
                                        "value": "1.4L L4"
                                    },
                                    {
                                        "name": "MfrLabel",
                                        "value": "PRIME Low-Met"
                                    },
                                    {
                                        "name": "Note",
                                        "value": "Replaced by P85020"
                                    },
                                    {
                                        "name": "Position",
                                        "value": "Rear"
                                    },
                                    {
                                        "name": "Qty",
                                        "value": "1"
                                    },
                                    {
                                        "name": "YearRange",
                                        "value": "2015-2018"
                                    }
                                ],
                                "id": -7442424667
                            },
                            {
                                "assets": false,
                                "display": [
                                    {
                                        "name": "EngineBase",
                                        "value": "1.8L L4"
                                    },
                                    {
                                        "name": "MfrLabel",
                                        "value": "PRIME Low-Met"
                                    },
                                    {
                                        "name": "Note",
                                        "value": "Replaced by P85020"
                                    },
                                    {
                                        "name": "Position",
                                        "value": "Rear"
                                    },
                                    {
                                        "name": "Qty",
                                        "value": "1"
                                    },
                                    {
                                        "name": "YearRange",
                                        "value": "2015-2018"
                                    }
                                ],
                                "id": -7442423553
                            },
                            {
                                "assets": false,
                                "display": [
                                    {
                                        "name": "EngineBase",
                                        "value": "2.0L L4"
                                    },
                                    {
                                        "name": "MfrLabel",
                                        "value": "PRIME Low-Met"
                                    },
                                    {
                                        "name": "Note",
                                        "value": "Replaced by P85020"
                                    },
                                    {
                                        "name": "Position",
                                        "value": "Rear"
                                    },
                                    {
                                        "name": "Qty",
                                        "value": "1"
                                    },
                                    {
                                        "name": "YearRange",
                                        "value": "1997-2018"
                                    }
                                ],
                                "id": -7442410240
                            }
                        ],
                        "auto_care_brand_id": "BBHN",
                        "buyers_guide": true,
                        "interchange": true,
                        "mfr_code": "BRM",
                        "mfr_name": "Brembo",
                        "parent_part_type_id": 1684,
                        "part_number": "P61088",
                        "part_type_id": 1684,
                        "part_type_name": "Disc Brake Pad Set",
                        "product_info": true,
                        "rank": 7,
                        "sku": 4154453,
                        "tier": 1
                    }
                ],
                "shadows": [
                    "Disc Brake Pad Set"
                ]
            }
        ]