Documentation
The description of available methods of using Levam service.
The description of available methods of using Levam service.
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:
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>
levamVinFind("vincode")
- allows you to initiate a search by VIN. It is usually used to implement a VIN search on your site from your own field - for example, from the main site search. In this case, the VIN search field in the widget itself can be disabled in the cabinet. The function must be called on the page where the widget is located.
Displaying information by catalogs
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
catalogs
- is the array of objects containing information about catalogsname |
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 (TreeFullGet,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 |
error
- is the information about errors. Empty value indicates that there are
no errors.
Displaying all vehicle lines and models produced by the same manufacturer.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
catalog
- is an object containing information about a selected catalogname |
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 (TreeFullGet,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 |
models
- is the array of objects containing information about vehicle lines and
models. One or more vehicle models listed in the array may belong to each vehicle line. A catalog that a
model belongs to is specified for each model.
error
- is the information about errors. Empty value indicates that there are
no errors.
Clarifying selected car model series.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog, vehicle
line, model,
parameters, series, group, subgroup, VIN number (in case the search by VIN number has been used) and
unique ssd identifier
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 (TreeFullGet,TreeNodePartsGet), takes on yes/no values |
params
- is the array of objects containing information about parameters.
Parameter code is the key of the array.
Value of the array is an object containing the following fields:
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 |
error
- is the information about errors. Empty value indicates that there are
no errors.
model_image
- is the image of a selected vehicle model. Available only in case
when the image for a selected model exists
Displaying all vehicle lines and models produced by the same manufacturer.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
catalog
- is an object containing information about a selected catalogname |
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 (TreeFullGet,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 |
families
- is the array of objects containing information about vehicle lines and
models. One or more vehicle models listed in the array may belong to each vehicle line. A catalog that a
model belongs to is specified for each model.
error
- is the information about errors. Empty value indicates that there are
no errors.
Selecting vehicle series in accordance with previously selected parameters.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog, vehicle
line,
model, parameters, series, group, subgroup, VIN number (in case the search by VIN number has been used)
and ssd unique identifier
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 (TreeFullGet,TreeNodePartsGet), takes on yes/no values |
modifications
- is the array of objects containing information about vehicle
series.
Object contains names and values of all the parameters of the given vehicle series and
link
- field which is vehicle series unique code
error
- is the information about errors. Empty value indicates that there are
no errors.
model_image
- is the image of a selected vehicle model. Available only in case
when the image for a selected model exists.
Selecting a group of parts for a selected vehicle series.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog,
vehicle line, model, parameters, series, group, subgroup,
VIN number (in case the search by VIN number has been used) and ssd unique identifier
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 |
groups
- is the array of objects containing information about groups of parts
full_name |
Group full name |
group_name |
Group of parts code |
image |
Image for the given group |
next
- indicates the presence of enclosed groups of parts. If next
equals 1, then it means that this group of parts has subgroups that
one has to get access to in order to find requested parts. If next
equals 0, then it means that there are no subgroups for the given group of parts and, thus,
it is possible to get access to the list of parts.
model_info
- is the information about selected vehicle series.error
- is the information about errors. Empty value indicates that there are
no errors.
model_image
- is the image of a selected vehicle model.
Available only in case when there is an image for a selected model in the database.
Displaying parts, diagrams and coordinates.
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog, vehicle
line, model,
parameters, series, group, subgroup, VIN number (in case the search by VIN number has been used) and ssd
unique identifier.
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 |
parts
- is the array of objects containing the following information: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:
add is the array of additional information about a part.
This array consists of:
|
image |
are assembly drawings that match a selected subgroup |
coord |
is the information about coordinates required for the search of parts in drawings |
part_name
- is the name of an assembly (subgroup) which parts, parts images or
coordinates indicated in a response belong to.
model_info
- is the information about selected vehicle series.error
- is the information about errors. Empty value indicates that there are
no errors.
model_image
- is the image of a selected vehicle model.
Available only in case when there is an image for a selected model in the database.
Searching for a vehicle by VIN number
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog, vehicle
line,
model, parameters, series, group, subgroup, VIN number (in case the search by VIN number has been used)
and ssd unique identifier
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 |
models
- is the array of objects containing information about vehicle model
that
matches requested VIN number. Object contains names and values of all the parameters
of the given vehicle model and link
- field which is a vehicle series unique
code
error
- is the information about errors. Empty value indicates that there are
no errors.
Searching for a vehicle by FRAME number
Address:
Input parameters:
Output parameters:
Example:
Response:
Response description:
client
- is an object containing information about a selected catalog,
vehicle line, model, parameters, series, group, subgroup, VIN number
(in case the search by VIN number has been used) and ssd unique identifier
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 |
models
- is the array of objects containing information about vehicle model
that matches requested FRAME number. Object contains names and values
of all the parameters of the given vehicle model and link
- field which is a
vehicle series unique code
error
- is the information about errors. Empty value indicates that there are
no errors.
Output of the full tree of nodes of the universal classifier
Address:
Input parameters:
Exampl:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.client
- is an object containing information about the current section: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 |
mod_link
- Code of the selected modificationtree
- Tree of objects containing information about all nodes of the modification: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 |
model_image
- The image of the selected vehicle model. Present only if the image for this model is in the databasemodel_info
- Information about the selected vehicle modificationDisplaying assembly parts selected from assemblies list
Address:
Input parameters:
Example:
Response:
Response description:
parts
- is the array of objects containing the following information:
parts |
is the information about found parts. Consists of two parts:
|
||||||||||||||
image |
Assembly drawings that match a selected assembly | ||||||||||||||
coord |
Information about coordinates required for the search of spare parts on drawings |
part_name
- is the name of an assembly (subgroup) which parts, parts images
or coordinates indicated in a response belong to.
model_info
- is the information about a selected vehicle series.error
- is the information about errors. Empty value indicates that there are
no errors.
model_image
- is the image of a selected vehicle model.
Available only in case when there is an image for a selected model in the database.
Catalog output, families, models and modifications in which the part is found
Address:
Input parameters:
Example:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.result
- is an array of objects containing information:catalog_code - Catalog code |
|||||||
catalog_name - Catalog name |
|||||||
families - An array of objects containing information about families:
|
Output the modification with nodes that have a given part
Address:
Input parameters:
Example:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.result
- is an array of objects containing information: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 |
Sends order verification request
Address:
Input parameters:
Example:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.result
- is an object that contains information about the tasktask_id - is a task identifier, to get the result of the query |
Returns the result of the order check
Address:
Input parameters:
Example:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.result
- is object that contains information about the task:ready - true: task accomplished, false: task is not accomplished |
result - is object that contains as keys the part numbers of the parts to be checked: |
applicable - true/false - part fits / does not fit this modification |
replacements - is array of strings containing replacement part numbers (there is a newer part) |
Output of all spare parts for maintenance
Address:
Input parameters:
Example:
Response:
Response description:
error
- is the information about errors. Empty value indicates that there are no errors.result
- is the object containing the result of the check:catalog_code - Catalog code |
catalog_name - Catalog name |
catalog_image - Link to catalog image |
family_name - Family name |
family_image - Link to family image |
model_name - Model name |
model_image - Link to model image |
categories - Array of objects containing categories of parts: |
category_name - Category name |
category_code - Category code |
category_image - Link to category image |
parts - Array of objects containing information about parts: |
part_code - Part number |
part_name - Part name |
part_number - Part number on the schematic |
coords - Array of objects containing coordinates of the part number location in the scheme: |
top - Vertical coordinate |
left - Horizontal coordinate |
width - Mark width |
height - Mark height |
node_name - Node name |
node_group - Code/group name |
node_image - Link to node image |
Displaying a list of possible brands by part number.
Address:
Input parameters:
Output parameters:
Query example:
Response example:
Response description:
parts
- is the array of objects containing information about parts with target numbersearch_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 |
error
- is the information about errors. Empty value indicates that there are no errorsDisplaying a list of equivalents by part number and brand
Adress:
Input parameters:
Output parameters:
Request example:
Respond:
Response description:
requested_part
- is the information about a part that is under searching of equivalents.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.) |
replacements
- is the array of objects containing information about equivalents of requested partsearch_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 |
error
- is the information about errors. Empty value indicates that there are no errors