SupplierContacts

Catalog contact details

📘
New endpoint available: Contact/Catalog

Introduction

The contacts of the catalog are based on the information provided by the supplier of the data. It may include basic information such as the simple website of the contact up to very detailed information such as postal addresses, email addresses and so forth.

API Key

This web service requires an API Key. Please use the form to request your API Key.

Description

The API returns contact information for one given catalog.

Building a URL

The SupplierContacts API request takes the following form:

https://ws.tracepartsonline.net/tpowebservices/SupplierContacts?parameters

Parameters

Certain parameters are required while others are optional. As it 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)
ClassificationID	string	none	ClassificationId given by the CatalogsList API
Version	integer	1	Version of the answer

Optional parameters

Parameter Name	Data type	Default value	Description
UserEmail	string	none	User email / User ID
ActiveJsonLight	boolean	0	Enables the light version when json is the answer file type

Example of SupplierContacts API

The request below returns all contacts for the ASCO Numatics catalog as an xml file.

https://ws.tracepartsonline.net/tpowebservices/[email protected]&ClassificationId=ASCO_JOUCOMATIC&Format=xml&ApiKey={ApiKey}&Version=4

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

https://ws.tracepartsonline.net/tpowebservices/[email protected]&ClassificationId=ASCO_JOUCOMATIC&ActiveJsonLight=1&Format=json&ApiKey={ApiKey}&Version=4

SupplierContacts responses

SupplierContacts 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 contacts.

{
"supplierContactsCollection": [
{
"supplierEmails": [
{
"label": "[email protected]",
"value": "[email protected]"
},
{
"label": "[email protected]",
"value": "[email protected]"
}
],
"supplierWebSites": [
{
"label": "http://www.asconumatics.eu/fr/",
"value": "http://www.asconumatics.eu/fr/"
}
],
"classificationId": "ASCO_JOUCOMATIC",
"supplierName": "ASCO Numatics",
"supplierAddress": "ASCO SAS<br/>53 rue de la Beauce<br/>28110 Lucé<br/>France<br/>",
"supplierAddressFieldCompany": "ASCO SAS",
"supplierAddressFieldAddress1": "53 rue de la Beauce",
"supplierAddressFieldAddress2": "",
"supplierAddressFieldAddress3": "",
"supplierAddressFieldZipCode": "28110",
"supplierAddressFieldCity": "Lucé",
"supplierAddressFieldCountry": "France",
"supplierAddressFieldProvince": "",
"supplierAddressFieldISOCountryCode": "FR",
"phones": "",
"fax": ""
},
{
"supplierEmails": [
{
"label": "[email protected]",
"value": "[email protected]"
},
],
"supplierWebSites": [
{
"label": "www.asconumatics.eu",
"label": "www.asconumatics.eu",
}
],
"classificationId": "ASCO_JOUCOMATIC",
"supplierName": "ASCO Numatics",
"supplierAddress": "ASCO Numatics (ASCO JOUCOMATIC Ltd)<br/>2 Pit Hey Place<br/>West Pimbo<br/>SKELMERSDALE<br/>Lancashire<br/>WN89PG<br/>ENGLAND<br/>",
"supplierAddressFieldCompany": "ASCO Numatics (ASCO JOUCOMATIC Ltd)",
"supplierAddressFieldAddress1": "2 Pit Hey Place",
"supplierAddressFieldAddress2": "West Pimbo",
"supplierAddressFieldAddress3": "SKELMERSDALE",
"supplierAddressFieldZipCode": "WN89PG",
"supplierAddressFieldCity": "Lancashire",
"supplierAddressFieldCountry": "ENGLAND",
"supplierAddressFieldProvince": "",
"supplierAddressFieldISOCountryCode": "GB",
"phones": "",
"fax": ""
}
]
}

XML Output

Same example as above.

