Documentation

The description of available methods of using Levam service.

Contents

OEM Widget

The OEM catalog widget allows you to independently connect OEM catalogs to absolutely any site. Without the long and costly integration of directories through the API by programmers. An example widget can be viewed in the demo.

Advantages of using the widget:

Installation:

Just copy the widget code from the dashboard to the page of your website (where you want to place the catalogs) <script id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>

If you want to display only one catalog on a page, then specify it in the start_brand parameter, for example:
<script start_brand="bmw" id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>

To change the catalogs language, use the lang parameter, for example:
<script lang="de" id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>

JavaScript API:

levamVinFind("vincode") - allows you to initiate a search by VIN. It is usually used to implement a wine search on your site from your own field - for example, from the main site search. In this case, the wine search field in the widget itself can be disabled in the office. The method must be called on the page where the widget is located.






Levam OEM API

CatalogsListGet

Displaying information by catalogs

Address:

https://api.levam.net/oem/v1/CatalogsListGet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/CatalogsListGet?api_key=key&type=

Response:

Response description:

name Catalog name
code Catalog code (an outdated parameter has been left for compatibility purposes, its value is the same as catalog_code)
catalog_code Catalog code
logo 100x100 catalog logo
logo_small 50x50 small catalog logo
supportframesearch Does the given catalog support frame search option, takes on yes/no values
frameexample The example of a frame for the given catalog
supportvinsearch Does the given catalog support VIN number search option, takes on yes/no values
vinexample The example of a VIN number for the given catalog
universal_classifier For the given catalog universal classifier is available — methods (TreeGet,TreeNodeSearch,TreeNodePartsGet), takes on yes/no values
type_moto Motorbikes availability in the given catalog
type_auto Cars availability in the given catalog
type_transport Cargo and commercial vehicles availability in the given catalog

ModelsListGet

Displaying all vehicle lines and models produced by the same manufacturer.

Address:

https://api.levam.net/oem/v1/ModelsListGet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/ModelsListGet?api_key=key&catalog_code=3

Response:

Response description:

name Catalog name
code Catalog code (an outdated parameter has been left for compatibility purposes, its value is the same as catalog_code)
catalog_code Catalog code
logo 100x100 catalog logo
logo_small 50x50 small catalog logo
supportframesearch Does the given catalog support frame search option?
frameexample The example of a frame for the given catalog
supportvinsearch Does the given catalog support VIN number search option?
vinexample The example of a VIN number for the given catalog
universal_classifier For the given catalog universal classifier is available — methods (TreeGet,TreeNodeSearch,TreeNodePartsGet), takes on yes/no values
type_moto Motorbikes availability in the given catalog
type_auto Cars availability in the given catalog
type_transport Cargo and commercial vehicles availability in the given catalog

VehicleParamsSet

Clarifying selected car model series.

Address:

https://api.levam.net/oem/v1/VehicleParamsSet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/VehicleParamsSet?api_key=key&catalog_code=3&model=AA3&ssd=&family=Audi+A3

Response:

Response description:

mark Vehicle make
catalog_code Catalog code
family Vehicle line
model Vehicle model
ssd Unique identifier
param Selected parameters
modification A selected vehicle series
group Selected group
subgroup Selected subgroup
vin VIN number
frame Frame number
universal_classifier For the given catalog universal classifier is available — methods (TreeGet,TreeNodeSearch,TreeNodePartsGet), takes on yes/no values
name Parameter full name
values Array of parameters the key of which is a full name of parameter value and the value of which is the code of parameter value

ModelsListGet2

Displaying all vehicle lines and models produced by the same manufacturer.

Address:

https://api.levam.net/oem/v1/ModelsListGet2

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/ModelsListGet2?api_key=key&catalog_code=3

Response:

Response description:

name Catalog name
catalog_code Catalog code
logo 100x100 catalog logo
logo_small 50x50 small catalog logo
supportframesearch Does the given catalog support frame search option?
frameexample The example of a frame for the given catalog
supportvinsearch Does the given catalog support VIN number search option?
vinexample The example of a VIN number for the given catalog
universal_classifier For the given catalog universal classifier is available — methods (TreeGet,TreeNodeSearch,TreeNodePartsGet), takes on yes/no values
type_moto Motorbikes availability in the given catalog
type_auto Cars availability in the given catalog
type_transport Cargo and commercial vehicles availability in the given catalog

VehicleModificationsGet

Selecting vehicle series in accordance with previously selected parameters.

Address:

https://api.levam.net/oem/v1/VehicleModificationsGet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/VehicleModificationsGet?api_key=key&ssd=770e1aee96bbf85678ab1426f66af8c6<

Response:

Response description:

