openapi: 3.0.0
info:
  description: This document describes Autopass V1 endpoints.
  version: 1.0.0
  title: Legacy
servers:
  - url: https://api.autopass.pro
    description: Live server
    x-environment: live
  - url: https://api-prelive.autopass.pro
    description: Prelive server
    x-environment: prelive
paths:
  /vehicule:
    get:
      summary: Get a vehicle
      description: Provides a custom set of information regarding a vehicle.
      operationId: legacy-get-vehicle
      parameters:
        - $ref: "#/components/parameters/reg_or_vin"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/reg_plate"
        - $ref: "#/components/parameters/reg_country"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
      tags:
        - vehicule
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/VehiculeResponse"
                  - $ref: "#/components/schemas/VehiculeErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /v1/catalog:
    get:
      summary: Get a catalog
      description: This API relies on an expert system of different algorithms to provide the right OE reference. This allows on one hand to cover different vehicle markets; on the other hand, it improves our catalog knowledge.
      operationId: legacy-get-catalog
      parameters:
        - $ref: "#/components/parameters/reg_or_vin"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/reg_plate"
        - $ref: "#/components/parameters/reg_country"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
        - $ref: "#/components/parameters/plan"
        - $ref: "#/components/parameters/product_category"
        - $ref: "#/components/parameters/product_family"
      tags:
        - catalog
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CatalogResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /reference:
    get:
      summary: Search for references
      description: It provides for a given search a list of matching OE & AM references among AM providers from your spectrum (your offer) AND AM providers out of your spectrum (alternative offer).
      operationId: legacy-list-references
      parameters:
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
        - name: search
          in: query
          required: true
          description: Reference to look for.
          schema:
            type: string
        - name: brand_id
          in: query
          required: false
          description: Reference brand ID to Filters on.
          schema:
            type: string
      tags:
        - reference
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/ReferenceResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /v1/fluid:
    get:
      summary: Get fluids
      description: Gets fluids for a vehicle.
      operationId: legacy-get-fluids
      parameters:
        - $ref: "#/components/parameters/reg_or_vin"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/reg_plate"
        - $ref: "#/components/parameters/reg_country"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
      tags:
        - fluid
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/FluidResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /v1/tire:
    get:
      summary: List tire sizes
      description: List approved tire sizes for a vehicle.
      operationId: legacy-list-tire-sizes
      parameters:
        - $ref: "#/components/parameters/reg_or_vin"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/reg_plate"
        - $ref: "#/components/parameters/reg_country"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
        - $ref: "#/components/parameters/plan_tire"
      tags:
        - tire
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/TireResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /v1/paint:
    get:
      summary: List paints
      description: This new API Paint allows to get paint color codes compatible with a vehicle. It returns a color chart composed by color codes known for the brand and the model of the called vehicle. There are two packages. **pro** The API returns a color chart with colors where their main color is the same as the vehicule's color and the manufacturer is not called; **pro_plus** The API returns a color chart like the pro package but the manufacturer can be called if we don't have enough informations about the vehicle's color.
      operationId: legacy-list-paint-color-codes
      parameters:
        - $ref: "#/components/parameters/reg_or_vin"
        - $ref: "#/components/parameters/vin"
        - $ref: "#/components/parameters/reg_plate"
        - $ref: "#/components/parameters/reg_country"
        - $ref: "#/components/parameters/country"
        - $ref: "#/components/parameters/company"
        - $ref: "#/components/parameters/entity"
        - $ref: "#/components/parameters/activities"
        - $ref: "#/components/parameters/plan_paint"
      tags:
        - paint
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/PaintResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
        422:
          description: Unprocessable content.
  /common/application:
    get:
      summary: List applications
      description: List applications.
      operationId: legacy-list-applications
      parameters:
        - in: query
          name: application_id
          description: Filters on given application_id
          schema:
            type: string
        - in: query
          name: family_id
          description: Filters on given family_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonApplicationResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/family:
    get:
      summary: List families
      description: List families.
      operationId: legacy-list-families
      parameters:
        - in: query
          name: family_id
          description: Filters on given family_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonFamilyResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/equip:
    get:
      summary: List equipment manufacturers
      description: List aftermarket equipment manufacturers.
      operationId: legacy-list-equips
      parameters:
        - in: query
          name: equip_id
          description: Filters on given equip_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonEquipResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/energy:
    get:
      summary: List energies
      description: List the most used energies.
      operationId: legacy-list-energies
      parameters:
        - in: query
          name: energy_id
          description: Filters on given energy_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonEnergyResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/gearbox:
    get:
      summary: List gearboxes
      description: List the most used gearboxes.
      operationId: legacy-list-gearboxes
      parameters:
        - in: query
          name: gearbox_id
          description: Filters on given gearbox_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonGearboxResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/body:
    get:
      summary: List bodies
      description: List the most used bodies.
      operationId: legacy-list-bodies
      parameters:
        - in: query
          name: body_id
          description: Filters on given body_id
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonBodyResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
  /common/ktypnr:
    get:
      summary: List KTypnrs
      description: List KTypnrs mapping a source.
      operationId: legacy-list-ktypnrs
      parameters:
        - in: query
          name: from
          description: Mapping source.
          schema:
            type: string
            enum:
              - ktypnr
              - natcode
              - hsntsn
              - cnit
        - in: query
          name: id
          description: From given (mapping) source, filters on given id.
          schema:
            type: string
      tags:
        - common
      responses:
        200:
          description: OK.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: "#/components/schemas/CommonKtypnrResponse"
                  - $ref: "#/components/schemas/ErrorResponse"
        403:
          description: Forbidden.
        401:
          description: Unauthorized.
security:
  - ApiKeyAuth: []
  - ApiKeyHeader: []
  - ApiKeyQuery: []
  - BearerAuth: []
