pixiItemSearch
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Filter: Location ID Type: varchar(3) Default value: 001 Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
EANUPC | string | false | Filter: Item barcode Type: varchar(13) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplNr | string | false | Filter: Supplier code Type: varchar(4) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
ItemName | string | false | Filter: Item name Type: varchar(100) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
RowCount | integer | false | Amount of row to be returned (0 = all) Type: int Default value: 0 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
ConfigType | string | false | Filter: Category ID Type: varchar(4) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
ShowOnlyItemsForExactSupplier | boolean | false | Switch: Return only items for exact supplier Type: bit Default value: 0 Example: 0 or 1 Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiItemSearch>
<RowCount>0</RowCount>
<ItemName>string</ItemName>
<ConfigType>string</ConfigType>
<SupplNr>string</SupplNr>
<EANUPC>string</EANUPC>
<LocID>string</LocID>
<ShowOnlyItemsForExactSupplier>true</ShowOnlyItemsForExactSupplier>
</pixiItemSearch>
</Body>
</Envelope>
Response
1. Item data
Name | Type | Description |
---|---|---|
L30 | integer | Item demand in last 30 days Type: int Available from: 25.06 (25.6.0.58802) |
UPC | string | Item UPC code Type: varchar Available from: 25.06 (25.6.0.58802) |
VAT | number | VAT rate Type: decimal Available from: 25.06 (25.6.0.58802) |
L120 | integer | Item demand in last 120 days Type: int Available from: 25.06 (25.6.0.58802) |
L365 | integer | Item demand in last 365 days Type: int Available from: 25.06 (25.6.0.58802) |
Price | number | Item price with VAT Type: decimal Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar Available from: 25.06 (25.6.0.58802) |
Weight | number | Weight in grams Type: decimal Available from: 25.06 (25.6.0.58802) |
Enabled | boolean | Item is enabled/disabled indicator Type: bit Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | pixi* item ID Type: int Available from: 25.06 (25.6.0.58802) |
SupplNr | string | Supplier number (code) Type: varchar Available from: 25.06 (25.6.0.58802) |
IsBundle | boolean | Indicator if item is a bundle item Type: bit Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar Available from: 25.06 (25.6.0.58802) |
MwStSatz | string | VAT (High, Low, Zero) Type: smallint Available from: 25.06 (25.6.0.58802) |
Quantity | integer | Item quantity that will be exported to external systems Type: int Available from: 25.06 (25.6.0.58802) |
Selected | boolean | Deprecated - always returns 0 Type: bit Available from: 25.06 (25.6.0.58802) |
TitleRef | integer | Deprecated field Type: int Available from: 25.06 (25.6.0.58802) |
ArtistRef | integer | Deprecated field Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar Available from: 25.06 (25.6.0.58802) |
MusicType | string | Deprecated field Type: varchar Available from: 25.06 (25.6.0.58802) |
Price_Net | number | Item price without VAT Type: decimal Available from: 25.06 (25.6.0.58802) |
TonTrText | string | Name of the category Type: varchar Available from: 25.06 (25.6.0.58802) |
ConfigType | string | Category ID Type: varchar Available from: 25.06 (25.6.0.58802) |
CurrencyID | string | Item price currency ID Type: smallint Available from: 25.06 (25.6.0.58802) |
Hal_Cust_O | integer | Number of orders on status HAL that include this item Type: int Available from: 25.06 (25.6.0.58802) |
IntLinkNr1 | integer | Internal link number Type: int Available from: 25.06 (25.6.0.58802) |
SupplPrice | number | Supplier price of the item Type: money Available from: 25.06 (25.6.0.58802) |
Curr_Source | string | Item price currency code Type: varchar Available from: 25.06 (25.6.0.58802) |
IsAvailable | integer | Indicator that items min stock is not negative Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar Available from: 25.06 (25.6.0.58802) |
MinOrderQty | integer | Minimum order quantity for the item Type: int Available from: 25.06 (25.6.0.58802) |
MinStockQty | integer | Minimum stock quantity for the item Type: int Available from: 25.06 (25.6.0.58802) |
Open_Cust_O | integer | Number of open orders that include this item Type: int Available from: 25.06 (25.6.0.58802) |
Manufacturer | string | Manufacturer name Type: varchar Available from: 25.06 (25.6.0.58802) |
Open_Suppl_O | integer | Number of open supplier orders that include this item Type: int Available from: 25.06 (25.6.0.58802) |
DispoSelected | boolean | Deprecated - always returns 0 Type: bit Available from: 25.06 (25.6.0.58802) |
BundleItemsCnt | integer | Number of appearences in different bundle items Type: int Available from: 25.06 (25.6.0.58802) |
SOrderlinesNote | string | Supplier orderline note Type: varchar Available from: 25.06 (25.6.0.58802) |
SummaryQuantity | integer | Complette Item quantity Type: int Available from: 25.06 (25.6.0.58802) |
InternalItemCode | string | pixi* internal item code Type: varchar Available from: 25.06 (25.6.0.58802) |
LocationQuantity | integer | Item quantity on selected location Type: int Available from: 25.06 (25.6.0.58802) |
SupplPriceCurrency | string | Supplier price currency code Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplPriceCurrencyId | string | Supplier price currency ID Type: smallint Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiItemSearchPost200TextXmlResponse>
<ItemKey>0</ItemKey>
<ItemName>string</ItemName>
<ItemNrInt>string</ItemNrInt>
<TonTrText>string</TonTrText>
<IntLinkNr1>0</IntLinkNr1>
<MwStSatz>string</MwStSatz>
<EANUPC>string</EANUPC>
<UPC>string</UPC>
<ItemNrSuppl>string</ItemNrSuppl>
<SupplNr>string</SupplNr>
<ConfigType>string</ConfigType>
<Price>0</Price>
<Price_Net>0</Price_Net>
<CurrencyID>string</CurrencyID>
<Curr_Source>string</Curr_Source>
<MusicType>string</MusicType>
<TitleRef>0</TitleRef>
<ArtistRef>0</ArtistRef>
<SupplPrice>0</SupplPrice>
<SupplPriceCurrencyId>string</SupplPriceCurrencyId>
<SupplPriceCurrency>string</SupplPriceCurrency>
<Enabled>true</Enabled>
<Manufacturer>string</Manufacturer>
<MinOrderQty>0</MinOrderQty>
<MinStockQty>0</MinStockQty>
<SummaryQuantity>0</SummaryQuantity>
<LocationQuantity>0</LocationQuantity>
<BundleItemsCnt>0</BundleItemsCnt>
<Weight>0</Weight>
<VAT>0</VAT>
<Hal_Cust_O>0</Hal_Cust_O>
<Open_Cust_O>0</Open_Cust_O>
<Open_Suppl_O>0</Open_Suppl_O>
<SOrderlinesNote>string</SOrderlinesNote>
<L30>0</L30>
<L120>0</L120>
<L365>0</L365>
<IsAvailable>0</IsAvailable>
<Selected>true</Selected>
<DispoSelected>true</DispoSelected>
<InternalItemCode>string</InternalItemCode>
<IsBundle>true</IsBundle>
<Quantity>0</Quantity>
</PixiItemSearchPost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiItemSearch>
<LocID xsi:type="xsd:string">abcdefg</LocID>
<EANUPC xsi:type="xsd:string">abcdefg</EANUPC>
<SupplNr xsi:type="xsd:string">abcdefg</SupplNr>
<ItemName xsi:type="xsd:string">abcdefg</ItemName>
<RowCount xsi:type="xsd:integer">123</RowCount>
<ConfigType xsi:type="xsd:string">abcdefg</ConfigType>
<ShowOnlyItemsForExactSupplier xsi:type="xsd:boolean">0 or 1</ShowOnlyItemsForExactSupplier>
</ns1:pixiItemSearch>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiItemSearch', [
'LocID' => 'abcdefg', // string
'EANUPC' => 'abcdefg', // string
'SupplNr' => 'abcdefg', // string
'ItemName' => 'abcdefg', // string
'RowCount' => '123', // integer
'ConfigType' => 'abcdefg', // string
'ShowOnlyItemsForExactSupplier' => '0 or 1', // boolean
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}