pixiDispoGetItems
Deprecated
Exports various item information (name, default supplier, current stock, price, supplier price, ..)
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ItemCount | integer | false | Amount of returned items. The limitation is set on the item level. So in case of 2 locations, the reslut lines will double Type: int Default value: 1000 Example: 200 Available from: 21.01 (9.0.23.54983) |
LocationIds | string | false | Comma separated list of Locations Type: varchar(-1) Default value: NULL Example: 001,002 Available from: AVA Official - Update 7 (8.4.7.23158) |
ItemKeyStart | integer | false | Item ID (ItemKey) to start with Type: int Default value: 0 Example: 1234 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiDispoGetItems>
<ItemKeyStart>0</ItemKeyStart>
<LocationIds>string</LocationIds>
<ItemCount>0</ItemCount>
</pixiDispoGetItems>
</Body>
</Envelope>
Response
1. List of items
Name | Type | Description |
---|---|---|
Typ | string | "0100" maintainig backvards compatibility for some applications Type: varchar (4) Available from: 25.06 (25.6.0.58802) |
VPE | string | Package unit Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
Tags | string | Tags assosiated with an item Type: varchar (4000) Available from: 25.06 (25.6.0.58802) |
Price | string | Item price Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
ACTIVE | boolean | Item enabled/active flag 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 (4) Available from: 25.06 (25.6.0.58802) |
ITemName | string | Item name Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
IsBundle | boolean | Item is bunde flag Type: bit Available from: 25.06 (25.6.0.58802) |
Quantity | integer | Summarized item quantity (excluding special stock locations) Type: int Available from: 25.06 (25.6.0.58802) |
VATLevel | string | VAT level (L - Low, H - High, 0 -Zero) Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Date when item first appeard on a customer order Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
SupplName | string | Supplier name Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
TontrText | string | Name of the category Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
ExportDate | string | Date of API execution Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
LocationId | string | Location ID Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
SupplPrice | string | Supplier price of the item Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar (50) 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) |
SafetyStock | integer | Item safety stock quantity Type: int Available from: 25.06 (25.6.0.58802) |
TargetStock | integer | Item target stock quantity Type: int Available from: 25.06 (25.6.0.58802) |
LocationQuantity | integer | Location quantity Type: int Available from: 25.06 (25.6.0.58802) |
SupplierDeliveryDays | integer | Supplier default delivery days Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiDispoGetItemsPost200TextXmlResponse>
<ItemKey>0</ItemKey>
<SupplPrice>string</SupplPrice>
<ITemName>string</ITemName>
<VPE>string</VPE>
<MinStockQty>0</MinStockQty>
<MinOrderQty>0</MinOrderQty>
<SupplNr>string</SupplNr>
<TontrText>string</TontrText>
<ItemNrInt>string</ItemNrInt>
<ItemNrSuppl>string</ItemNrSuppl>
<Quantity>0</Quantity>
<ExportDate>string</ExportDate>
<Typ>string</Typ>
<SupplName>string</SupplName>
<CreateDate>string</CreateDate>
<OrderDate>string</OrderDate>
<Tags>string</Tags>
<SupplierDeliveryDays>0</SupplierDeliveryDays>
<ACTIVE>true</ACTIVE>
<Price>string</Price>
<VATLevel>string</VATLevel>
<IsBundle>true</IsBundle>
<LocationId>string</LocationId>
<LocationQuantity>0</LocationQuantity>
<TargetStock>0</TargetStock>
<SafetyStock>0</SafetyStock>
</PixiDispoGetItemsPost200TextXmlResponse>
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:pixiDispoGetItems>
<ItemCount xsi:type="xsd:integer">200</ItemCount>
<LocationIds xsi:type="xsd:string">001,002</LocationIds>
<ItemKeyStart xsi:type="xsd:integer">1234</ItemKeyStart>
</ns1:pixiDispoGetItems>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiDispoGetItems', [
'ItemCount' => '200', // integer
'LocationIds' => '001,002', // string
'ItemKeyStart' => '1234', // integer
]);
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);
}