mark Vehicle make
catalog_code Catalog code
family Vehicle line
model Vehicle model
ssd Unique identifier
param Selected parameters
modification A selected vehicle series
group Selected group
subgroup Selected subgroup
vin VIN number
frame Frame number
universal_classifier For the given catalog universal classifier is available — methods (TreeGet,TreeNodeSearch,TreeNodePartsGet), takes on yes/no values

PartGroupsGet

Selecting a group of parts for a selected vehicle series.

Address:

https://api.levam.net/oem/v1/PartGroupsGet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/PartGroupsGet?api_key=key&ssd=770e1aee96bbf85678ab1426f66af8c6&link=dm5GNk8vOXNQN1pBWmZTUjU4WnhpMW4wbnZpY29NZzBRLzg4Tk1HVlBZZz0=

Response:

Response description:

mark Vehicle make
catalog_code Catalog code
family Vehicle line
model Vehicle model
ssd Unique identifier
param Selected parameters
modification Selected vehicle series
group Selected group
subgroup Selected subgroup
vin VIN number
frame Frame number
full_name Group full name
group_name Group of parts code
image Image for the given group

PartsGet

Displaying parts, diagrams and coordinates.

Address:

https://api.levam.net/oem/v1/PartsGet

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/PartsGet?api_key=key&ssd=770e1aee96bbf85678ab1426f66af8c6&link=dm5GNk8vOXNQN1pBWmZTUjU4WnhpMW4wbnZpY29NZzBRLzg4Tk1HVlBZZz0=&subgroup=010-10000

Response:

Response description:

parts is the information about found parts. Consists of two parts: standart and add.
standart is the array of information about parts available for all parts in all catalogs. This array consists of:
  • part_number - is the description of a part in a drawing
  • part_code - is a part code
  • part_name - is a part name
  • part_quantity - is the number of required parts.

add is the array of additional information about a part. This array consists of:
  • info - is the additional information about a part
  • model - indicates the production status of the given part
  • type - takes on two values:
    • part this object of the array contains the information about a part.
    • link this object of the array is a link to another node
  • node_link is a link to an assembly in case there is no link, then the field will take on no value
image are assembly drawings that match a selected subgroup
coord is the information about coordinates required for the search of parts in drawings

VinFind

Searching for a vehicle by VIN number

Address:

https://api.levam.net/oem/v1/VinFind

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/VinFind?api_key=key&vin=WAUBA24B3XN104537

Response:

Response description:

mark Vehicle make
catalog_code Catalog code
family Vehicle line
model Vehicle model
ssd Unique identifier
param Selected parameters
modification Selected vehicle series
group Selected group
subgroup Selected subgroup
vin VIN number
frame Frame number

FrameFind

Searching for a vehicle by FRAME number

Address:

https://api.levam.net/oem/v1/FrameFind

Input parameters:

Mandatory parameters:

Optional parameters:

Output parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/FrameFind?api_key=key&frame=NHW20-7837381

Response:

Response description:

mark Vehicle make
catalog_code Catalog code
family Vehicle line
model Vehicle model
ssd Unique identifier
param Selected parameters
modification Selected vehicle series
group Selected group
subgroup Selected subgroup
vin VIN number
frame Frame number

TreeGet

Displaying assemblies tree from the universal classifier of vehicles

Address:

https://api.levam.net/oem/v1/TreeGet

Input parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/TreeGet?api_key=key&link=link&ssd=ssd&lang=ru

Response:

Response description:

TreeNodeSearch

Displaying the list of assemblies for a selected branch of the universal classifier tree

Address:

https://api.levam.net/oem/v1/TreeNodeSearch

Input parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/TreeNodeSearch?api_key=key&link=link&&ssd=ssd&path=1->3->4&lang=ru

Response:

Response description:

TreeNodePartsGet

Displaying assembly parts selected from assemblies list

Address:

https://api.levam.net/oem/v1/TreeNodePartsGet

Input parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/TreeNodePartsGet?api_key=key&link=link&ssd=ssd&group=300-300020&lang=ru

Response:

Response description:

TreeFullGet

Output of the full tree of nodes of the universal classifier

Address:

https://api.levam.net/oem/v1/TreeFullGet

Input parameters:

Mandatory parameters:

Optional parameters:

Exampl:

https://api.levam.net/oem/v1/TreeFullGet?api_key=key&ssd=5cb2c0bccb14128d1982948b719715c8:28bddf035b3bacac1bc42f2f33359651&lang=ru&link=SzNxekJ4aC9jVyswNC9mTjNjM3B5QT09--

Response:

Response description:

