webleads-tracker

Home > TraceParts for Developers > Availability of a Part Number

Introduction

The PartNumberAvailability provides you if the couple catalog/part number is available on TraceParts database. The catalog and part number, provided by you, will be evaluated in our aliases database to match with many records.

 

API Key

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

 

Description

The API returns if the part number exists on TraceParts. In this case, will be returned the TraceParts CatalogID, the TraceParts ProductID and the part number.

 

Building a URL

The PartNumberAvailability API request takes the following form:

http://ws.tracepartsonline.net/tpowebservices/PartNumberAvailability?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)

PartNumber

string

none

Part Number as you have in your own data

Catalog

string

none

Catalog label as you have in your own data

 

Optional parameters

Parameter Name

Data type

Default value

Description

UserEmail

string

none

User email / User ID

SearchPNAliases

boolean

0

1: Remove punctuation of the input partnumber before comparison

ActiveJsonLight

boolean

0

Enables the light version when json is the answer file type

Example of PartNumberAvailability API

The request below returns the TraceParts information related to a former label of a catalog with a part number non written as wanted by the supplier of the data.

http://ws.tracepartsonline.net/tpowebservices/PartNumberAvailability?PartNumber=PRA-13654&Catalog=Sarel&SearchPNAliases=1&Format=xml&ApiKey={ApiKey}

By changing the Format and adding the ActiveJsonLight, PartNumberAvailability returns the data as a light Json file.

http://ws.tracepartsonline.net/tpowebservices/PartNumberAvailability?PartNumber=PRA-13654&Catalog=Sarel&SearchPNAliases=1&Format=json&ActiveJsonLight=1&ApiKey={ApiKey}

PartNumberAvailability responses

PartNumberAvailability 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 the information related to the available part number.

{
"availability":"true",
"partId":"10-08072011-067165"
"classificationId":"SCHNEIDER_ELECTRIC_DISTRI"
"partNumber":"PRA13654"
}

 

XML Output

Same example as above.

<WsPartNumberAvailability>
<Availability>true</Availability>
<ClassificationId>SCHNEIDER_ELECTRIC_DISTRI</ClassificationId>
<PartId>10-08072011-067165</PartId>
<PartNumber>PRA13654</PartNumber>
</WsPartNumberAvailability>

PartNumberAvailability response elements

PartNumberAvailability responses contain four elements:

  • “Availability”: true or false if the PartNumber is available or not on the TraceParts database.
  • “ClassificationId”: TraceParts ID for the catalog. It is 33 characters maximum (A through Z, 0 through 9 and – and _ ).
  • “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.
  • “PartNumber”: part number without any special characters, ignored by TraceParts for the search feature (” “,”-“,”.”,”/”,”+”).

Developer support

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

Last updated October 13, 2015