pixiGetOrderlinesForOrder
Deprecated
et totals equal to what the invoice would produce from the order
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
OrderNr | integer | false | pixi* order number Type: int Default value: Example: 123 Available from: LOU Official (6.3.0.4452) |
OrderXML | string | false | XML with pixi order number and order line IDs Type: varchar(-1) Default value: Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
ReturnBundle | boolean | false | When specified it overrides the setting "APIBundleOrderlines" and whne set to True it returns bundle as one BundleOrderline or when False returns separate orderlines. Type: bit Default value: 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="">
<pixiGetOrderlinesForOrder>
<OrderNr>0</OrderNr>
<OrderXML>string</OrderXML>
<ReturnBundle>true</ReturnBundle>
</pixiGetOrderlinesForOrder>
</Body>
</Envelope>
Response
Name | Type | Description |
---|---|---|
Qty | integer | Type: int Available from: 25.06 (25.6.0.58802) |
Price | number | Type: money Available from: 25.06 (25.6.0.58802) |
Status | string | Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
ArtName | string | Name of the item Type: varchar (120) 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 | Type: varchar (1) 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 | Type: money 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 | Type: datetime Available from: 25.06 (25.6.0.58802) |
DFShipDate | string | Type: datetime Available from: 25.06 (25.6.0.58802) |
PriceNoVAT | number | Type: money Available from: 25.06 (25.6.0.58802) |
StatusText | string | Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | Supplier item number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
DiscountPerc | number | 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) |
DiscountValue | number | Type: money Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
ReservedCount | integer | Type: int Available from: 25.06 (25.6.0.58802) |
ItemNrExternal | string | Item number external (Imported from Shop) Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | External order number Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
oItemSpecialNote | string | Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
AvailStockOrderLine | integer | Type: int Available from: 25.06 (25.6.0.58802) |
DFShipmentTrackingID | string | Direct fullfilement shipment tracking ID Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetOrderlinesForOrderPost200TextXmlResponse>
<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>
<ItemRef>0</ItemRef>
<oItemSpecialNote>string</oItemSpecialNote>
<DiscountValue>0</DiscountValue>
<DiscountPerc>0</DiscountPerc>
<FullPrice>0</FullPrice>
<VATRate>string</VATRate>
<PriceNoVAT>0</PriceNoVAT>
<AvailStockOrderLine>0</AvailStockOrderLine>
<ItemNrInt>string</ItemNrInt>
<ShipDate>string</ShipDate>
<DFShipDate>string</DFShipDate>
<DFShipmentTrackingID>string</DFShipmentTrackingID>
<ReservedCount>0</ReservedCount>
<ItemNrSuppl>string</ItemNrSuppl>
</PixiGetOrderlinesForOrderPost200TextXmlResponse>
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:pixiGetOrderlinesForOrder>
<OrderNr xsi:type="xsd:integer">123</OrderNr>
<OrderXML xsi:type="xsd:string">abcdefg</OrderXML>
<ReturnBundle xsi:type="xsd:boolean">0 or 1</ReturnBundle>
</ns1:pixiGetOrderlinesForOrder>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetOrderlinesForOrder', [
'OrderNr' => '123', // integer
'OrderXML' => 'abcdefg', // string
'ReturnBundle' => '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);
}