Volkswagen

opencollection: 1.0.0
info:
  name: Volkswagen OKAPI - Open Konfigurator API
  version: v3
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Catalog
    type: folder
  items:
  - info:
      name: List Available Countries
      type: http
    http:
      method: GET
      url: https://productdata.volkswagenag.com/v3/countries
    docs: Returns all countries for which OKAPI offers vehicle configuration support. Each country has an ISO 3166-2 market
      identifier used in subsequent catalog calls.
  - info:
      name: List Brands By Country
      type: http
    http:
      method: GET
      url: https://productdata.volkswagenag.com/v3/catalog/:countryCode/brands
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
    docs: Returns all VW Group brands available in the specified country market.
  - info:
      name: List Models By Brand
      type: http
    http:
      method: GET
      url: https://productdata.volkswagenag.com/v3/catalog/:countryCode/brands/:brandId/models
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      - name: brandId
        value: ''
        type: path
        description: Brand UUID identifier.
    docs: Returns all vehicle models available for a specific brand in a country.
  - info:
      name: List Types By Model
      type: http
    http:
      method: GET
      url: https://productdata.volkswagenag.com/v3/catalog/:countryCode/models/:modelId/types
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      - name: modelId
        value: ''
        type: path
        description: Model UUID identifier.
    docs: Returns all vehicle types (trim levels, engine variants) for a specific model.
  - info:
      name: List Options By Type
      type: http
    http:
      method: GET
      url: https://productdata.volkswagenag.com/v3/catalog/:countryCode/types/:typeId/options
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      - name: typeId
        value: ''
        type: path
        description: Vehicle type UUID identifier.
    docs: Returns all configurable options for a vehicle type, including exterior colors, interior colors, wheels, radio,
      packages, and service guarantees.
- info:
    name: Configuration
    type: folder
  items:
  - info:
      name: Check Configuration Buildability
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/check
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Validates whether a given set of selected options forms a buildable vehicle configuration. Returns conflict information
      if options are incompatible.
  - info:
      name: Recover Buildable Configuration
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/recover
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Given an unbuildable configuration, returns the nearest valid buildable configuration by resolving conflicts between
      selected options.
  - info:
      name: Get Configuration Options
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/configure
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Returns available options and choices for the current vehicle configuration, showing which options are selectable,
      unavailable, or required given current selections.
  - info:
      name: Resolve Configuration
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/resolve
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Completes a partial configuration by resolving ambiguities and returning the fully distinct configuration with all
      options specified.
- info:
    name: Information
    type: folder
  items:
  - info:
      name: Get WLTP Emissions Data
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/wltp
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Retrieves WLTP (Worldwide Harmonised Light Vehicles Test Procedure) fuel consumption and CO2 emissions data for
      a vehicle configuration.
  - info:
      name: Get Configuration Images
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/images
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: Returns URLs for vehicle images that correspond to the specified configuration, showing the vehicle with the selected
      exterior color, wheels, and other visual options.
  - info:
      name: Get Order Information
      type: http
    http:
      method: POST
      url: https://productdata.volkswagenag.com/v3/operation/:countryCode/order
      params:
      - name: countryCode
        value: ''
        type: path
        description: ISO 3166-2 market identifier (e.g. DE, AT, GB, US).
      body:
        type: json
        data: '{}'
    docs: 'Returns comprehensive order information for a configuration: current options, price, standard equipment list, and
      full technical specifications.'
bundled: true