<WsSupplierContactsCollection>
<SupplierContactsCollection>
<WsSupplierContactsFull>
<ClassificationId>ASCO_JOUCOMATIC</ClassificationId>
<Fax/>
<Phones/>
<SupplierAddress>ASCO SAS <br/>53 rue de la Beauce<br/>28110<br/>Lucé<br/&>France</SupplierAddress>
<SupplierAddressFieldAddress1>53 rue de la Beauce</SupplierAddressFieldAddress1>
<SupplierAddressFieldAddress2/>
<SupplierAddressFieldAddress3/>
<SupplierAddressFieldCity>Lucé</SupplierAddressFieldCity>
<SupplierAddressFieldCompany>ASCO SAS</SupplierAddressFieldCompany>
<SupplierAddressFieldCountry>France</SupplierAddressFieldCountry>
<SupplierAddressFieldISOCountryCode>FR</SupplierAddressFieldISOCountryCode>
<SupplierAddressFieldProvince/>
<SupplierAddressFieldZipCode>28110</SupplierAddressFieldZipCode>
<SupplierEmail>[email protected]</SupplierEmail>
<SupplierName>ASCO Numatics</SupplierName>
<SupplierEmails>
<Email>
<Label>[email protected]</Label>
<Value>[email protected]</Value>
</Email>
<Email>
<Label>[email protected]</Label>
<Value>[email protected]</Value>
</Email>
</SupplierEmails>
<SupplierWebSites>
<WebSite>
<Label>http://www.asconumatics.eu/fr/</Label>
<Value>http://www.asconumatics.eu/fr/</Value>
</WebSite>
</SupplierWebSites>
</WsSupplierContactsFull>
<WsSupplierContactsFull>
<ClassificationId>ASCO_JOUCOMATIC</ClassificationId>
<Fax/>
<Phones/>
<SupplierAddress>ASCO Numatics (ASCO JOUCOMATIC Ltd)<br/>2 Pit Hey Place<br/>West Pimbo<br/>SKELMERSDALE<br/>Lancashire<br/>WN89PG<br/&>ENGLAND</SupplierAddress>
<SupplierAddressFieldAddress1>2 Pit Hey Place</SupplierAddressFieldAddress1>
<SupplierAddressFieldAddress2>West Pimbo</SupplierAddressFieldAddress1>
<SupplierAddressFieldAddress3>SKELMERSDALE</SupplierAddressFieldAddress1>
<SupplierAddressFieldCity>Lancashire</SupplierAddressFieldCity>
<SupplierAddressFieldCompany>ASCO Numatics (ASCO JOUCOMATIC Ltd)</SupplierAddressFieldCompany>
<SupplierAddressFieldCountry>ENGLAND</SupplierAddressFieldCountry>
<SupplierAddressFieldISOCountryCode>GB</SupplierAddressFieldISOCountryCode>
<SupplierAddressFieldProvince/>
<SupplierAddressFieldZipCode>WN89PG</SupplierAddressFieldZipCode>
<SupplierEmail>[email protected]</SupplierEmail>
<SupplierName>ASCO Numatics</SupplierName>
<SupplierEmails>
<Email>
<Label>[email protected]</Label>
<Value>[email protected]</Value>
</Email>
</SupplierEmails>
<SupplierWebSites>
<WebSite>
<Label>www.asconumatics.eu</Label>
<Value>www.asconumatics.eu</Value>
</WebSite>
</SupplierWebSites>
</WsSupplierContactsFull>
</SupplierContactsCollection>
</WsSupplierContactsCollection>

SupplierContacts response elements

SupplierContacts responses contain sixteen elements:

“ClassificationId”: TraceParts ID for the catalog. It is 33 characters maximum (A through Z, 0 through 9 and – and _ )
“SupplierAddress”: postal address with all fields concatenated
“SupplierAddressFieldAddress1”: field #1 of the postal address
“SupplierAddressFieldAddress2”: Field #2 of the postal address
“SupplierAddressFieldAddress3”: field #3 of the postal address
“SupplierAddressFieldCity”: city of the postal address
“SupplierAddressFieldCompany”: company name of the postal address
“SupplierAddressFieldCountry”: country of the postal address
“SupplierAddressFieldZipCode”: ZIP code of the postal address
“SupplierAddressFieldProvince”: province of the postal address (e.g.: the state for the USA)
“SupplierAddressFieldISOCountryCode”: ISO code of the country
“Phones”: phone number
“Fax”: fax number
“SupplierEmails”: Email addresses
“SupplierName”: Label of the catalog
“SupplierWebSites”: Websites

Developer support

Please contact us for any problem, question or comment related to this content integration.

Last updated October 25, 2017

Updated 9 months ago