Description
API call returns item information.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ItemKey |
integer |
0 |
123456 |
Filter: pixi* Item ID |
2 |
ItemNrInt |
string |
0 |
123abc |
Filter: Shop item number |
3 |
EANUPC |
string |
0 |
123abc |
Filter: Item barcode |
4 |
ItemNrSuppl |
string |
0 |
123abc |
Filter: Item number supplier |
5 |
LocID |
string |
0 |
001 |
Filter: Location ID/code |
6 |
ItemXML |
string |
0 |
See additional information |
Filter: XML with multiple defined filters. |
7 |
InternalItemNumber |
string |
0 |
asdf |
Filter: pixi* Internal item number |
8 |
ConsiderFavouriteSupplier |
boolean |
0 |
1 |
Switch: Return data connected to preferred/favourite supplier |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiGetItemInfo>
<dem:ItemKey>123456</dem:ItemKey>
<dem:ItemNrInt>123abc</dem:ItemNrInt>
<dem:EANUPC>123abc</dem:EANUPC>
<dem:ItemNrSuppl>123abc</dem:ItemNrSuppl>
<dem:LocID>001</dem:LocID>
<dem:ItemXML>See additional information</dem:ItemXML>
<dem:InternalItemNumber>asdf</dem:InternalItemNumber>
<dem:ConsiderFavouriteSupplier>1</dem:ConsiderFavouriteSupplier>
</dem:pixiGetItemInfo>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Returning the item information
# |
Name |
Type |
Description |
1 |
ItemKey |
integer |
Item ID |
2 |
SupplPrice |
number |
Supplier price of the item |
3 |
ItemName |
string |
Item name |
4 |
VPE |
string |
Packing unit (LOU version) |
5 |
OrderUnit |
string |
Packing unit |
6 |
MinStockQty |
integer |
Minimum stock quantity. NOTE: Is only shown when @LocId is specified, else it is 0. |
7 |
MinOrderQty |
integer |
Minimum order quantity. NOTE: this is always shown. @LocId not needed. |
8 |
SupplNR |
string |
Item supplier code |
9 |
Category |
string |
Item category |
10 |
ItemNrInt |
string |
Item shop number |
11 |
ItemNrSuppl |
string |
Item supplier number |
12 |
Quantity |
integer |
Item stock quantity |
13 |
PriceVK |
number |
Item price |
14 |
VATLevel |
string |
Item VAT level |
15 |
Enabled |
boolean |
Item state (enabled/disabled) |
16 |
ItemTAGs |
string |
Tags connected to the item |
17 |
EANUPC |
string |
Item barcode |
18 |
ABC |
string |
Item system tag |
19 |
ExportEstimatedDelivery |
string |
Estimated delivery date |
20 |
PicLinkLarge |
string |
Large picture URL |
21 |
PicLinkSmall |
string |
Small picture URL |
22 |
InternalItemNumber |
string |
pixi* internal item number |
23 |
SafetyStock |
integer |
Item safety stock quantity (0 if no LocID provided) |
24 |
TargetStock |
integer |
Item target stock quantity (0 if no LocID provided) |
25 |
ItemDescription |
string |
Item description |
26 |
ImputedSupplierPrice |
number |
Supplier price with added cost of transportation, handling, etc. |
27 |
Weight |
number |
Item weight |
28 |
Heigth |
number |
Item height |
29 |
Width |
number |
Item width |
30 |
Length |
number |
Item length |
31 |
CustomsTariffNumber |
string |
Customs tariff number |
32 |
CustomsCountryOfOrigin |
string |
Country of origin (ISO 3166-1 alpha-2) |
33 |
CustomsTariffText |
string |
Customs tariff description text |
34 |
Manufacturer |
string |
Item manufacturer |
Body 2: Error response
# |
Name |
Type |
Description |
1 |
Error |
string |
Error status |
2 |
ErrorMsg |
string |
Error description |
Additional Notes
**Select multiple items with one call:**
When using **ItemXML** parameter one can get the item info for **multiple items** with one call.
Sample XML structure:
<ITEMS>
<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
<ITEM><EAN>2000000000091</EAN></ITEM>
<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>
<ITEM><INTERNALITEMNUMBER>123456abcdefg</INTERNALITEMNUMBER></ITEM>
</ITEMS>
----------
**Return data from item favourite supplier:**
If parameter **ConsiderFavouriteSupplier** is set to **1** then values for
- EAN
- ItemNrInt
- ItemNrSuppl
- SupplNr
- SupplPrice
- MinOrderQty (if the value is not explicitly set, 0 will be returned)
will be taken from the item record flagged with **PreferredSupplier = 1**.
In case there is no record for the item marked with PreferredSupplier flag, the values from the **default** item record will be returned.