components:
  securitySchemes:
    ApiKeyQuery:
      type: apiKey
      in: query
      name: access_token
    ApiKeyHeader:
      type: apiKey
      in: header
      name: X-Access-Token
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  parameters:
    vt_id:
      type: string
      nullable: true
      example: 872634
      description: Vehicle technical ID.
    ktypnr:
      anyOf:
        - type: string
          nullable: true
        - type: integer
          nullable: true
      example: 115681
      description: Vehicle KTypNR Tecdoc provided by the registration provider. This is the most probable KTypNR if more than one is listed into ktypnr_list.
    ktypnr_list:
      description: List of KTypNR Tecdoc codes provided by registration provider.
      anyOf:
        - type: string
          nullable: true
        - type: array
          nullable: true
          items:
            oneOf:
              - type: string
              - type: integer
            example: 115681
    brand:
      type: string
      nullable: true
      description: Vehicle brand.
      example: OPEL
    model:
      type: string
      nullable: true
      description: Vehicle model.
      example: INSIGNIA
    version:
      type: string
      nullable: true
      description: Vehicle version.
    date_pme:
      type: string
      nullable: true
      description: First registration date.
      example: 2003-02-27
    reg_plate_lookup:
      type: boolean
      nullable: true
      description: Notifies if a registration plate lookup was done.
      example: false
    manufacturer_lookup:
      type: boolean
      nullable: true
      description: Notifies if a manufacturer lookup was done.
      example: false
    tires_lookup:
      type: boolean
      nullable: true
      description: Notifies if a tires lookup was done.
      example: false
    paint_lookup:
      type: boolean
      nullable: true
      description: Notifies if a paint lookup was done.
      example: false
    mask:
      type: string
      nullable: true
      description: The mask parameter as it was provided.
      example: ALL
    code:
      type: string
      nullable: true
      description: This is the return code. Possible values are "OK" or "ERROR".
      example: OK
    error_code:
      type: integer
      nullable: true
      description: This is internal error code. 0 if no error.
      example: 0
    reg_or_vin:
      name: reg_or_vin
      in: query
      required: true
      description: This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.
      schema:
        type: string
        nullable: true
    vin:
      name: vin
      in: query
      required: true
      description: This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.
      schema:
        type: string
        nullable: true
    reg_plate:
      name: reg_plate
      in: query
      required: true
      description: This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.
      schema:
        type: string
        nullable: true
    reg_country:
      name: reg_country
      in: query
      required: true
      description: This parameter specifies the country where the car has been registered. This could be different from the country from which the request is made. For instance when repairing a car registered in Italy in a workshop in France. This is an ISO 3166-1 alpha-2 code. If not specified, the value used is the same as the parameter country.
      schema:
        type: string
        nullable: true
    country:
      name: country
      in: query
      required: false
      description: This parameter specifies the country in which the response is calculated. This influence some AM references selection and more generally triggers country specific offers in terms of brands. country must be ISO 3166-1 alpha-2. Note that this is not the language but the country.
      schema:
        default: FR
        type: string
        nullable: true
    company:
      name: company
      in: query
      required: false
      description: User company. Could be used to specify the company or one of its department calling the API. This is typically the highest level of the hierarchy. This parameter is returned but has no influence on the result.
      schema:
        type: string
        nullable: true
    entity:
      name: entity
      in: query
      required: false
      description: User entity. Could be used to identify a specific workshop or an agent calling the API. This is usually the lowest level in the hierarchy. Using it is recommended to identify uniquely the caller. This parameter is returned but has no influence on the result.
      schema:
        type: string
        nullable: true
    activities:
      name: activities
      in: query
      required: false
      description: User activities. Could be used in a transversal way to identify qualities / specific characteristics of the caller. For instance the type of activities covered by the workshop. This parameter is returned but has no influence on the result.
      schema:
        type: string
        nullable: true
    plan:
      name: plan
      in: query
      description: >
        Possible plans:
          * **pro** basic response where we focus on lowest response time (approximately 0.8s).
      required: true
      explode: true
      schema:
        type: string
        nullable: true
        enum:
          - pro
    plan_tire:
      name: plan
      in: query
      description: >
        Possible plans: 
         * **pro** The API returns approved sizes of tires for the called vehicle with no manufacturer call
      required: true
      explode: true
      schema:
        type: string
        nullable: true
        enum:
          - pro
          - pro_plus
    plan_paint:
      name: plan
      in: query
      description: >
        Possible plans:
          * **pro** The API returns a color char composed by color codes known for the brand and the model of the called vehicle with no manufacturer call
          * **pro_plus** The API returns a color chart with a manufacturer call if we don't have enough information about the vehicle
      required: true
      explode: true
      schema:
        type: string
        nullable: true
        enum:
          - pro
          - pro_plus
    product_category:
      name: product_category
      in: query
      description: Product category ID that group a list of families to focus/Filters on (This parameter could be customized by user).
      required: false
      explode: true
      schema:
        type: integer
        nullable: true
    product_family:
      name: product_family
      in: query
      description: Family ID to focus/Filters on.
      required: true
      explode: true
      schema:
        type: integer
        nullable: true
    ktypnr_completion:
      name: ktypnr_completion
      in: query
      description: >
        Enables to complete missing references (from offer) using AM references linked to ktypnr linked to vehicle. Possible values are:
          * **Y** completion is activated and default rules are applied
          * **N** completion is deactivated
          * **DEFAULT** completion is activated and default rules are applied
          * **NO_RULE** completion is activated and no rule is applied
      required: false
      style: form
      explode: true
      schema:
        type: string
        nullable: true
        default: N
        enum:
          - Y
          - N
          - DEFAULT
          - NO_RULE
    energy_id:
      type: string
      nullable: true
      example: 10
      description: Energy ID.
    energy_name:
      type: string
      nullable: true
      example: ESS+G.P.L.
      description: Energy name.
    body_id:
      type: string
      nullable: true
      example: 10
      description: Body ID.
    body_name:
      type: string
      nullable: true
      example: Break
      description: Body name.
    gearbox_id:
      type: string
      nullable: true
      example: 10
      description: Gearbox ID.
    gearbox_name:
      type: string
      nullable: true
      example: AUTOMATIQUE
      description: Gearbox name.
    application_id:
      oneOf:
        - type: string
          nullable: true
        - type: integer
          nullable: true
      example: 517
      description: Application ID.
    position_name:
      type: string
      nullable: true
      example: AR G/D
      description: Position name.
    family_id:
      oneOf:
        - type: string
          nullable: true
        - type: integer
          nullable: true
      example: 260
      description: Family ID.
    family_name:
      type: string
      nullable: true
      example: Disque de frein
      description: Family name.
    group_id:
      type: string
      nullable: true
      example: 13
      description: Group (family) ID.
    group_name:
      type: string
      nullable: true
      example: Freinage
      description: Group (family) name.
    equip_id:
      type: string
      nullable: true
      example: 1
      description: Aftermarket provider ID.
    equip_name:
      type: string
      nullable: true
      example: AUTEX (+)
      description: Aftermarket provider name.
  schemas:
    CommonApplicationResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            application_id:
              $ref: "#/components/parameters/application_id"
            family_id:
              $ref: "#/components/parameters/family_id"
        list:
          type: array
          items:
            type: object
            properties:
              application_id:
                $ref: "#/components/parameters/application_id"
              family_id:
                $ref: "#/components/parameters/family_id"
              family_name:
                $ref: "#/components/parameters/family_name"
              position_name:
                $ref: "#/components/parameters/position_name"
    CommonFamilyResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            family_id:
              $ref: "#/components/parameters/family_id"
        list:
          type: array
          items:
            type: object
            properties:
              family_id:
                $ref: "#/components/parameters/family_id"
              family_name:
                $ref: "#/components/parameters/family_name"
              group_id:
                $ref: "#/components/parameters/group_id"
              group_name:
                $ref: "#/components/parameters/group_name"
              genartnrs:
                type: array
                items:
                  type: string
                  example: 82

    CommonEquipResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            equip_id:
              $ref: "#/components/parameters/equip_id"
        list:
          type: array
          items:
            type: object
            properties:
              equip_id:
                $ref: "#/components/parameters/equip_id"
              equip_name:
                $ref: "#/components/parameters/equip_name"
              dnlr:
                type: string
                example: 300
    CommonEnergyResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            energy_id:
              $ref: "#/components/parameters/energy_id"
        list:
          type: array
          items:
            type: object
            properties:
              energy_id:
                $ref: "#/components/parameters/energy_id"
              energy_name:
                $ref: "#/components/parameters/energy_name"
    CommonGearboxResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            gearbox_id:
              $ref: "#/components/parameters/gearbox_id"
        list:
          type: array
          items:
            type: object
            properties:
              gearbox_id:
                $ref: "#/components/parameters/gearbox_id"
              gearbox_name:
                $ref: "#/components/parameters/gearbox_name"
    CommonBodyResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            body_id:
              $ref: "#/components/parameters/body_id"
        list:
          type: array
          items:
            type: object
            properties:
              body_id:
                $ref: "#/components/parameters/body_id"
              body_name:
                $ref: "#/components/parameters/body_name"
    CommonKtypnrResponse:
      type: object
      description:
      properties:
        context:
          type: object
          properties:
            id:
              type: string
              nullable: true
              example: 30824
              description: Filters on id (from mapping source).
            from:
              type: string
              nullable: true
              example: ktypnr
              description: Filters on mapping source.
              enum:
                - ktypnr
                - natcode
                - chtyp
                - kba
                - hsntsn
                - hsn
                - tsn
                - cnit
        list:
          type: array
          items:
            type: object
            properties:
              ktypnr:
                type: string
                nullable: true
                example: 30824
                description: Filters on id (from mapping source)
              manufacturer:
                type: string
                nullable: true
                example: Peugeot
                description: Ktypnr manufacturer.
              model:
                type: string
                nullable: true
                example: 3008
                description: Ktypnr model.
              version:
                type: string
                nullable: true
                example: 2.0 HDi 150
                description: Ktypnr version.
              start_and_stop:
                type: string
                nullable: true
                example: "?"
                description: Is ktypnr start_and_stop?
    ErrorResponse:
      type: object
      description: >
        Describes  error response. Possible business errors (error.message_code) are:
        * 1000: API.INTERNAL_SERVER_ERROR
        * 2000: API.UNKNOWN_USER
        * 2001: API.USER_CALLS_LIMIT_REACHED
        * 3000: API.UNKNOWN_VEHICLE
        * 3001: API.INVALID_REGISTRATION_NUMBER_OR_VIN
        * 3003: API.EMPTY_REGISTRATION_NUMBER_OR_VIN
        * 3004: API.CATALOG.UNINITIALIZED_COMMERCIAL_OFFER
        * 3005: API.CATALOG.VEHICLE_ALREADY_IN_QUEUE
        * 3006: API.PRODUCT_FAMILY_NOT_IN_OFFER
        * 3007: API.VEHICLE_FOUND_BUT_NOT_CREATED
        * 3008: API.UNKNOWN_PRODUCT_CATEGORY
        * 3009: API.PROVIDER_INVALID_CREDENTIALS
        * 3010: API.PROVIDER_ACCESS_DENIED
        * 3011: API.TEMPORARY_REGISTRATION_PLATE_UNAVAILABLE
        * 4000: API.NO_PAINT_FOUND_FOR_THIS_VEHICLE 
        * 5000: API.NO_TIRE_FOUND_FOR_THIS_VEHICLE
        * 5001: API.TWO_WHEELERS_NOT_AVAILABLE_IN_API_TIRE
      properties:
        message_code:
          type: integer
          nullable: true
          example: 2000
        message_texte:
          type: string
          nullable: true
          example: API.UNKNOWN_USER
        description:
          type: string
          example: Utilisateur inconnu
    VehiculeErrorResponse:
      type: object
      description: Describes vehicle error response.
      properties:
        error_code:
          $ref: "#/components/parameters/error_code"
        error:
          $ref: "#/components/schemas/ErrorResponse"
    VehiculeResponse:
      type: object
      description: Describes vehicle data.
      properties:
        mask:
          $ref: "#/components/parameters/mask"
        reg_country:
          $ref: "#/components/parameters/reg_country"
        company:
          $ref: "#/components/parameters/company"
        entity:
          $ref: "#/components/parameters/entity"
        activities:
          $ref: "#/components/parameters/activities"
        reg_or_vin:
          $ref: "#/components/parameters/reg_or_vin"
        reg_plate:
          $ref: "#/components/parameters/reg_plate"
        vin:
          $ref: "#/components/parameters/vin"
        code:
          $ref: "#/components/parameters/code"
        error_code:
          $ref: "#/components/parameters/error_code"
        car_identification:
          $ref: "#/components/schemas/car_identification"
        processing_info:
          type: object
          description: Provides some insight regarding the processing triggered by the API to generate the response.
          properties:
            reg_plate_lookup:
              $ref: "#/components/parameters/reg_plate_lookup"
            manufacturer_lookup:
              $ref: "#/components/parameters/manufacturer_lookup"
        registration_info:
          type: object
          description: Carries the vehicle's registration information corresponding to what the local administration stored. In France this is AAA information for instance.
          properties:
            manufacturer_id:
              type: string
              nullable: true
              description: Autopass unique identifier for the manufacturer.
              example: 40
            manufacturer_name:
              type: string
              nullable: true
              description: Name of the manufacturer.
              example: OPEL
            model_id:
              type: string
              nullable: true
              description: Autopass unique identifier for the model.
              example: 551
            model_name:
              type: string
              nullable: true
              description: Model's name (modele_etude from AAA)
              example: KANGOO II
            model_base:
              type: string
              nullable: true
              description: Model's name (modele from AAA)
              example: KANGOO
            version:
              type: string
              nullable: true
              description: Vehicle's version.
              example: 1.5 DCI
            generation_code:
              type: string
              nullable: true
              description: Vehicle's generation code.
              example: VP
            generation_code_cg:
              type: string
              nullable: true
              description: Vehicle's generation code on vehicle card.
              example: VP
            body_id:
              type: string
              nullable: true
              description: Autopass unique identifier for the vehicle's body.
              example: 4
            body_name:
              type: string
              nullable: true
              description: Vehicle's body type.
              example: BERLINE
            reg_body:
              type: string
              nullable: true
              description: "?"
              example: CI
            energy_id:
              type: string
              nullable: true
              description: Autopass unique identifier for the vehicle's energy.
              example: 18
            energy_name:
              type: string
              nullable: true
              description: Vehicle's energy source, such as Diesel or Hybrid.
              example: Gazole
            gearbox_id:
              type: string
              nullable: true
              description: Autopass unique identifier for the vehicle's gearbox.
              example: 4
            gearbox_name:
              type: string
              nullable: true
              description: Vehicle's gearbox.
              example: Mécanique
            gearbox_type:
              type: string
              nullable: true
              description: Vehicle's gearbox type.
              example: Mécanique
            co2:
              type: string
              nullable: true
              description: CO2 emission (g/km)
              example: 146
            depollution:
              type: string
              nullable: true
              description: Anti pollution system.
              example: NON RENSEIGNE
            date_ct:
              type: string
              nullable: true
              description: Last revision date.
              example: 2003-02-27
            date_pme:
              type: string
              nullable: true
              description: First registration date.
              example: 2003-02-27
            reg_date:
              type: string
              nullable: true
              description: Current registration date.
              example: 2006-04-11
            vin:
              type: string
              nullable: true
              description: Vehicle's VIN
              example: W0LGM6E2XG105XXXX
            reg_plate:
              type: string
              nullable: true
              description: Vehicle's registration plate
              example: AE044XX
            type_mine:
              type: string
              nullable: true
              description: Type MINE for the vehicle. Also called CNIT, this is a French specific code delivered by the gouvernement at homologation time.
              example: MPL5022FM545
            type_version:
              type: string
              nullable: true
              description: "?"
            type_vin:
              type: string
              nullable: true
              description: Also called VIN9 this correspond to the first 9 characters of the VIN.
              example: WK0008
            manufacturing_date:
              type: string
              nullable: true
              description: The date the vehicle has been manufactured.
            product_key:
              type: string
              nullable: true
              description: "Product key"
            vehicle_color:
              type: string
              nullable: true
              description: Vehicle's color. Carefull, this is not the official manufacturer color code.
              example: Vert
            propulsion_type:
              type: string
              nullable: true
              description: Vehicle's propulsion type.
              example: Avant
            engine_code:
              type: string
              nullable: true
              description: Vehicle's engine code.
              example: XUD11BTE_P
            engine_name:
              type: string
              nullable: true
              description: Vehicle's engine name.
            engine_index:
              type: string
              nullable: true
              description: Index part of the Vehicle's engine code.
            engine_size:
              type: string
              nullable: true
              description: The engine volume size in cm3
              example: 2088
            nb_cylinders:
              type: string
              nullable: true
              description: Number of cylinders.
              example: 4
            nb_valves:
              type: string
              nullable: true
              description: Number of vavles per cylinder.
              example: 3
            turbo:
              type: string
              nullable: true
              description: Turbo information.
              example: TURBO
            injection_type:
              type: string
              nullable: true
              description: Injection type.
              example: AUTRE CARBURATIONS
            real_power:
              type: string
              nullable: true
              description: Power in hp.
              example: 109
            fiscal_power:
              type: string
              nullable: true
              description: Fiscal power.
              example: 6
            kw_power:
              type: string
              nullable: true
              description: Power in kW.
              example: 80
            cons_ext_urban:
              type: string
              nullable: true
              description: Extra urban fuel consumption (L/100km)
              example: 5.7
            cons_mixed:
              type: string
              nullable: true
              description: Mixt fuel consumption (L/100km)
              example: 7.1
            cons_urban:
              type: string
              nullable: true
              description: Urban fuel consumption (L/100km)
            wheel_base:
              type: string
              nullable: true
              description: Wheel base.
              example: 0
            height:
              type: string
              nullable: true
              description: Vehicle height (cm)
              example: 0
            width:
              type: string
              nullable: true
              description: Vehicle width (cm)
              example: 177
            length:
              type: string
              nullable: true
              description: Vehicle length (cm)
              example: 456
            weight:
              type: string
              nullable: true
              description: Vehicle weight (kg)
            weight_rolling:
              type: string
              nullable: true
              description: Vehicle max weight (kg)
              example: 2015
            weight_empty:
              type: string
              nullable: true
              description: Vehicle empty weight (kg)
              example: 1490
            tire_width:
              type: string
              nullable: true
              description: Tire width.
            tire_height:
              type: string
              nullable: true
              description: Tire height.
            tire_diameter:
              type: string
              nullable: true
              description: Tire diameter.
            tire_speed_index:
              type: string
              nullable: true
              description: Tires speed index.
            serial_number:
              type: string
              nullable: true
              description: Vehicle serial number
              example: 99999999
            siren_number:
              type: string
              nullable: true
              description: Vehicle siren number.
              example: 999999999
            nb_seats:
              type: string
              nullable: true
              description: Number of seats in the vehicle.
              example: 5
            nb_doors:
              type: string
              nullable: true
              description: Number of doors.
              example: 4
            nb_gears:
              type: string
              nullable: true
              description: Vehicle number of gears.
              example: 5
            nb_volumes:
              type: string
              nullable: true
              description: Vehicle number of volumes.
              example: 3
            typevarversprf:
              type: string
              nullable: true
              description: Vehicle variant version type.
              example: WRKK9KA66TA1HBSAB0
            fap:
              type: string
              nullable: true
              description: Flag if vehicle has a particle filter.
            adblue:
              type: string
              nullable: true
              description: Flag if vehicle has adblue.
            crit_air:
              type: string
              nullable: true
              description: Vehicle pollution class.
            euro_norm:
              type: string
              nullable: true
              description: Vehicle euro norm.
            gearbox_code:
              type: string
              nullable: true
              description: Vehicle gearbox code.
            natcodes:
              type: string
              nullable: true
              description: Vehicle identifier (natcode).
            kbas:
              type: string
              nullable: true
              description: Vehicle identifier (KBA).
            mouv_cg:
              type: string
              nullable: true
              description: ...
            co2_cg:
              type: string
              nullable: true
              description: ...
            color_code:
              type: string
              nullable: true
              description: Vehicle color code.
            color_label:
              type: string
              nullable: true
              description: Vehicle color label.
            noise_level:
              type: string
              nullable: true
              description: Vehicle noise level.
            category_code:
              type: string
              nullable: true
              description: ...
            engine_type:
              type: string
              nullable: true
              description: ...
            dam_index:
              type: string
              nullable: true
              description: ...
            apv_type:
              type: string
              nullable: true
              description: ...
            model_generation:
              type: string
              nullable: true
              description: Vehicle model generation.
            model_phase:
              type: string
              nullable: true
              description: Vehicle model phase.
            equipments:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  manufacturer_group:
                    type: string
                    nullable: true
                    description: Equipment manufacturer group.
                  manufacturer_equipment_code:
                    type: string
                    nullable: true
                    description: Equipment manufacturer code.
                  manufacturer_description:
                    type: string
                    nullable: true
                    description: Equipment manufacturer description.
                  equipment:
                    type: string
                    nullable: true
                    description: Equipment.
                  equipment_type:
                    type: string
                    nullable: true
                    description: Equipment type.
                  needs_calibration:
                    type: boolean
                    nullable: true
                    description: Flag if equipment needs calibration.
            tire_list:
              type: array
              description: Lists possible tire sizes from SIV.
              items:
                #$ref: '#/components/schemas/Tire'
                type: object
                properties:
                  width:
                    type: string
                    nullable: true
                    description: Tire width.
                    example: 185
                  height:
                    type: string
                    nullable: true
                    description: Tire height.
                    example: 65
                  diameter:
                    type: string
                    nullable: true
                    description: Tire diameter.
                    example: 15
                  charging_index:
                    type: string
                    nullable: true
                    description: Tire charging index.
                    example: 88
                  speed_index:
                    type: string
                    nullable: true
                    description: Tire speed index.
                    example: T
    FluidResponse:
      type: object
      description: Describes vehicle fluid data.
      properties:
        mask:
          $ref: "#/components/parameters/mask"
        reg_country:
          $ref: "#/components/parameters/reg_country"
        company:
          $ref: "#/components/parameters/company"
        entity:
          $ref: "#/components/parameters/entity"
        activities:
          $ref: "#/components/parameters/activities"
        reg_or_vin:
          $ref: "#/components/parameters/reg_or_vin"
        reg_plate:
          $ref: "#/components/parameters/reg_plate"
        vin:
          $ref: "#/components/parameters/vin"
        code:
          $ref: "#/components/parameters/code"
        error_code:
          $ref: "#/components/parameters/error_code"
        car_identification:
          $ref: "#/components/schemas/car_identification"
        processing_info:
          type: object
          description: Provides some insight regarding the processing triggered by the API to generate the response.
          properties:
            reg_plate_lookup:
              $ref: "#/components/parameters/reg_plate_lookup"
            manufacturer_lookup:
              $ref: "#/components/parameters/manufacturer_lookup"
        catalog:
          type: array
          items:
            $ref: "#/components/schemas/catalog_fluid_item"
        _links:
          $ref: "#/components/schemas/response__links"
    CatalogResponse:
      type: object
      description: Describes catalog data.
      properties:
        code:
          $ref: "#/components/parameters/code"
        car_identification:
          type: object
          description: Gives some information about the vehicle.
          properties:
            ktypnr:
              $ref: "#/components/parameters/ktypnr"
            ktypnr_list:
              $ref: "#/components/parameters/ktypnr_list"
            reg_plate:
              $ref: "#/components/parameters/reg_plate"
            vin:
              $ref: "#/components/parameters/vin"
            brand:
              $ref: "#/components/parameters/brand"
            model:
              $ref: "#/components/parameters/model"
            version:
              $ref: "#/components/parameters/version"
        catalog:
          type: array
          description: Lists expected parts for given vehicle.
          items:
            $ref: "#/components/schemas/catalog_item"
        _links:
          $ref: "#/components/schemas/response__links"
    catalog_item:
      type: object
      properties:
        application_id:
          type: integer
          nullable: true
          description: Application ID that describes a family and its position on the vehicle.
        family_id:
          type: integer
          nullable: true
          description: Family ID.
        application_name:
          type: string
          nullable: true
          description: Application name.
        quality_index:
          type: string
          nullable: true
          description: |
            Quality index for OE reference (A, B, C, X, S):
              * A --> deterministic, quality equivalent or equal to the quality of the manufacturer's recommendation;
              * B --> probabilistic, quality superior to the requidred thresholds of reliability and quality, guaranteed  quality above or equal to manufacturer;
              * C --> Probabilistic, quality below the required reliability and quality thresholds, not guaranteed.
              * X --> Quality applied after completion process.
              * S --> Quality applied after scoring process.
          enum:
            - A
            - B
            - C
            - X
            - S
        aftermarket_info:
          description: AM references that match OE reference.
          anyOf:
            - type: array
              nullable: true
            - type: array
              items:
                $ref: "#/components/schemas/aftermarket_info_item"
        generic:
          $ref: "#/components/schemas/catalog_item_generic"
    aftermarket_info_item:
      type: object
      properties:
        ranking:
          type: string
          nullable: true
          description: This is the user-defined rank for the part family / OEM combination. This value can be zero if no rank has been defined.
        brand_id:
          type: string
          nullable: true
          description: This is the unique Autopass identifier of the equipment manufacturer for the given part.
        brand_name:
          type: string
          nullable: true
          description: This is the name (according to Autopass) of the equipment manufacturer brand for the given part.
        quality_index:
          type: string
          nullable: true
          description: |
            Quality index for OE reference (A, B or C, X, S):
              * A --> deterministic, quality equivalent or equal to the quality of the manufacturer's recommendation;
              * B --> probabilistic, quality superior to the requidred thresholds of reliability and quality, guaranteed  quality above or equal to manufacturer;
              * C --> Probabilistic, quality below the required reliability and quality thresholds, not guaranteed.
              * X --> Quality applied after completion process.
              * S --> Quality applied after scoring process.
          enum:
            - A
            - B
            - C
            - X
            - S
        cross:
          oneOf:
            - $ref: "#/components/schemas/aftermarket_info_item_cross_oe"
            - $ref: "#/components/schemas/aftermarket_info_item_cross_ktypnr"
        tags:
          type: array
          description: This is an array of tags to provide additional qualification regarding the AM reference. The Tecdoc range is an example of a tag. Each tag is a triplet made up of its code (a unique code that identifies which tag it is), a key and a value.
          items:
            $ref: "#/components/schemas/tag_item"
        eq_ref:
          type: string
          nullable: true
          description: This is the OEM reference as given in the prices and cleaned up by removing spaces, special characters, etc.
        eq_ref_raw:
          type: string
          nullable: true
          description: This is the OEM reference as given in the prices, gross without modification.
        eq_ref_label:
          type: string
          nullable: true
          description: This is the wording of the part as provided by the equipment manufacturer in its prices.
        ean_code:
          type: string
          nullable: true
          description: EAN code.
        eq_price:
          $ref: "#/components/schemas/aftermarket_info_item_eq_price"
        scoring_ranking:
          type: string
          nullable: true
          description: From scoring process, part ranking computed (based on ktypnr, family and scoring criteria).
        scoring_criteria:
          type: string
          nullable: true
          description: From scoring process, part family criteria to focus on.
        scoring_tecdoc:
          type: string
          nullable: true
          description: From scoring process, part matching percentage (ktypnr-family-part). 100% if link exists; 0% otherwise.
        scoring_oe:
          type: string
          nullable: true
          description: From scoring process, part matching percentage (ktypnr-family-oe-part).
        scoring_invoice:
          type: string
          nullable: true
          description: From scoring process, part matching percentage (ktypnr-family-invoices-part).
        scoring_computed:
          type: string
          nullable: true
          description: From scoring process, average percentage (computed from scoring_tecdoc, scoring_oe, scoring_invoice).
    tag_item:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: This is the tag name.
        short_name:
          type: string
          nullable: true
          description: This is the tag short name.
        unit:
          type: string
          nullable: true
          description: This is the tag unit.
        code:
          type: string
          nullable: true
          description: This is the unique code used to identify a tag.
        key:
          type: string
          nullable: true
          description: This is the key to the tag.
        value:
          type: string
          nullable: true
          description: This is the value to the tag.
        description:
          type: string
          nullable: true
          description: This is the description to the tag.
    response__links_self:
      type: object
      properties:
        href:
          type: string
    response__links:
      type: object
      properties:
        self:
          $ref: "#/components/schemas/response__links_self"
    catalog_item_generic:
      type: object
      properties:
        aftermarket_info:
          type: array
          description: AM references that match OE reference.
          example: []
          #items:
          #  $ref: '#/components/schemas/aftermarket_info_item'
    aftermarket_info_item_eq_price:
      type: object
      properties:
        price:
          type: number
          nullable: true
          description: Part price (decimal value).
        currency_code:
          type: string
          nullable: true
          description: Currency code. 3 characters ISO Code (ISO 4217).
    aftermarket_info_item_cross_oe:
      type: object
      properties:
        oe_ref:
          type: string
          nullable: true
          description: OE reference.
        eq_ref:
          type: string
          nullable: true
          description: AM reference.
    aftermarket_info_item_cross_ktypnr:
      type: object
      properties:
        ktypnr:
          type: string
          nullable: true
          description: Ktypnr.
        eq_ref:
          type: string
          nullable: true
          description: AM reference.
    ReferenceResponse:
      type: object
      description: Describes lookup response object (returned by api call /reference).
      properties:
        matching_oe_refs:
          type: array
          description: Lists OE references that match the query.
          items:
            $ref: "#/components/schemas/OeRef"
        matching_eq_refs:
          type: object
          properties:
            eq_refs:
              type: array
              description: Lists AM references (in offer) that match the query.
              items:
                $ref: "#/components/schemas/EqRefEqv"
            eq_refs_off_offer:
              type: array
              description: Lists AM references (off offer) that match the query.
              items:
                $ref: "#/components/schemas/EqRefEqv"
    OeRef:
      type: object
      properties:
        manufacturer_id:
          type: string
          nullable: true
          description: Manufacturer ID for matching OE reference.
        manufacturer_name:
          type: string
          nullable: true
          description: Manufacturer name for matching OE reference.
        oe_ref:
          type: string
          nullable: true
          description: OE reference matching the search.
        oe_replacements:
          type: array
          description: OE references replacing "oe_ref".
          items:
            type: string
            description: OE replacement reference.
        eq_refs:
          type: array
          description: Lists AM references that cross an OE reference.
          items:
            $ref: "#/components/schemas/EqRef"
        eq_refs_off_offer:
          type: array
          description: Lists AM references (off offer) that cross an OE reference.
          items:
            $ref: "#/components/schemas/EqRef"
    EqRefEqv:
      type: object
      properties:
        eq_id:
          type: string
          nullable: true
          description: AM ID.
        eq_name:
          type: string
          nullable: true
          description: AM name.
        eq_ref:
          type: string
          nullable: true
          description: AM reference code.
        eq_ref_name:
          type: string
          nullable: true
          description: AM reference name.
        eq_ref_public_price:
          type: string
          nullable: true
          description: AM reference public price.
        eq_replacements:
          type: array
          description: AM references replacing "eq_ref".
          items:
            type: string
            description: AM replacement reference.
        eq_tags:
          type: array
          description: AM reference (eq_ref) tags list.
          items:
            $ref: "#/components/schemas/EqTag"
        equivalences:
          type: object
          description: Equivalence that lists alternatives AM references.
          properties:
            eq_refs:
              type: array
              description: Alternatives AM references (in offer).
              items:
                $ref: "#/components/schemas/EqRef"
            eq_refs_off_offer:
              type: array
              description: Alternatives AM references (off offer).
              items:
                $ref: "#/components/schemas/EqRef"
    EqRef:
      type: object
      properties:
        eq_id:
          type: string
          nullable: true
          description: AM ID.
        eq_name:
          type: string
          nullable: true
          description: AM name.
        eq_ref:
          type: string
          nullable: true
          description: AM reference code.
        eq_ref_name:
          type: string
          nullable: true
          description: AM reference name.
        eq_ref_public_price:
          type: string
          nullable: true
          description: AM reference public price.
        eq_replacements:
          type: array
          description: AM references replacing "eq_ref".
          items:
            type: string
            description: AM replacement reference.
        eq_tags:
          type: array
          description: AM reference (eq_ref) tags list.
          items:
            $ref: "#/components/schemas/EqTag"
    EqTag:
      type: object
      description: AM reference tag.
      properties:
        tag_code:
          type: string
          nullable: true
          description: AM reference tag code.
        tag_name:
          type: string
          nullable: true
          description: AM reference tag name.
        tag_short_name:
          type: string
          nullable: true
          description: AM reference tag name (short version).
        tag_value:
          type: string
          nullable: true
          description: AM reference tag value.
    TireResponse:
      type: object
      properties:
        context:
          type: object
          description: This the summary of provided parameters.
          properties:
            mask:
              $ref: "#/components/parameters/mask"
            company:
              $ref: "#/components/parameters/company"
            entity:
              $ref: "#/components/parameters/entity"
            activities:
              $ref: "#/components/parameters/activities"
            ktypnr:
              $ref: "#/components/parameters/ktypnr"
            reg_or_vin:
              $ref: "#/components/parameters/reg_or_vin"
            reg_plate:
              $ref: "#/components/parameters/reg_plate"
            vin:
              $ref: "#/components/parameters/vin"
            reg_country:
              $ref: "#/components/parameters/reg_country"
        code:
          type: string
          nullable: true
          description: This is the return code. Its value is "OK" when the process returns a color chart.
        car_identification:
          $ref: "#/components/schemas/car_identification"
        processing_info:
          $ref: "#/components/schemas/processing_info"
        catalog:
          type: array
          description: This object contents approved sizes of tires.
          items:
            $ref: "#/components/schemas/catalog_tire_item"
        _links:
          $ref: "#/components/schemas/response__links"
    catalog_tire_item:
      type: object
      properties:
        manufacturer:
          type: boolean
          nullable: true
          description: If "true", tire dimensions are returned by the manufacturer.
          enum:
            - true
            - false
        approved:
          type: boolean
          nullable: true
          description: If "true", tire dimensions are approved.
          enum:
            - true
            - false
        date_start:
          type: string
          nullable: true
          description: Date of manufacture of the vehicle from which the tire fitting is approved.
        date_end:
          type: string
          nullable: true
          description: Date of manufacture of the vehicle until which tire fitting is approved.
        season:
          type: string
          nullable: true
          description: Season for which the tire fitting is approved.
        criterion:
          type: array
          nullable: true
          description: Mounting criteria.
          example: For vehicles which have 3 doors.
        front:
          type: object
          description: This object contents dimensions for front tires and rims.
          properties:
            tire:
              $ref: "#/components/schemas/tire_item"
            rim:
              $ref: "#/components/schemas/rim_item"
        rear:
          type: object
          description: This object contents dimensions for rear tires and rims.
          properties:
            tire:
              $ref: "#/components/schemas/tire_item"
            rim:
              $ref: "#/components/schemas/rim_item"
    tire_item:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: Tire name.
        width:
          type: string
          nullable: true
          description: Tire width.
        height:
          type: string
          nullable: true
          description: Tire height.
        diameter:
          type: string
          nullable: true
          description: Tire diameter.
        load_index:
          type: string
          nullable: true
          description: Tire load index.
        speed_index:
          type: string
          nullable: true
          description: Tire speed index.
        chainability:
          type: string
          nullable: true
          description: Tire chainability.
          enum:
            - Yes
            - No
            - Spikes-spider only
            - Unknown
        link_thickness_max:
          type: string
          nullable: true
          description: Maximum thickness of the link if tire is chainable.
        pressure_min:
          type: string
          nullable: true
          description: Tire minimum pressure.
        pressure_max:
          type: string
          nullable: true
          description: Tire maximum pressure.
        aftermarket:
          type: array
          description: This object contents aftermarket tire's references.
          items:
            $ref: "#/components/schemas/aftermarket_tire_item"
    rim_item:
      type: object
      properties:
        name:
          type: string
          nullable: true
          description: Rim name.
        width:
          type: string
          nullable: true
          description: Rim width.
        vehicle_type:
          type: string
          nullable: true
          description: Vehicle type.
        diameter:
          type: string
          nullable: true
          description: Rim diameter.
        offset:
          type: string
          nullable: true
          description: Rim offset.
        studs:
          type: string
          nullable: true
          description: Studs dimensions.
        PCD:
          type: string
          nullable: true
          description: Rim Pitch Circle Diameter
        nb_holes:
          type: string
          nullable: true
          description: Number of holes.
        bore:
          type: string
          nullable: true
          description: Rim bore.
        aftermarket:
          type: array
          description: This object contents aftermarket rim's references.
          items:
            $ref: "#/components/schemas/aftermarket_rim_item"
    aftermarket_tire_item:
      type: object
      properties:
        brand_name:
          type: string
          nullable: true
          description: This is the name (according to Autopass) of the equipment manufacturer brand for the given part.
        label:
          type: string
          nullable: true
          description: Tire complete name.
        boite_dim:
          type: string
          nullable: true
          description: Tire dimensions.
        radial:
          type: boolean
          nullable: true
          description: Indication if the tire is radial.
        mounting:
          type: string
          nullable: true
          description: Manufacturer approval.
        run_flat:
          type: boolean
          nullable: true
          description: Indication if the tire is runflat.
        ean_code:
          type: boolean
          nullable: true
          description: EAN code.
        season:
          type: string
          nullable: true
          description: Seasons of tire use.
        consumption:
          type: string
          nullable: true
          description: Fuel efficiency index.
        wet_performance:
          type: string
          nullable: true
          description: Wet grip index.
        sound_level_db:
          type: string
          nullable: true
          description: Noise level (in dB).
        sound_level_wave:
          type: string
          nullable: true
          description: Noise level (in sound waves).
        weight:
          type: string
          nullable: true
          description: Tire weight.
        weight_unit:
          type: string
          nullable: true
          description: Unit of weight.
        volume:
          type: string
          nullable: true
          description: Tire volume.
        volume_unit:
          type: string
          nullable: true
          description: Unit of volume.
        vehicle_type:
          type: string
          nullable: true
          description: Type of vehicle for which the tire is designed.
    aftermarket_rim_item:
      type: object
      properties:
        brand_id:
          type: string
          nullable: true
          description: This is the unique Autopass identifier of the equipment manufacturer for the given part.
        brand_name:
          type: string
          nullable: true
          description: This is the name (according to Autopass) of the equipment manufacturer brand for the given part.
        eq_ref:
          type: string
          nullable: true
          description: Rim's reference without non-alphanumeric.
        eq_ref_raw:
          type: string
          nullable: true
          description: Rim's reference.
        ean_code:
          type: string
          nullable: true
          description: EAN code.
        width:
          type: string
          nullable: true
          description: Rim's width.
        vehicle_type:
          type: string
          nullable: true
          description: Vehicle type.
        diameter:
          type: string
          nullable: true
          description: Rim's diameter.
        offset:
          type: string
          nullable: true
          description: Rim's offset.
        PCD:
          type: string
          nullable: true
          description: Rim's Pitch Circle Diameter.
        nb_holes:
          type: string
          nullable: true
          description: Number of holes.
        bore:
          type: string
          nullable: true
          description: Rim's bore.
        gamme:
          type: string
          nullable: true
          description: Rim's spectrum.
        finition:
          type: string
          nullable: true
          description: Rim's finishing.
        homologation:
          type: string
          nullable: true
          description: Rim's homologation.
        screws_ref:
          type: string
          nullable: true
          description: Rim's screws reference.
        material:
          type: string
          nullable: true
          description: Rim's material.
        notes:
          type: string
          nullable: true
          description: Additionnal comment.
    PaintResponse:
      type: object
      properties:
        context:
          type: object
          description: This the summary of provided parameters.
          properties:
            mask:
              $ref: "#/components/parameters/mask"
            company:
              $ref: "#/components/parameters/company"
            entity:
              $ref: "#/components/parameters/entity"
            activities:
              $ref: "#/components/parameters/activities"
            reg_or_vin:
              $ref: "#/components/parameters/reg_or_vin"
            reg_plate:
              $ref: "#/components/parameters/reg_plate"
            vin:
              $ref: "#/components/parameters/vin"
            reg_country:
              $ref: "#/components/parameters/reg_country"
        code:
          type: string
          nullable: true
          description: This is the return code. Its value is "OK" when the process returns a color chart.
        car_identification:
          $ref: "#/components/schemas/car_identification"
        processing_info:
          $ref: "#/components/schemas/processing_info"
        catalog:
          anyOf:
            - type: string
              nullable: true
            - type: array
              description: This object contents the color chart.
              items:
                $ref: "#/components/schemas/catalog_paint_item"
        _links:
          $ref: "#/components/schemas/response__links"
    context_paint_item:
      type: object
      properties:
        mask:
          $ref: "#/components/parameters/mask"
        company:
          $ref: "#/components/parameters/company"
        entity:
          $ref: "#/components/parameters/entity"
        activities:
          $ref: "#/components/parameters/activities"
        reg_or_vin:
          $ref: "#/components/parameters/reg_or_vin"
        reg_plate:
          $ref: "#/components/parameters/reg_plate"
        vin:
          $ref: "#/components/parameters/vin"
        reg_country:
          $ref: "#/components/parameters/reg_country"
    processing_info:
      type: object
      description: Describes how our system is processing information.
      properties:
        reg_plate_lookup:
          $ref: "#/components/parameters/reg_plate_lookup"
        manufacturer_lookup:
          $ref: "#/components/parameters/manufacturer_lookup"
        tires_lookup:
          $ref: "#/components/parameters/tires_lookup"
        paint_lookup:
          $ref: "#/components/parameters/paint_lookup"
    catalog_paint_item:
      type: object
      properties:
        color:
          type: string
          nullable: true
          description: Paint's main colors
        color_label:
          type: string
          nullable: true
          description: Paint's label
        color_code:
          type: string
          nullable: true
          description: Manufacturer's color code
        manufacturer:
          type: boolean
          nullable: true
          description: If "true", the color code is returned by the manufacturer.
          enum:
            - true
            - false
        suggested:
          type: boolean
          nullable: true
          description: If "true", the paint's main color matches with the car's color.
          enum:
            - true
            - false
        aftermarket_info:
          type: array
          description: This is a list of aftermarket references for the color code above.
          items:
            $ref: "#/components/schemas/aftermarket_info_paint_item"
    aftermarket_info_paint_item:
      type: object
      properties:
        brand_id:
          type: string
          nullable: true
          description: This is the Autopass unique ID for the brand of the AM reference.
        brand_name:
          type: string
          nullable: true
          description: This is the brand name (for Autopass).
        eq_ref:
          type: string
          nullable: true
          description: This is the AM reference without spaces and special caracters.
        ean_code:
          type: string
          nullable: true
          description: This is the EAN code (13).
        tags:
          type: array
          description: This is the list of tags for the reference. Tags bring more informations about AM reference.
          items:
            $ref: "#/components/schemas/tag_paint_item"
    tag_paint_item:
      type: object
      properties:
        code:
          type: string
          nullable: true
          description: This is the unique code to identify a tag.
        key:
          type: string
          nullable: true
          description: This is the key of the tag.
        value:
          type: string
          nullable: true
          description: This is the value of the tag.
        description:
          type: string
          nullable: true
          description: This is the description of the tag.
    catalog_fluid_item:
      type: object
      description: Describes norms/fluids for vehicle ktypnr variant.
      properties:
        valid:
          type: boolean
          nullable: true
          description: Flag fluid item that fits with vehicle.
        ktypnr:
          type: string
          nullable: true
          description: Vehicle ktypnr.
        model:
          type: string
          nullable: true
          description: Ktypnr model.
        variant:
          type: string
          nullable: true
          description: Ktypnr variant.
        variant_from:
          type: string
          nullable: true
          description: ktypnr variant date from.
        variant_to:
          type: string
          nullable: true
          description: Ktypnr variant date to.
        capacities:
          type: array
          description: Describes capacities for vehicle ktypnr variant.
          items:
            type: object
            properties:
              quantity:
                type: string
                nullable: true
                description: Fluid capacity.
              specification:
                type: string
                nullable: true
                description: Fluid capacity specification.
              information:
                type: string
                nullable: true
                description: Fluid capacity information.
              date_from:
                type: string
                nullable: true
                description: Fluid capacity date from.
              date_to:
                type: string
                nullable: true
                description: Fluid capacity date to.
        norms:
          type: array
          description: Describes norms for vehicle ktypnr variant.
          items:
            type: object
            properties:
              raw:
                type: string
                nullable: true
                description: Fluid norms and viscosities (raw version).
              norms:
                type: array
                nullable: true
                description: Fluid norms.
                items:
                  type: string
              fluids:
                type: array
                nullable: true
                description: Fluid viscosities.
                items:
                  type: string
              specification:
                type: string
                nullable: true
                description: Fluid norm specification.
              information:
                type: string
                nullable: true
                description: Fluid norm information.
              date_from:
                type: string
                nullable: true
                description: Fluid norm date from.
              date_to:
                type: string
                nullable: true
                description: Fluid norm date to.

    car_identification:
      type: object
      description: Gives some information about the vehicle.
      properties:
        vt_id:
          $ref: "#/components/parameters/vt_id"
        ktypnr:
          $ref: "#/components/parameters/ktypnr"
        ktypnr_list:
          $ref: "#/components/parameters/ktypnr_list"
        reg_plate:
          $ref: "#/components/parameters/reg_plate"
        vin:
          $ref: "#/components/parameters/vin"
        brand:
          $ref: "#/components/parameters/brand"
        model:
          $ref: "#/components/parameters/model"
        version:
          $ref: "#/components/parameters/version"
        date_pme:
          $ref: "#/components/parameters/date_pme"

externalDocs:
  description: Find out more about Autopass API
  url: "https://swag.autopass.pro"
