Parts search with brand and product group filter

This request outputs all available parts for a brand/product group combination. Use includeDataSupplierFacets and includeProductGroupFacets to get a summary of all available brands and productgroups and then filter by brand or product group ID.

Query URL

https://onedb.tecalliance.cn/api/articles


Step 1: Fetch a list of all brands and product groups.

Query parameter

Name Type Required Example Description
country String Yes CN This is the country code according to ISO 3166.
lang String Yes EN This is the language code according to ISO 639.
includeDataSupplierFacets Boolean No true This will output a facet with all data supplier based on the search and filter condition.
includeProductGroupFacets Boolean No true This will output a facet with all product groups based on the search and filter condition.
page Integer No 1 Page number when the results are split to several pages.
perpage Integer No 1 Number of items per page.

JSON Input

{
    "country": "CN",
    "lang": "EN",
    "includeDataSupplierFacets":true,
    "includeProductGroupFacets":true,
    "page": 1,
    "perPage": 1
}

RESPONSE

A successful request returns the HTTP 200 OK status code and a JSON response with following parameter.

Name Type Example Description
dataSupplierFacets > total Integer 3 The total number of brands in the request.
dataSupplierFacets > counts > dataSupplierId Integer 161 The ID of the brand/data supplier.
dataSupplierFacets > counts > mfrId Integer 798 The manufacturer ID of the brand/data supplier.
dataSupplierFacets > counts > mfrName String TRW The manufacturer name of the brand/data supplier.
dataSupplierFacets > counts > count Integer 8294 Total number of parts from brand/data supplier based on the request body.
productGroupFacets > total Integer 3 The total number of product groups in the request.
productGroupFacets > data > productGroupId Integer 78 The ID of the product group.
productGroupFacets > data > productGroupName String Brake Caliper The name of the product group.
productGroupFacets > data > count Integer 9918 The total number of parts within the product group.

JSON Output

{
    "totalMatching": 10000,
    "maxAllowedPage": 10000,
    "articles": [],
    "dataSupplierFacets": {
        "total": 3,
        "counts": [
            {
                "dataSupplierId": 161,
                "mfrId": 798,
                "mfrName": "TRW",
                "count": 8294
            },
            {
                "dataSupplierId": 206,
                "mfrId": 2408,
                "mfrName": "A.B.S.",
                "count": 6147
            },
            .....
            .....
            {
                "dataSupplierId": 4617,
                "mfrId": 3751,
                "mfrName": "BOSCH",
                "count": 4934
            }
        ]
    },
    "productGroupFacets": {
        "total": 2,
        "data": [
            {
                "productGroupId": 78,
                "productGroupName": "Brake Caliper",
                "count": 9918
            },
            ......
            ......
            {
                "productGroupId": 82,
                "productGroupName": "Brake Disc",
                "count": 9457
            }
        ]
    }
}



Step 2: Get parts for specific brand or product group.

Query parameter

Name Type Required Example Description
country String Yes CN This is the country code according to ISO 3166.
lang String Yes EN This is the language code according to ISO 639.
dataSupplierIds Array No 3 Use this if you want to filter part search results for some brands.
productGroups Array No 669 This will limit the part search results to the product groups added.
page Integer No 1 Page number when the results are split to several pages.
perpage Integer No 1 Number of items per page.

JSON Input

{
    "country": "CN",
    "lang": "EN",
    "dataSupplierIds": [30, 6],
    "productGroups":[82, 78],
    "page": 1,
    "perPage": 1
}

RESPONSE

A successful request returns the HTTP 200 OK status code and a JSON response with following parameter.

Name Type Example Description
totalMatching Integer 3 The total number of matching parts for the submitted request.
MaxAllowedPage Integer 3 The max number of page the user can visit for the specific request above. If the request has more than one item, then the maxAllowedPage number will be lower.
uid Integer 3703021090606551408 Unique ID of the part/article.
dataSupplierId Integer 6304 The ID of the data supplier in TecDoc.
articleNumber String CU-AU042 The part number in TecDoc.
mfrId Integer 5108 The ID of the manufacturer in TecDoc.
mfrName String QUICK BRAKE The name of the manufacturer in TecDoc.
misc > articleStatusId Integer 1 The ID of the part status.
misc > articleStatusDescription String Normal The description regarding the ID of the part status.
misc > articleStatusValidFromDate Date 20190703 The data from which the status is valid.
misc > quantityPerPackage Integer 1 The quantity per package.
misc > quantityPerPartPerPackage Integer 1 The quantity per part per package.
misc > isSelfServicePacking Boolean false
misc > hasMandatoryMaterialCertification Boolean false
misc > isRemanufacturedPart Boolean false
misc > isAccessory Boolean false A notice whether the part is an accessory.
misc > batchSize1
misc > batchSize2
genericArticles > genericArticleId Integer 669 Product group ID
genericArticles > genericArticleDescription String Brake Lines Set Product group description
articleText
gtins Integer 5706021095784 EAN number
tradeNumbers String - The trade number of the part.
oemNumbers object - OE number
replacesArticles Array - The part number which got replaced by this part.
replacedByArticles Array - The part number which replaces this part.
articleCriteria Array - Part number criteria.
linkage > linkageTargetTypeId Integer 2
linkage > carId Integer 18358
linkage > linkageCriteria Object - Vehicle related criteria for part number.
pdfs > url URL An URL to a PDF document related the part.
images > url URL http://... The URL to an image path.
images > type String JPG The type of image.
links > url URL http://... The URL to an external link, e.g. Youtube video.

JSON Output

{
    "totalMatching": 10000,
    "maxAllowedPage": 10000,
    "articles": [
        {
            "uid": "71137082943757588028",
            "dataSupplierId": 4617,
            "articleNumber": "0 204 001 935",
            "mfrId": 3751,
            "mfrName": "BOSCH",
            "misc": {
                "additionDescription": "",
                "articleStatusId": 8,
                "articleStatusDescription": "Article to be discontinued",
                "articleStatusValidFromDate": 20191027,
                "quantityPerPackage": 1,
                "quantityPerPartPerPackage": 0,
                "isSelfServicePacking": false,
                "hasMandatoryMaterialCertification": false,
                "isRemanufacturedPart": false,
                "isAccessory": false,
                "batchSize1": null,
                "batchSize2": null
            },
            "genericArticles": [
                {
                    "genericArticleId": 78,
                    "genericArticleDescription": "Brake Caliper"
                }
            ],
            "articleText": null,
            "gtins": [
                3165143351420
            ],
            "tradeNumbers": [
                "CA040"
            ],
            "oemNumbers": [
                {
                    "articleNumber": "77 01 207 786",
                    "mfrId": 93,
                    "mfrName": "RENAULT"
                }
            ],
            "replacesArticles": null,
            "replacedByArticles": null,
            "mainArticle": null,
            "partslist": null,
            "articleCriteria": [
                {
                    "criteriaId": 709,
                    "criteriaDescription": "Piston Diameter [mm]",
                    "criteriaType": "N",
                    "rawValue": "54",
                    "formatedVal": "54",
                    "immediateDisplay": true,
                    "isMandatory": false,
                    "isInterval": false
                }
            ],
            "pdfs": null,
            "images": null,
            "links": null,
            "logo": {
                "url": "https://onedbcdn.tecalliance.cn/static/4617/MDAzMDAwMS5KUEc=",
                "type": "JPG"
            }
        }
    ]
}