pixiGetDeliveryItem
Get Delivery Item for Deliveries
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTo | string | false | Delivery line "Create date" filter. Show delivery lines older than @DateTo. Type: datetime Default value: NULL Example: 2017-01-31 23:23:59.996 Available from: AVA 17.03 (8.4.27.29272) |
EANUPC | string | false | Load only deliveries for a specific EANUPC Type: varchar(13) Default value: NULL Example: 1234ABC Available from: LOU Official - Update 46 (6.9.46.27927) |
Offset | integer | false | To be used together with RowCount for paginaton. Use last SDelDkey from results to get next. Type: int Default value: 0 Example: 100 Available from: LOU Official - Update 46 (6.9.46.27927) |
DateFrom | string | false | Delivery line "Create date" filter. Show delivery lines younger than @DateFrom. Type: datetime Default value: NULL Example: 2017-01-01 00:00:00.000 Available from: AVA 17.03 (8.4.27.29272) |
RowCount | integer | false | Number of rows returned Type: int Default value: 100 Example: 100 Available from: LOU Official - Update 46 (6.9.46.27927) |
SDelHKey | integer | false | Reference to a specific delivery (ID) Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
DeliveryNumber | integer | false | Reference to a specific delivery (DeliveryNumber) Type: int Default value: NULL Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
ItemNrInternal | string | false | Load only deliveries for a specific ItemNrInternal Type: varchar(50) Default value: NULL Example: 1234ABC Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetDeliveryItem>
<SDelHKey>0</SDelHKey>
<DeliveryNumber>0</DeliveryNumber>
<ItemNrInternal>string</ItemNrInternal>
<EANUPC>string</EANUPC>
<RowCount>0</RowCount>
<Offset>0</Offset>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
</pixiGetDeliveryItem>
</Body>
</Envelope>
Response
1. Delivery items details
Name | Type | Description |
---|---|---|
EK | number | Original supplier price Type: money Available from: 25.06 (25.6.0.58802) |
EANUPC | string | Item barcode Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemKey | integer | pixi item ID Type: int Available from: 25.06 (25.6.0.58802) |
Discount | number | Delivery item discount in percents Type: money Available from: 25.06 (25.6.0.58802) |
ItemName | string | Item name Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemTAGs | string | Item tags Type: varchar Available from: 25.06 (25.6.0.58802) |
MidPrice | number | Discounted price for the item Type: money Available from: 25.06 (25.6.0.58802) |
SDelDkey | integer | Delivery detail ID Type: int Available from: 25.06 (25.6.0.58802) |
SDelHKey | integer | Delivery header ID 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) |
FinalPrice | number | Final discounted price for the item, including the delivery discount Type: money Available from: 25.06 (25.6.0.58802) |
OrderedQty | number | Ordered quantity Type: money Available from: 25.06 (25.6.0.58802) |
BatchNumber | string | Batch number Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Default item number supplier Type: varchar Available from: 25.06 (25.6.0.58802) |
DeliveredQty | number | Delivered quantity Type: money Available from: 25.06 (25.6.0.58802) |
PicLinkLarge | string | Large picture URL Type: varchar Available from: 25.06 (25.6.0.58802) |
PicLinkSmall | string | Small picture URL Type: varchar Available from: 25.06 (25.6.0.58802) |
BestBeforeDate | string | Best before date Type: datetime Available from: 25.06 (25.6.0.58802) |
DeliveryNumber | integer | Delivery number Type: int Available from: 25.06 (25.6.0.58802) |
DeliveryItemNrSuppl | string | Item number supplier connected to delivery Type: varchar Available from: 25.06 (25.6.0.58802) |
BatchManagementDetails | string | Batch number amd Best before date data if there are multiple. Data included in XML:
Type: XML Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetDeliveryItemPost200TextXmlResponse>
<SDelDkey>0</SDelDkey>
<DeliveryNumber>0</DeliveryNumber>
<SDelHKey>0</SDelHKey>
<ItemKey>0</ItemKey>
<ItemNrInt>string</ItemNrInt>
<ItemNrSuppl>string</ItemNrSuppl>
<DeliveryItemNrSuppl>string</DeliveryItemNrSuppl>
<ItemName>string</ItemName>
<EANUPC>string</EANUPC>
<DeliveredQty>0</DeliveredQty>
<OrderedQty>0</OrderedQty>
<MidPrice>0</MidPrice>
<Discount>0</Discount>
<EK>0</EK>
<FinalPrice>0</FinalPrice>
<ItemTAGs>string</ItemTAGs>
<PicLinkLarge>string</PicLinkLarge>
<PicLinkSmall>string</PicLinkSmall>
<BatchNumber>string</BatchNumber>
<BestBeforeDate>string</BestBeforeDate>
<BatchManagementDetails>string</BatchManagementDetails>
</PixiGetDeliveryItemPost200TextXmlResponse>
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:pixiGetDeliveryItem>
<DateTo xsi:type="xsd:string">2017-01-31 23:23:59.996</DateTo>
<EANUPC xsi:type="xsd:string">1234ABC</EANUPC>
<Offset xsi:type="xsd:integer">100</Offset>
<DateFrom xsi:type="xsd:string">2017-01-01 00:00:00.000</DateFrom>
<RowCount xsi:type="xsd:integer">100</RowCount>
<SDelHKey xsi:type="xsd:integer">123</SDelHKey>
<DeliveryNumber xsi:type="xsd:integer">123</DeliveryNumber>
<ItemNrInternal xsi:type="xsd:string">1234ABC</ItemNrInternal>
</ns1:pixiGetDeliveryItem>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetDeliveryItem', [
'DateTo' => '2017-01-31 23:23:59.996', // string
'EANUPC' => '1234ABC', // string
'Offset' => '100', // integer
'DateFrom' => '2017-01-01 00:00:00.000', // string
'RowCount' => '100', // integer
'SDelHKey' => '123', // integer
'DeliveryNumber' => '123', // integer
'ItemNrInternal' => '1234ABC', // string
]);
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);
}