mark - Vehicle make
catalog_code - Catalog code
model - Vehicle model
family - Vehicle line
ssd - Unique identifier
param - Selected parameters
modification - Selected vehicle series
group - Selected group
subgroup - Selected subgroup
universal_classifier - A universal classifier is available for this catalog
vin - VIN number
frame - Frame number
10000 - Tree section id
name - Name of the section of the tree of the universal classifier
image - Link to the image of the universal classifier tree section
branch - A tree branch
nodes - An array containing information about a node

ApplicabilityCars

Catalog output, families, models and modifications in which the part is found

Address:

https://api.levam.net/oem/v1/ApplicabilityCars

Input parameters:

Mandatory parameters:

Optional parameters:

Example:

https://api.levam.net/oem/v1/ApplicabilityCars?api_key=key&part_code=34351543830&lang=ru

Response:

Response description:

  • catalog_code - Catalog code
  • catalog_name - Catalog name
  • families - An array of objects containing information about families:
  • family_name - Family name
  • models - An array of objects containing information about models:
  • model_name - Model name
  • model_image - Link to model name
  • modifs - An array of objects containing information about modifications:
  • modif_link - Code of the selected modification
  • props - Object containing modification parameters (field names may differ in different directories)
  • ApplicabilityNodes

    Output the modification with nodes that have a given part

    Address:

    https://api.levam.net/oem/v1/ApplicabilityNodes

    Input parameters:

    Mandatory parameters:

    Optional parameters:

    Example:

    https://api.levam.net/oem/v1/ApplicabilityNodes?api_key=key&part_code=057130764AM&modif_link=UFNINUtxVHpxcmJNZmUrcVNoeS83UT09--

    Response:

    Response description:

  • catalog_code - Catalog code
  • catalog_name - Catalog name
  • family_name - Family name
  • model_name - Model name
  • model_image - Link to model image
  • nodes - Array of objects containing information about nodes:
  • image - Link to node image
  • node_name - Node name
  • group - Code/group name
  • parts - Array of objects containing information about parts of a node:
  • pnc - Part number on the schematic
  • OrderCheck

    Sends order verification request

    Address:

    https://api.levam.net/oem/v1/OrderCheck

    Input parameters:

    Mandatory parameters:

    Optional parameters:

    Example:

    https://api.levam.net/oem/v1/OrderCheck?api_key=key&vin=WBAUB31060VH40246&parts_codes=24007572464&order_code=1234

    Response:

    Response description:

    OrderCheckResult

    Returns the result of the order check

    Address:

    https://api.levam.net/oem/v1/OrderCheckResult

    Input parameters:

    Mandatory parameters:

    Example:

    https://api.levam.net/oem/v1/OrderCheckResult?api_key=key&task_id=4c9caf3deb6cad4eb73a7f7f9c679e57

    Response:

    Response description:

    MaintenanceParts

    Output of all spare parts for maintenance

    Address:

    https://api.levam.net/oem/v1/MaintenanceParts

    Input parameters:

    Mandatory parameters:

    Optional parameters:

    Example:

    https://api.levam.net/oem/v1/MaintenanceParts?lang=en&modif_link=OTM5SElaM2orZi91OUZyNVNrTWwydz09--

    Response:

    Response description:

    Levam AM

    BrandsGet

    Displaying a list of possible brands by part number.

    Address:

    https://am-api.levam.net/v1/BrandsGet

    Input parameters:

    Mandatory parameters:

    Optional parameters:

    Output parameters:

    Mandatory parameters:

    Optional parameters:

    Query example:

    https://am-api.levam.net/v1/BrandsGet?api_key=key&part_number=123456789&lang=en

    Response example:

    Response description:

    search_number Part number without special characters and spaces
    part_number Part number in a manufacturer’s format
    brand_name Brand name
    aliases brand name synonyms
    part_name Part name
    images Array of a part images
    images_small Array of a part reduced images
    aliases Aliases of brand name

    ReplacementsGet

    Displaying a list of equivalents by part number and brand

    Adress:

    https://am-api.levam.net/v1/ReplacementsGet

    Input parameters:

    Mandatory parameters:

    Optional parameters:

    Output parameters:

    Mandatory parameters:

    Optional parameters:

    Request example:

    https://am-api.levam.net/v1/ReplacementsGet?api_key=key&part_number=12345&brand=OPTIMAL&lang=en

    Respond:

    Response description:

    search_number Part number without special characters and spaces
    part_number Part number in a manufacturer’s format
    brand_name Brand name
    part_name Part name
    aliases brand name synonyms
    images Array of a part images
    images_small Array of a part reduced images
    oem_replacements Part numbers of original equivalents
    applicability Part applicability (vehicles that it is compatible to)
    settings Part parameters (weight, size etc.)
    search_number Part number without special characters and spaces
    part_number Part number in a manufacturer’s format
    brand_name Brand name
    aliases brand name synonyms
    part_name Part name
    images Array of a part images
    images_small Array of a part reduced images