Product Search API (REST) - Description
- Description
- Request URL
- Query Parameters
- Version Control and Version Info
- Response Groups
- Sample Requests
- API-Specific Errors
Description
The Product Search API (REST) allows your users to search the element14 product catalog by keyword search, element14 part number, and manufacturer part number.
There are two levels of access for the API:
- generic access: Accessible by including callInfo.apiKey in the call
- contract pricing: Provides contract pricing data which is customer specific. In order to retrieve these prices you will need to contact your local sales representative to request a CustomerID and Secret Key and will need to provide details of your company, country and the username that you use to access our website.. The request requires sending the following paramters in the call which are based on our SOAP API:
- callInfo.apiKey
- userInfo.signature
- userInfo.timestamp
- userInfo.customerId
Request URL
https://api.element14.com/catalog/products
?callInfo.responseDataFormat={XML|JSON}
&callInfo.omitXmlSchema={...}
&callInfo.callback={...}
&term={field:term}
&storeInfo.id={storeInfoId|...}
&callInfo.apiKey={...}
&userInfo.signature={...}
&userInfo.timestamp={...}
&userInfo.billAccNum={...}
&userInfo.customerId={...}
&userInfo.contractId={...}
&resultsSettings.offset={...}
&resultsSettings.numberOfResults={...}
&resultsSettings.refinements.filters={rohsCompliant,inStock}
&resultsSettings.responseGroup={none,small,medium,large, Prices, Inventory}
Query Parameters
|
Query Parameters
|
|||
| Parameter | Description | Mandatory/Optional | Sample Value |
| callInfo.responseDataFormat | Determines output format. Can be XML or JSON. |
optional | JSON |
| callInfo.omitXmlSchema | String. Strip XML Namespace. XML data format only. | ||
| callInfo.callback | String. JSONP callback wrapper name. Not recommended for use with XML output. | ||
| term |
Issued as field:term, for example: any:fuse, id:123456, or manuPartNum:678901,
|
mandatory |
term=manuPartNum:678901 term=id%3A1278613 1112555 8477108 |
| storeInfo.id | Represents the region of the data store by country. See StoreInfo.id Values for the complete list. |
mandatory | uk.farnell.com |
| callInfo.apiKey | 24 character alphanumeric string assigned to you by the element14 Partner Portal. |
mandatory | mdp3xre4ucqh8f5aaaa4fz75j3y |
| userInfo.signature | Required when getting contract pricing. See Calculating the Contract Pricing Signature. | optional | |
| userInfo.timestamp | Required when getting contract pricing | optional | |
| userInfo.billAccNum | Not used | ||
| userInfo.customerId | Required when getting contract pricing | optional | |
| userInfo.contractId | Not used |
||
| resultsSettings.offset | mandatory for keyword search - Not used for other functions |
||
| resultsSettings.numberOfResults |
mandatory for keyword search - Not used for other functions |
||
| resultsSettings.refinements.filters | Can be rohsCompliant or inStock. | optional | inStock |
| resultsSettings.responseGroup | Can be small, medium, large, prices, inventory, and none. Small is the default if nothing is passed. | optional | small |
storeInfo.id Values
Represents the region of the data store by country. Here is the full list:
|
bg.farnell.com |
cz.farnell.com |
dk.farnell.com |
at.farnell.com |
|
ch.farnell.com |
de.farnell.com |
cpc.farnell.com |
cpcireland.farnell.com |
|
export.farnell.com |
onecall.farnell.com |
ie.farnell.com |
il.farnell.com |
|
uk.farnell.com |
es.farnell.com |
ee.farnell.com |
fi.farnell.com |
|
fr.farnell.com |
hu.farnell.com |
it.farnell.com |
lt.farnell.com |
|
lv.farnell.com |
be.farnell.com |
nl.farnell.com |
no.farnell.com |
|
pl.farnell.com |
pt.farnell.com |
ro.farnell.com |
ru.farnell.com |
|
sk.farnell.com |
si.farnell.com |
se.farnell.com |
tr.farnell.com |
|
canada.newark.com |
mexico.newark.com |
www.newark.com |
cn.element14.com |
|
au.element14.com |
nz.element14.com |
hk.element14.com |
sg.element14.com |
|
my.element14.com |
ph.element14.com |
th.element14.com |
in.element14.com |
|
tw.element14.com |
kr.element14.com |
Calculating the Contract Pricing Signature
In order to request any special rates associated with your account, we need to associate an API request to a web user account. To acheive this you will need to have registered on our websites and provide us with your Username.
Once we have your Username we can join the web account to the Product Search API so that any special rates can be retrieved. We will supply you with a Secret Key and Customer ID.
Please Note: The REST call is built over our SOAP API and the Contract Pricing request uses some legacy details when it comes to generating a signature - specifically, it needs to reference the equivelant SOAP Function that is being called by the REST API when generating a signature The REST and SOAP equivalents are below.
| REST Function | equivalent SOAP Function (operation name) |
| term=any | searchByKeyword |
| term=id | searchByPremierFarnellPartNumber |
| term=manuPartNum | searchByManufacturerPartNumber |
In order to retrieve Contract Pricing, the Product Search API requires three additional parameters passing in the URL.; they are
- userInfo.signature: This is generated by concatenating the Operation Name (see above table and also see SOAP WSDL) + timestamp and then using the secret key generate a HMAC SHA1 hash using the resultant Base64 option (useful reference: http://hash.online-convert.com/sha1-generator ).
***Please note the following important information to avoid signature errors:
1. The signature is operation specific and therefore needs to match the request "term" being made.
2. When a Signature is created using the HMAC SHA1 process, it may contain special characters (such as a + sign) which will need to be URL encoded - otherwise the signature will be misinterpretted and will result in a failed call (useful sites: http://meyerweb.com/eric/tools/dencoder/ https://www.w3schools.com/tags/ref_urlencode.ASP) - userInfo.timestamp: Universal time, referred to and supplied as GMT and in the format of yyyy-MM-ddThh:mm:ss.sss. e.g. 2009-02-0T15:45:40.254. This has a tolerance of + or – 10 minutes in relative to search service system clock
- userInfo.customerId: This is a number generated by us and assigned to the customer, e.g. 999123
Example Contract Pricing Call
https://api.element14.com/catalog/products?&term=any%3Afuse&storeInfo.id=www.newark.com&resultsSettings.offset=0&resultsSettings.numberOfResults=3&resultsSettings.refinements.filters=rohsCompliant%2CinStock&resultsSettings.responseGroup=large&callinfo.apiKey=YourAPIKey&userInfo.customerId=YourCustomerId&userInfo.timestamp=2013-07-24T16:49:51.293&userInfo.signature=8PHe1LiGwyaeVb2uJUPWtXYaMFg%3D
Constructing an Image URL
- https://
- The domain used for the API request i.e. uk.farnell.com
- Append the static text ‘/productimages/standard’
- Then based on the vrntPath value append the locale following these rules -
- If vrntPath is ‘nio/’ add ‘en_US’ to path
- Else if vrntPath is ‘farnell/’ take one of the following approaches –
i. You could use our fall back language default across all domains and set the locale as ‘en_GB’, but note if the customer is on any Store that doesn’t use English as a first language then the image names themselves may have local language elements in them and hence you should use a locale code appropriate to the primary transactional language
- Then append the baseName i.e the filename
So by example you could end up with these : https://uk.farnell.com/productimages/standard/en_GB/GE20TSSOP-40.jpg
Or https://fr.farnell.com/productimages/standard/fr_FR/GE20TSSOP-40.jpg
Version Control and Version Info.
In version 1.1 of the SearchService, versioning has been achieved by introduction of a new element in the Header of the request – versionInfo. Absence of the element will return response against the base version of the API whereas a specific and valid value of versionNumber within the versionInfo(such as 1.1) will return the response against that version. In the future, any new “minor” versions of the API will be implemented using this element.
New Request Elements
|
|
Elements |
Description |
Example |
|
1 |
versionInfo/versionNumber |
The versionNumber which determines the minor version of the API. This is included in the ‘header’ element of request |
<v1:versionInfo> <v1:versionNumber>1.1</v1:versionNumber> </v1:versionInfo> |
New Response Elements
|
|
Elements |
Description |
Example |
|
1 |
Product/orderMultiples |
Certain products can only be bought in specific multiples. This element will define that. |
<ns1:orderMultiples>10</ns1:orderMultiples> |
|
2 |
Product/packageName |
Defines the name of the Packaging type |
<ns1:packageName>Re-reel</ns1:packageName>
|
|
3 |
Product/reReelingCharge |
Re-reeling charges that are applicable in case of products that have re-reeling option. |
<ns1:reReelingCharge>3.5</ns1:reReelingCharge> |
|
4 |
Product/stock/expectedStock/level |
Expected stock level is the quantity that is expected to be available at a future date. |
<ns1:expectedStock> <ns1:level>3000</ns1:level> <ns1:date>2020-02-21</ns1:date> </ns1:expectedStock> |
|
5 |
Product/stock/expectedStock/date |
Expected stock date is the date that additional stock is expected to be available. |
Modified Response Elements
|
|
Elements |
Description |
Example |
|
1 |
Product/stock/breakdown/inv |
Modified to return only the available quantity and not aggregate of available and expected quantities |
<ns1:breakdown> <ns1:inv>51261</ns1:inv> <ns1:region>UK</ns1:region> <ns1:lead>78</ns1:lead> <ns1:warehouse>GB1</ns1:warehouse> </ns1:breakdown> |
|
Product/stock/regionalBreakDown/level |
Modified to return only the available quantity and not aggregate of available and expected quantities |
<ns1:regionalBreakdown> <ns1:level>38537</ns1:level> <ns1:leastLeadTime>0</ns1:leastLeadTime> <ns1:status>1</ns1:status> <ns1:warehouse>Liege</ns1:warehouse> <ns1:shipsFromMultipleWarehouses>false</ns1:shipsFromMultipleWarehouses> </ns1:regionalBreakdown> |
Response Groups
Response groups are a means to filter out certain elements of the payload based on the type of information/use case. There are 4 types of response groups: small, medium, large, prices, inventory, and none:
| Response Group | Description |
| small |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=small&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns the following: {
"keywordSearchReturn": {
"numberOfResults": 7355,
"products": [
{
"sku": "1360825",
"displayName": "SCHURTER - 0001.1001 - FUSE, FAST ACTING, CERAMIC, 500MA",
"packSize": 1,
"unitOfMeasure": "EACH",
"id": "pf_UK1_1360825_0",
"brandName": "SCHURTER",
"translatedManufacturerPartNumber": "0001.1001",
"translatedMinimumOrderQuality": 10,
"attributes": [
{
"attributeLabel": " Voltage Rating V AC",
"attributeUnit": "V",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Current",
"attributeUnit": "mA",
"attributeValue": "500"
},
{
"attributeLabel": " Fuse Size Metric",
"attributeUnit": "mm",
"attributeValue": "5mm x 20"
},
{
"attributeLabel": " Blow Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Series",
"attributeValue": "SP"
},
{
"attributeLabel": " SVHC",
"attributeValue": "No SVHC (20-Jun-2011)"
},
{
"attributeLabel": " Approval Bodies",
"attributeValue": "CCC, VDE"
},
{
"attributeLabel": " Approval Category",
"attributeValue": "UL Recognised"
},
{
"attributeLabel": " Body Diameter",
"attributeUnit": "mm",
"attributeValue": "5"
},
{
"attributeLabel": " Breaking Capacity",
"attributeUnit": "V AC",
"attributeValue": "1.5kA @ 250V AC, 10kA @ 125"
},
{
"attributeLabel": " Breaking Capacity Current AC",
"attributeUnit": "A",
"attributeValue": "1500"
},
{
"attributeLabel": " Cartridge Fuse Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " Case Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " External Diameter",
"attributeUnit": "mm",
"attributeValue": "5.2"
},
{
"attributeLabel": " Fuse Breaking Capacity Voltage AC",
"attributeUnit": "VAC",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Type Blowing Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Length",
"attributeUnit": "mm",
"attributeValue": "20"
},
{
"attributeLabel": " Operating Temperature Max",
"attributeUnit": "°C",
"attributeValue": "125"
},
{
"attributeLabel": " Operating Temperature Min",
"attributeUnit": "°C",
"attributeValue": "-55"
},
{
"attributeLabel": " Power Dissipation Max",
"attributeUnit": "mW",
"attributeValue": "2500"
},
{
"attributeLabel": " Standard",
"attributeValue": "IEC 60127-2/1, UL 248-14, CSA C22.2 no. 248.14"
}
],
"translatedPrimaryCatalogPage": "2194",
"publishingModule": "en/472686.xml"
}
]
}
}
|
| medium |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=medium&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns the following: {
"keywordSearchReturn": {
"numberOfResults": 7355,
"products": [
{
"sku": "1360825",
"displayName": "SCHURTER - 0001.1001 - FUSE, FAST ACTING, CERAMIC, 500MA",
"productStatus": "defaultStatus",
"rohsStatusCode": "YES",
"packSize": 1,
"unitOfMeasure": "EACH",
"id": "pf_UK1_1360825_0",
"datasheets": [
{
"type": "T",
"description": "Technical Data Sheet",
"url": "http://www.farnell.com/datasheets/70315.pdf"
}
],
"prices": [
{
"to": 90,
"from": 10,
"cost": 0.78
},
{
"to": 490,
"from": 100,
"cost": 0.62
},
{
"to": 990,
"from": 500,
"cost": 0.52
},
{
"to": 2990,
"from": 1000,
"cost": 0.48
},
{
"to": 1000000000,
"from": 3000,
"cost": 0.45
}
],
"vendorId": "25459",
"vendorName": "SCHURTER",
"brandName": "SCHURTER",
"translatedManufacturerPartNumber": "0001.1001",
"translatedMinimumOrderQuality": 10,
"attributes": [
{
"attributeLabel": " Voltage Rating V AC",
"attributeUnit": "V",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Current",
"attributeUnit": "mA",
"attributeValue": "500"
},
{
"attributeLabel": " Fuse Size Metric",
"attributeUnit": "mm",
"attributeValue": "5mm x 20"
},
{
"attributeLabel": " Blow Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Series",
"attributeValue": "SP"
},
{
"attributeLabel": " SVHC",
"attributeValue": "No SVHC (20-Jun-2011)"
},
{
"attributeLabel": " Approval Bodies",
"attributeValue": "CCC, VDE"
},
{
"attributeLabel": " Approval Category",
"attributeValue": "UL Recognised"
},
{
"attributeLabel": " Body Diameter",
"attributeUnit": "mm",
"attributeValue": "5"
},
{
"attributeLabel": " Breaking Capacity",
"attributeUnit": "V AC",
"attributeValue": "1.5kA @ 250V AC, 10kA @ 125"
},
{
"attributeLabel": " Breaking Capacity Current AC",
"attributeUnit": "A",
"attributeValue": "1500"
},
{
"attributeLabel": " Cartridge Fuse Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " Case Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " External Diameter",
"attributeUnit": "mm",
"attributeValue": "5.2"
},
{
"attributeLabel": " Fuse Breaking Capacity Voltage AC",
"attributeUnit": "VAC",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Type Blowing Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Length",
"attributeUnit": "mm",
"attributeValue": "20"
},
{
"attributeLabel": " Operating Temperature Max",
"attributeUnit": "°C",
"attributeValue": "125"
},
{
"attributeLabel": " Operating Temperature Min",
"attributeUnit": "°C",
"attributeValue": "-55"
},
{
"attributeLabel": " Power Dissipation Max",
"attributeUnit": "mW",
"attributeValue": "2500"
},
{
"attributeLabel": " Standard",
"attributeValue": "IEC 60127-2/1, UL 248-14, CSA C22.2 no. 248.14"
}
],
"stock": {
"level": 518,
"leastLeadTime": 63,
"status": 1,
"shipsFromMultipleWarehouses": true,
"breakdown": [
{
"inv": 40,
"region": "Liege",
"lead": 0,
"warehouse": "LG1"
},
{
"inv": 478,
"region": "UK",
"lead": 63,
"warehouse": "GB1"
}
],
"regionalBreakdown": [
{
"level": 40,
"leastLeadTime": 0,
"status": 1,
"warehouse": "Liege",
"shipsFromMultipleWarehouses": true
},
{
"level": 478,
"leastLeadTime": 63,
"status": 1,
"warehouse": "UK",
"shipsFromMultipleWarehouses": true
}
],
"nominatedWarehouseDetails": null
},
"translatedPrimaryCatalogPage": "2194",
"comingSoon": false,
"publishingModule": "en/472686.xml",
"vatHandlingCode": "SLST",
"releaseStatusCode": -1,
"isSpecialOrder": false,
"isAwaitingRelease": false,
"reeling": false,
"discountReason": 0
}
]
}
}
|
| large |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=large&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns the following:
{
"keywordSearchReturn": {
"numberOfResults": 7355,
"products": [
{
"sku": "1360825",
"displayName": "SCHURTER - 0001.1001 - FUSE, FAST ACTING, CERAMIC, 500MA",
"productStatus": "defaultStatus",
"rohsStatusCode": "YES",
"packSize": 1,
"unitOfMeasure": "EACH",
"id": "pf_UK1_1360825_0",
"image": {
"baseName": "/136082507-40.jpg",
"vrntPath": "farnell/"
},
"datasheets": [
{
"type": "T",
"description": "Technical Data Sheet",
"url": "http://www.farnell.com/datasheets/70315.pdf"
}
],
"prices": [
{
"to": 90,
"from": 10,
"cost": 0.78
},
{
"to": 490,
"from": 100,
"cost": 0.62
},
{
"to": 990,
"from": 500,
"cost": 0.52
},
{
"to": 2990,
"from": 1000,
"cost": 0.48
},
{
"to": 1000000000,
"from": 3000,
"cost": 0.45
}
],
"inv": 518,
"vendorId": "25459",
"vendorName": "SCHURTER",
"brandName": "SCHURTER",
"translatedManufacturerPartNumber": "0001.1001",
"translatedMinimumOrderQuality": 10,
"attributes": [
{
"attributeLabel": " Voltage Rating V AC",
"attributeUnit": "V",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Current",
"attributeUnit": "mA",
"attributeValue": "500"
},
{
"attributeLabel": " Fuse Size Metric",
"attributeUnit": "mm",
"attributeValue": "5mm x 20"
},
{
"attributeLabel": " Blow Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Series",
"attributeValue": "SP"
},
{
"attributeLabel": " SVHC",
"attributeValue": "No SVHC (20-Jun-2011)"
},
{
"attributeLabel": " Approval Bodies",
"attributeValue": "CCC, VDE"
},
{
"attributeLabel": " Approval Category",
"attributeValue": "UL Recognised"
},
{
"attributeLabel": " Body Diameter",
"attributeUnit": "mm",
"attributeValue": "5"
},
{
"attributeLabel": " Breaking Capacity",
"attributeUnit": "V AC",
"attributeValue": "1.5kA @ 250V AC, 10kA @ 125"
},
{
"attributeLabel": " Breaking Capacity Current AC",
"attributeUnit": "A",
"attributeValue": "1500"
},
{
"attributeLabel": " Cartridge Fuse Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " Case Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " External Diameter",
"attributeUnit": "mm",
"attributeValue": "5.2"
},
{
"attributeLabel": " Fuse Breaking Capacity Voltage AC",
"attributeUnit": "VAC",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Type Blowing Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Length",
"attributeUnit": "mm",
"attributeValue": "20"
},
{
"attributeLabel": " Operating Temperature Max",
"attributeUnit": "°C",
"attributeValue": "125"
},
{
"attributeLabel": " Operating Temperature Min",
"attributeUnit": "°C",
"attributeValue": "-55"
},
{
"attributeLabel": " Power Dissipation Max",
"attributeUnit": "mW",
"attributeValue": "2500"
},
{
"attributeLabel": " Standard",
"attributeValue": "IEC 60127-2/1, UL 248-14, CSA C22.2 no. 248.14"
}
],
"related": {
"containAlternatives": true,
"containcontainRoHSAlternatives": true,
"containAccessories": true,
"containcontainRoHSAccessories": true
},
"stock": {
"level": 518,
"leastLeadTime": 63,
"status": 1,
"shipsFromMultipleWarehouses": true,
"breakdown": [
{
"inv": 40,
"region": "Liege",
"lead": 0,
"warehouse": "LG1"
},
{
"inv": 478,
"region": "UK",
"lead": 63,
"warehouse": "GB1"
}
],
"regionalBreakdown": [
{
"level": 40,
"leastLeadTime": 0,
"status": 1,
"warehouse": "Liege",
"shipsFromMultipleWarehouses": true
},
{
"level": 478,
"leastLeadTime": 63,
"status": 1,
"warehouse": "UK",
"shipsFromMultipleWarehouses": true
}
],
"nominatedWarehouseDetails": null
},
"translatedPrimaryCatalogPage": "2194",
"countryOfOrigin": "CN",
"comingSoon": false,
"publishingModule": "en/472686.xml",
"vatHandlingCode": "SLST",
"releaseStatusCode": -1,
"isSpecialOrder": false,
"isAwaitingRelease": false,
"reeling": false,
"discountReason": 0,
"brandId": "1000895",
"commodityClassCode": "037004000"
}
]
}
}
|
| prices |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=prices&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns the following:
{
"keywordSearchReturn": {
"numberOfResults": 7355,
"products": [
{
"sku": "1360825",
"displayName": "SCHURTER - 0001.1001 - FUSE, FAST ACTING, CERAMIC, 500MA",
"packSize": 1,
"unitOfMeasure": "EACH",
"id": "pf_UK1_1360825_0",
"prices": [
{
"to": 90,
"from": 10,
"cost": 0.78
},
{
"to": 490,
"from": 100,
"cost": 0.62
},
{
"to": 990,
"from": 500,
"cost": 0.52
},
{
"to": 2990,
"from": 1000,
"cost": 0.48
},
{
"to": 1000000000,
"from": 3000,
"cost": 0.45
}
],
"brandName": "SCHURTER",
"translatedManufacturerPartNumber": "0001.1001",
"translatedMinimumOrderQuality": 10,
"attributes": [
{
"attributeLabel": " Voltage Rating V AC",
"attributeUnit": "V",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Current",
"attributeUnit": "mA",
"attributeValue": "500"
},
{
"attributeLabel": " Fuse Size Metric",
"attributeUnit": "mm",
"attributeValue": "5mm x 20"
},
{
"attributeLabel": " Blow Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Series",
"attributeValue": "SP"
},
{
"attributeLabel": " SVHC",
"attributeValue": "No SVHC (20-Jun-2011)"
},
{
"attributeLabel": " Approval Bodies",
"attributeValue": "CCC, VDE"
},
{
"attributeLabel": " Approval Category",
"attributeValue": "UL Recognised"
},
{
"attributeLabel": " Body Diameter",
"attributeUnit": "mm",
"attributeValue": "5"
},
{
"attributeLabel": " Breaking Capacity",
"attributeUnit": "V AC",
"attributeValue": "1.5kA @ 250V AC, 10kA @ 125"
},
{
"attributeLabel": " Breaking Capacity Current AC",
"attributeUnit": "A",
"attributeValue": "1500"
},
{
"attributeLabel": " Cartridge Fuse Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " Case Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " External Diameter",
"attributeUnit": "mm",
"attributeValue": "5.2"
},
{
"attributeLabel": " Fuse Breaking Capacity Voltage AC",
"attributeUnit": "VAC",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Type Blowing Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Length",
"attributeUnit": "mm",
"attributeValue": "20"
},
{
"attributeLabel": " Operating Temperature Max",
"attributeUnit": "°C",
"attributeValue": "125"
},
{
"attributeLabel": " Operating Temperature Min",
"attributeUnit": "°C",
"attributeValue": "-55"
},
{
"attributeLabel": " Power Dissipation Max",
"attributeUnit": "mW",
"attributeValue": "2500"
},
{
"attributeLabel": " Standard",
"attributeValue": "IEC 60127-2/1, UL 248-14, CSA C22.2 no. 248.14"
}
],
"translatedPrimaryCatalogPage": "2194",
"publishingModule": "en/472686.xml",
"vatHandlingCode": "SLST",
"discountReason": 0
}
]
}
}
|
| inventory |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=inventory&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns the following:
{
"keywordSearchReturn": {
"numberOfResults": 7355,
"products": [
{
"sku": "1360825",
"displayName": "SCHURTER - 0001.1001 - FUSE, FAST ACTING, CERAMIC, 500MA",
"productStatus": "defaultStatus",
"packSize": 1,
"unitOfMeasure": "EACH",
"id": "pf_UK1_1360825_0",
"brandName": "SCHURTER",
"translatedManufacturerPartNumber": "0001.1001",
"translatedMinimumOrderQuality": 10,
"attributes": [
{
"attributeLabel": " Voltage Rating V AC",
"attributeUnit": "V",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Current",
"attributeUnit": "mA",
"attributeValue": "500"
},
{
"attributeLabel": " Fuse Size Metric",
"attributeUnit": "mm",
"attributeValue": "5mm x 20"
},
{
"attributeLabel": " Blow Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Series",
"attributeValue": "SP"
},
{
"attributeLabel": " SVHC",
"attributeValue": "No SVHC (20-Jun-2011)"
},
{
"attributeLabel": " Approval Bodies",
"attributeValue": "CCC, VDE"
},
{
"attributeLabel": " Approval Category",
"attributeValue": "UL Recognised"
},
{
"attributeLabel": " Body Diameter",
"attributeUnit": "mm",
"attributeValue": "5"
},
{
"attributeLabel": " Breaking Capacity",
"attributeUnit": "V AC",
"attributeValue": "1.5kA @ 250V AC, 10kA @ 125"
},
{
"attributeLabel": " Breaking Capacity Current AC",
"attributeUnit": "A",
"attributeValue": "1500"
},
{
"attributeLabel": " Cartridge Fuse Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " Case Material",
"attributeValue": "Ceramic"
},
{
"attributeLabel": " External Diameter",
"attributeUnit": "mm",
"attributeValue": "5.2"
},
{
"attributeLabel": " Fuse Breaking Capacity Voltage AC",
"attributeUnit": "VAC",
"attributeValue": "250"
},
{
"attributeLabel": " Fuse Type Blowing Characteristic",
"attributeValue": "Fast Acting"
},
{
"attributeLabel": " Length",
"attributeUnit": "mm",
"attributeValue": "20"
},
{
"attributeLabel": " Operating Temperature Max",
"attributeUnit": "°C",
"attributeValue": "125"
},
{
"attributeLabel": " Operating Temperature Min",
"attributeUnit": "°C",
"attributeValue": "-55"
},
{
"attributeLabel": " Power Dissipation Max",
"attributeUnit": "mW",
"attributeValue": "2500"
},
{
"attributeLabel": " Standard",
"attributeValue": "IEC 60127-2/1, UL 248-14, CSA C22.2 no. 248.14"
}
],
"stock": {
"level": 518,
"leastLeadTime": 63,
"status": 1,
"shipsFromMultipleWarehouses": true,
"breakdown": [
{
"inv": 40,
"region": "Liege",
"lead": 0,
"warehouse": "LG1"
},
{
"inv": 478,
"region": "UK",
"lead": 63,
"warehouse": "GB1"
}
],
"regionalBreakdown": [
{
"level": 40,
"leastLeadTime": 0,
"status": 1,
"warehouse": "Liege",
"shipsFromMultipleWarehouses": true
},
{
"level": 478,
"leastLeadTime": 63,
"status": 1,
"warehouse": "UK",
"shipsFromMultipleWarehouses": true
}
],
"nominatedWarehouseDetails": null
},
"translatedPrimaryCatalogPage": "2194",
"comingSoon": false,
"publishingModule": "en/472686.xml",
"releaseStatusCode": -1,
"isSpecialOrder": false,
"isAwaitingRelease": false,
"reeling": false
}
]
}
}
|
| none |
For example: http://api.element14.com//catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=none&callInfo.omitXmlSchema=false&callInfo.callback=&callInfo.responseDataFormat=json&callinfo.apiKey=gd8n8b2kxqw6jq5mutsbrvur Returns number of results only: {
"keywordSearchReturn": {
"numberOfResults": 7355
}
}
|
Sample Requests
Manufacturer Part Number Search
https://api.element14.com/catalog/products?term=manuPartNum%3ALM339ADT&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=&resultsSettings.responseGroup=small&callInfo.responseDataFormat=JSON
Keyword Search
http://api.element14.com/catalog/products?term=any%3Afuse&storeInfo.id=uk.farnell.com&resultsSettings.offset=0&resultsSettings.numberOfResults=1&resultsSettings.refinements.filters=rohsCompliant%2CinStock&resultsSettings.responseGroup=small&callInfo.responseDataFormat=JSON
API-Specific Errors
| Error | Description |
| 100001 |
Invalid Timestamp |
| 100002 | Internal Failure. Please try after some time or contact the web service provider |
| 100003 | Invalid Password |
| 100004 |
Invalid Customer Details |
| 100005 | Signature Decryption Exception. Please contact the Web Service Admin |
| 100006 | Invalid Timestamp Format |
| 100007 | Invalid Locale |
| 200001 | SKUs not valid |
| 200002 | Could Not Query for the keyword |
| 200003 | Could Not Query for the keyword |
| 200004 | Manufacturer Part Number is not valid |
See Standard HTTP Errors for a list of standard HTTP errors.
