webleads-tracker

Home > TraceParts for Developers > List of products

Introduction

The list of products is related to one given category of a catalog available in the TraceParts database.

 

API Key

This web service requires an API Key. Please refer to this chapter to request your API Key.

 

Description

This API returns the list of products for one given category. The response includes the label of the product, the thumbnail, the product’s catalog and few information.

 

Building a URL

The ProductsList API request takes the following form:

http://ws.tracepartsonline.net/tpowebservices/ProductsList?parameters

 

Parameters

Certain parameters are required while others are optional. As is standard in URLs, all parameters are separated using the ampersand (&) character. The list of parameters and their possible values are enumerated below.

 

Required parameters

Parameter Name

Data type

Default value

Description

ApiKey

string

none

Code calling an API to track and control how the API is used

Format

string

none

Answer file type (xml, json or csv)

ClassificationID

string

none

CatalogID given by the CatalogsList API

Language

string

en

LanguageID given by the LanguagesList API

 

Optional parameters

Parameter Name

Data type

Default value

Description

Path

string

root of the catalog

Category path which contents a list of product(s) given by the CategoriesList API

Size

integer

30,000

Number of products, split by page

Page

integer

1

Page number, if the products list have been split sith the Size parameter

UserEmail

string

none

User email / User ID

ActiveJsonLight

boolean

0

Enables the light version when json is the answer file type

Example of ProductsList API

The request below returns all products of the ASCO Numatics catalog, for the “Pneumatics” category, as an xml file, with an English content.

http://ws.tracepartsonline.net/tpowebservices/ProductsList?ClassificationId=ASCO_JOUCOMATIC&Path=/F_ASJC/F_ASJC.ASJC1/&Language=en&Format=xml&ApiKey={ApiKey}

By changing the Format and adding the ActiveJsonLight, ProductsList returns all products, as a light Json file.

http://ws.tracepartsonline.net/tpowebservices/ProductsList?ClassificationId=ASCO_JOUCOMATIC&Path=/F_ASJC/F_ASJC.ASJC1/&Language=en&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}

ProductsList responses

ProductsList responses are returned in the format indicated by the Format parameter within the URL request’s path.

 

JSON Output

A sample HTTP request is shown below, displaying some of the available products.

{
"partID":"10-30042012-121567",
"title":"\"H\" guiding unit with 4 slide bearings",
"manufacturerID":"ASCO_JOUCOMATIC",
"manufacturerName":"ASCO Numatics",
"standard":"ISO 15552",
"partPictureUrl":"http://www.tracepartsonline.net/PartsDefs/Production/ASCO_JOUCOMATIC/10-30042012-121567/Pictures/10-30042012-121567M.gif",
"published":"2/3/2014",
"updated":"1/4/2016",
"manufacturerPictureUrl":"http://www.tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif",
}
,
"partID":"10-13122000-070738",
"title":"Alignment compensator",
"manufacturerID":"ASCO_JOUCOMATIC",
"manufacturerName":"ASCO Numatics",
"standard":"ISO 15552,AFNOR NF ISO 15552,DIN ISO 15552,ISO 21287",
"partPictureUrl":"http://www.tracepartsonline.net/PartsDefs/Production/ASCO_JOUCOMATIC/10-13122000-070738/Pictures/10-13122000-070738M.gif",
"published":"2/3/2014",
"updated":"1/4/2016",
"manufacturerPictureUrl":"http://www.tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif",
}

 

XML Output

Same example as above.

<WsProduct>
<PartID>10-30042012-121567</PartID>
<Title>"H" guiding unit with 4 slide bearings</Title>
<PartPictureUrl>http://www.tracepartsonline.net/PartsDefs/Production/ASCO_JOUCOMATIC/10-30042012-121567/Pictures/10-30042012-121567M.gif</PartPictureUrl>
<Published>2/3/2014</Published>
<Updated>1/4/2016</Updated>
<Standard>ISO 15552</Standard>
<ManufacturerID>ASCO_JOUCOMATIC</ManufacturerID>
<ManufacturerName>ASCO Numatics</ManufacturerName>
<ManufacturerPictureUrl>http://www.tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif</ManufacturerPictureUrl>
</WsProduct>
<WsProduct>
<PartID>10-13122000-070738</PartID>
<Title>Alignment compensator</Title>
<PartPictureUrl>http://www.tracepartsonline.net/PartsDefs/Production/ASCO_JOUCOMATIC/10-13122000-070738/Pictures/10-13122000-070738M.gif</PartPictureUrl>
<Published>2/3/2014</Published>
<Updated>1/4/2016</Updated>
<Standard>ISO 15552,AFNOR NF ISO 15552,DIN ISO 15552,ISO 21287</Standard>
<ManufacturerID>ASCO_JOUCOMATIC</ManufacturerID>
<ManufacturerName>ASCO Numatics</ManufacturerName>
<ManufacturerPictureUrl>http://www.tracepartsonline.net/PartsDefs/Production/System/Pictures/ASCO_JOUCOMATICM.gif</ManufacturerPictureUrl>
</WsProduct>

ProductsList response elements

ProductsList responses contain nine elements:

  • “PartID”: it is the TraceParts product ID. A product can be a collection of several part numbers, or a single one. The choice is made by the supplier of the data.
  • “Title”: label of the product. A product can be only one part number or a collection of part numbers.
  • “PartPictureUrl”: path to the product’s logo. It is 40 pixels high with a maximum width of 108 pixels. There is no minimum width.
  • “Published”: date (US format) of the first publication of the product.
  • “Updated”: date (US format) of the last update of the product.
  • “Standard”: product conformed to this list of standards (comma separated)
  • “ManufacturerID”: TraceParts ID for the supplier. It is 33 characters maximum (A through Z, 0 through 9 and – and _ ).
  • “ManufacturerName”: label of the catalog, depending on the language.
  • “ManufacturerPictureUrl”: path to the catalog’s logo. It is 40 pixels high with a maximum width of 316 pixels. There is no minimum width.

Developer support

Please contact us for any problems, questions or comments related to this web service.

Last updated July 25, 2016