The Guide


The Product data catalog

The product data catalog provides static data about supported countries, available models, types and options. OKAPI provides several endpoints to filter and retrieve these static data.

List all countries

GET
https://api.productdata.vwgroup.com/v3/countries
Authorization Bearer {access_token}
Accept application/json

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/countries \
-H "Authorization: bearer <access_token>" \
-H "Accept: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": [
{
"countryCode": "BE",
"name": "Belgium"
},
{
"countryCode": "CH",
"name": "Switzerland"
}
],
"meta": {}
}

List all brands

GET
https://api.productdata.vwgroup.com/v3/catalog/{country_code}/brands
Authorization Bearer {access_token}
Accept application/json

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/catalog/CH/brands \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": [
{
"brand_id": "d3f207e5-18d8-5bd2-a5fa-a1acc05629fa",
"name": "Volkswagen PKW"
}
],
"meta": {}
}

List all models

GET
https://api.productdata.vwgroup.com/v3/catalog/{country_code}/brands/{brand_id}/models
Authorization Bearer {access_token}
Accept application/json

By brand and country

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/catalog/DE/brands/d3f207e5-18d8-5bd2-a5fa-a1acc05629fa/models \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": [
{
"id": "ef7f7c23-2537-5067-9c0b-25f77433a1de",
"name": "The up!",
"code": "30450_30100"
},
{
"id": "8cd99132-b085-5188-88fb-b7e3a86a336f",
"name": "Der Polo",
"code": "30100_30203"
},
{
"id": "146a91a8-954f-520e-bb56-22ebbcb8a6d3",
"name": "Der neue T-Cross",
"code": "30100_30250"
},
{
"id": "54ae5960-4c6e-5a50-9f36-c88ab444db21",
"name": "Der Golf",
"code": "30100_30315"
}
],
"meta": {}
}

List all types by brand

GET
https://api.productdata.vwgroup.com/v3/catalog/{country_code}/brands/{brand_id}/types
Authorization Bearer {access_token}
Accept application/json

By country and brand

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/catalog/DE/brands/d3f207e5-18d8-5bd2-a5fa-a1acc05629fa/types \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": [
{
"id": "8632ad57-6147-54ce-a3a8-d7285373f257",
"name": "high up!(#) 1.0(#) 55 kW(#) 5-Gang(#)",
"base_type": "1224DV",
"model_year": "2019",
"version": "1",
"code": "TYPE:1224DV-GYOIYOI,"
"extensions": ["
{
"id": "d0876daf-1f03-5c62-b683-149cba339e7c",
"category": "PACKET",
"code": "YOI",
"description": "Volkwagen Connect"
}
]
}
],
"meta": {}
}

List the types of a model

GET
https://api.productdata.vwgroup.com/v3/catalog/{country_code}/models/{model_id}/types
Authorization Bearer {access_token}
Accept application/json

By country and model

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/catalog/DE/models/127b6237-08ca-54d4-895f-0d23e654257b/types \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"data": [
{
"id": "8277133f-963a-584a-815d-1a92bbfa4574",
"name": "(#) DC Highline(#) 3.0 V6 TDI EU6 SCR 4MO BMT(#) 150 kW(#) AG8-Gang(#)",
"base_type": "S6BC6A",
"model_year": "2019",
"version": "1",
"code": "TYPE:S6BC6A-MAHLEX1-GWF2WF2-GZSBZSB-MVBK1T9-MVZU6B4,"
"extensions": ["
{
"id": "2b7759a4-32ce-5aa7-9ff1-0f2570b05186",
"category": "AHL",
"code": "EX1",
"description": "Anhängelast 3.500 kg"
}
]
}
],
"meta": {}
}

List the options of a type

GET
https://api.productdata.vwgroup.com/v3/catalog/{country_code}/types/{type_id}/options
Authorization Bearer {access_token}
Accept application/json

By type

Toggle arrow Example Request with cURL

Request
curl \
-X GET https://api.productdata.vwgroup.com/v3/catalog/DE/types/5569f72a-a076-5a3d-8147-9d81f59d1ec6/options \
-H "Authorization: bearer <access_token>" \
-H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "data": [
        {
            "type": {
                "id": "5569f72a-a076-5a3d-8147-9d81f59d1ec6",
                "description": "Audi S4 Limousine  TDI  255(347) kW(PS) tiptronic",
                "basetype_code": "BASETYPE:8WCSTA",
                "code": "TYPE:8WCSTA",
                "version": "0",
                "price": 62600,
                "currency": "EUR",
                "modelyear_code": "MODELYEAR:2020",
                "brand_id": "c65e5000-a5e0-5556-89e9-172a33f8f344",
                "brand_code": "AU",
                "brand_description": "Audi",
                "model_id": "00e5daf7-602f-5a7c-9d98-2b6e017dd706",
                "model_code": "MODEL:50000_35435",
                "model_description": "S4 / S4 Avant",
                "tag_groups": [
                    {
                        "tags": [
                            {
                                "tag_type": "salesGroup",
                                "code": "SALESGROUP:50500",
                                "description": "Audi S4 Limousine"
                            }
                        ]
                    }
                ]
            },
            "options": [
                {
                    "id": "20f391ea-1b17-5a47-87a5-eec053e064dd",
                    "description": "Kraftstoffbehälter mit erhöhtem Füllvolumen (für quattro)",
                    "category": "KBV",
                    "code": "KBV:0M2",
                    "tag_groups": [
                        {
                            "tags": [
                                {
                                    "tag_type": "salesFamily",
                                    "code": "891",
                                    "description": "24. Technik/Sicherheit"
                                },
                                {
                                    "tag_type": "label",
                                    "code": "810",
                                    "description": "Sonderausstattungen"
                                }
                            ]
                        },
                        {
                            "tags": [
                                {
                                    "tag_type": "label",
                                    "code": "900",
                                    "description": "Serienausstattung"
                                }
                            ]
                        }
                    ],
                    "classification": "STANDARD_EQUIPMENT"
                },
                {
                    "id": "7786d0cc-9fae-5a5c-be5f-d3714c65ce46",
                    "description": "Heckklappenspoiler in Carbon",
                    "category": "PACKET",
                    "code": "PACKET:YKA",
                    "price": 950,
                    "currency": "EUR",
                    "tag_groups": [
                        {
                            "tags": [
                                {
                                    "tag_type": "salesFamily",
                                    "code": "803",
                                    "description": "26. Designpakete Audi Original Zubehör"
                                },
                                {
                                    "tag_type": "label",
                                    "code": "810",
                                    "description": "Sonderausstattungen"
                                }
                            ]
                        }
                    ],
                    "classification": "OPTIONAL_EQUIPMENT"
                },
            ],
    "meta": {
        "count": 1
    }
}