Version 1.5
The required version should be set in the element in the Header of the request – ‘versionInfo’. v1.5 has been added to (1) allow Exact Manufacturer Part Number Matching, (2) Include Category Name and Path, Non-Cancellable/Non-Returnable Information and relevant Re-reeling charges, (3) present Stock Level information in an array.
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.5</v1:versionNumber> </v1:versionInfo> |
Manufacturer Part Number Matches Filter
|
|
Elements |
Description |
Example |
|
1 |
manufacturerPartNumber /RefinementParameters /exactMatch |
The exactMatch determines whether search against Manufacturer Part Number results will include all matches or exact matches only. . |
<v1:RefinementParameters> <v1:exactMatch>true</v1:exactMatch> </v1:RefinementParameters> |
New / Updated Response Elements
|
|
Elements |
Description |
Example |
|
1 |
products/attributes |
This shows when a product is Non Cancellable and Non Returnable. . |
{ "attributeLabel": "nonCancellableNonReturnable", "attributeValue": "True" }, |
|
2 |
products/categories |
This is the Category Name and the Category Hierarchy that the product is classed under. . |
<ns1:categories> <ns1:name>Batteries - Rechargeable</ns1:name> <ns1:path>Batteries & Chargers</ns1:path> <ns1:path>Batteries - Rechargeable</ns1:path> </ns1:categories> |
|
3 |
products/reReelingCharge |
Shows the re-reeling charge applicable to the Customer on purchase.
|
When applicable - <ns1:products> <ns1:packageName>Re-Reel</ns1:packageName> <ns1:reReelingCharge>3.5</ns1:reReelingCharge> </ns1:products>
When not applicable – <ns1:products> <ns1:packageName>Re-Reel</ns1:packageName> </ns1:products> |
Prices
|
|
Elements |
Description |
Example |
|
1 |
products/prices |
Prices will include only the range that meet the translatedMinimumOrderQuality |
If the translatedMinimumOrderQuality = 10, the entire list is included. "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 } ] If the translatedMinimumOrderQuality = 1,000, the list will include only the last 2 ranges from 1,000 and upwards. "prices": [ { "to": 2990, "from": 1000, "cost": 0.48 }, { "to": 1000000000, "from": 3000, "cost": 0.45 |
.