pixiGetOrderlineExtended
Retrieve Orderlines based on several filters.
Since pixi version: 21.06 (21.6.0.58890) 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><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>
<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
</ITEMS>
ITEMNRSUPPL should be used only if it is unique on database.
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShopID | string | false | Shop ID Type: varchar(3) Default value: Example: abcdefg Available from: 21.06 (21.6.0.58890) |
Status | string | false | Orderline status Type: varchar(3) Default value: Example: abcdefg Available from: 21.06 (21.6.0.58890) |
ItemXML | string | false | See additional information for XML structure Type: varchar(-1) Default value: Example: See additional information for XML structure Available from: 21.06 (21.6.0.58890) |
OrderNR | integer | false | pixi order number Type: int Default value: Example: 123 Available from: 21.06 (21.6.0.58890) |
RowCount | integer | false | Maximum number of rows returned Type: int Default value: 1000 Example: 123 Available from: 21.06 (21.6.0.58890) |
InvoiceNr | string | false | Invoice number Type: varchar(50) Default value: Example: abcdefg Available from: 21.06 (21.6.0.58890) |
IsStartKey | boolean | false | Start parameter for OrderlineKey Type: bit Default value: 0 Example: 0 or 1 Available from: 21.06 (21.6.0.58890) |
OrderDateTo | string | false | End of order date range Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: 21.06 (21.6.0.58890) |
PaymentType | string | false | Payment TYPE, references table payments Type: char Default value: Example: Single character : "g" Available from: 21.06 (21.6.0.58890) |
OrderlineKey | integer | false | Order line ID, references table Orderlines Type: int Default value: Example: 123 Available from: 21.06 (21.6.0.58890) |
UpdateDateTo | string | false | End of the date range when order line was updated Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: 21.06 (21.6.0.58890) |
OrderDateFrom | string | false | Beginning of the order date range Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: 21.06 (21.6.0.58890) |
ShowOrderlines | boolean | false | Force to return Orderlinekey in case of bundle Type: bit Default value: 0 Example: 0 or 1 Available from: 21.06 (21.6.0.58890) |
UpdateDateFrom | string | false | Beginning of the date range when order line was updated Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: 21.06 (21.6.0.58890) |
OrderNRExternal | string | false | Shop order number Type: varchar(50) Default value: Example: abcdefg Available from: 21.06 (21.6.0.58890) |
IsReplacementOnly | boolean | false | Show only replacement Orderlines Type: bit Default value: 0 Example: 0 Available from: 22.09 (22.9.0.30861) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetOrderlineExtended>
<OrderlineKey>0</OrderlineKey>
<OrderNR>0</OrderNR>
<OrderNRExternal>string</OrderNRExternal>
<Status>string</Status>
<ShopID>string</ShopID>
<PaymentType>string</PaymentType>
<OrderDateFrom>string</OrderDateFrom>
<OrderDateTo>string</OrderDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<RowCount>0</RowCount>
<InvoiceNr>string</InvoiceNr>
<ShowOrderlines>true</ShowOrderlines>
<IsStartKey>true</IsStartKey>
<ItemXML>string</ItemXML>
<IsReplacementOnly>true</IsReplacementOnly>
</pixiGetOrderlineExtended>
</Body>
</Envelope>
Response
1. Get Orderline Overview
Name | Type | Description |
---|---|---|
Qty | integer | Qty Type: int Available from: 25.06 (25.6.0.58802) |
Price | number | 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) |
Status | string | Status Type: varchar Available from: 25.06 (25.6.0.58802) |
ArtName | string | Name of the item Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemRef | integer | Item ID Type: int Available from: 25.06 (25.6.0.58802) |
OrderNR | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
VATRate | string | Text representation of high/low/zero VAT Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipDate | string | Ship this order at this date only! not before Type: datetime Available from: 25.06 (25.6.0.58802) |
FullPrice | number | Full price Type: money Available from: 25.06 (25.6.0.58802) |
ItemNrInt | string | Shop item number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Order date Type: datetime Available from: 25.06 (25.6.0.58802) |
TaxAmount | number | VAT amount Type: money Available from: 25.06 (25.6.0.58802) |
DFShipDate | string | DF ship date Type: datetime Available from: 25.06 (25.6.0.58802) |
LocationID | string | Location code of item Type: varchar Available from: 25.06 (25.6.0.58802) |
PicklistNr | integer | Item on picklist Type: int Available from: 25.06 (25.6.0.58802) |
PriceNoVAT | number | Price no VAT Type: money Available from: 25.06 (25.6.0.58802) |
StatusText | string | Status text Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | Last update date of the record Type: datetime Available from: 25.06 (25.6.0.58802) |
OrderStatus | string | Order status Type: varchar Available from: 25.06 (25.6.0.58802) |
DiscountPerc | number | Discount percent Type: numeric Available from: 25.06 (25.6.0.58802) |
OrderlineKey | integer | ID for the orderline record Type: int Available from: 25.06 (25.6.0.58802) |
PicLinkLarge | string | Large picture URL Type: varchar Available from: 25.06 (25.6.0.58802) |
DiscountValue | number | Discount value Type: money Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order currency Type: varchar Available from: 25.06 (25.6.0.58802) |
ReservedCount | number | Reserved count Type: numeric Available from: 25.06 (25.6.0.58802) |
VATPercentage | number | VAT percentage Type: numeric Available from: 25.06 (25.6.0.58802) |
ItemNrExternal | string | Item number external (Imported from shop) Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | External order number Type: varchar Available from: 25.06 (25.6.0.58802) |
FullPriceForItem | number | Full price for item Type: money Available from: 25.06 (25.6.0.58802) |
oItemSpecialNote | string | oItem special note Type: varchar Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Estimated delivery Type: datetime Available from: 25.06 (25.6.0.58802) |
AvailStockOrderLine | integer | Avail stock orderLine Type: int Available from: 25.06 (25.6.0.58802) |
DFShipmentTrackingID | string | Direct fullfilement shipment tracking ID Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetOrderlineExtendedPost200TextXmlResponse>
<OrderlineKey>0</OrderlineKey>
<ArtName>string</ArtName>
<Qty>0</Qty>
<Price>0</Price>
<Status>string</Status>
<StatusText>string</StatusText>
<ItemNrExternal>string</ItemNrExternal>
<OrderNR>0</OrderNR>
<OrderNrExternal>string</OrderNrExternal>
<OrderCurrency>string</OrderCurrency>
<OrderDate>string</OrderDate>
<UpdateDate>string</UpdateDate>
<ItemRef>0</ItemRef>
<oItemSpecialNote>string</oItemSpecialNote>
<DiscountValue>0</DiscountValue>
<DiscountPerc>0</DiscountPerc>
<FullPrice>0</FullPrice>
<FullPriceForItem>0</FullPriceForItem>
<VATRate>string</VATRate>
<PriceNoVAT>0</PriceNoVAT>
<ItemNrInt>string</ItemNrInt>
<ShipDate>string</ShipDate>
<DFShipDate>string</DFShipDate>
<DFShipmentTrackingID>string</DFShipmentTrackingID>
<AvailStockOrderLine>0</AvailStockOrderLine>
<EstimatedDelivery>string</EstimatedDelivery>
<EANUPC>string</EANUPC>
<ReservedCount>0</ReservedCount>
<PicLinkLarge>string</PicLinkLarge>
<LocationID>string</LocationID>
<TaxAmount>0</TaxAmount>
<VATPercentage>0</VATPercentage>
<OrderStatus>string</OrderStatus>
<PicklistNr>0</PicklistNr>
</PixiGetOrderlineExtendedPost200TextXmlResponse>
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:pixiGetOrderlineExtended>
<ShopID xsi:type="xsd:string">abcdefg</ShopID>
<Status xsi:type="xsd:string">abcdefg</Status>
<ItemXML xsi:type="xsd:string">See additional information for XML structure</ItemXML>
<OrderNR xsi:type="xsd:integer">123</OrderNR>
<RowCount xsi:type="xsd:integer">123</RowCount>
<InvoiceNr xsi:type="xsd:string">abcdefg</InvoiceNr>
<IsStartKey xsi:type="xsd:boolean">0 or 1</IsStartKey>
<OrderDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</OrderDateTo>
<PaymentType xsi:type="xsd:string">Single character : "g"</PaymentType>
<OrderlineKey xsi:type="xsd:integer">123</OrderlineKey>
<UpdateDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateTo>
<OrderDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</OrderDateFrom>
<ShowOrderlines xsi:type="xsd:boolean">0 or 1</ShowOrderlines>
<UpdateDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UpdateDateFrom>
<OrderNRExternal xsi:type="xsd:string">abcdefg</OrderNRExternal>
<IsReplacementOnly xsi:type="xsd:boolean">0</IsReplacementOnly>
</ns1:pixiGetOrderlineExtended>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetOrderlineExtended', [
'ShopID' => 'abcdefg', // string
'Status' => 'abcdefg', // string
'ItemXML' => 'See additional information for XML structure', // string
'OrderNR' => '123', // integer
'RowCount' => '123', // integer
'InvoiceNr' => 'abcdefg', // string
'IsStartKey' => '0 or 1', // boolean
'OrderDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'PaymentType' => 'Single character : "g"', // string
'OrderlineKey' => '123', // integer
'UpdateDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'ShowOrderlines' => '0 or 1', // boolean
'UpdateDateFrom' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderNRExternal' => 'abcdefg', // string
'IsReplacementOnly' => '0', // 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);
}