pixiDFGetOrderlines
This API call returns all order lines for a specific order.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Secret | string | false | Customer ID, references table customers. Type: varchar(20) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNR | integer | true | pixi order number Type: int Default value: Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
SupplNr | string | false | Supplier number Type: varchar(4) Default value: NULL Example: abcd Available from: LOU Official - Update 46 (6.9.46.27927) |
AllOrderlines | boolean | false | 0 = not confirmed orderlines in status FUT; 1 = all orderlines in status FUT - incl. the confirmed ones 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="">
<pixiDFGetOrderlines>
<OrderNR>0</OrderNR>
<SupplNr>string</SupplNr>
<Secret>string</Secret>
<AllOrderlines>true</AllOrderlines>
</pixiDFGetOrderlines>
</Body>
</Envelope>
Response
1. Orderlines
Name | Type | Description |
---|---|---|
Qty | integer | Item quantity Type: int Available from: / (25.7.0.59144) |
Price | number | Item's final price Type: money Available from: / (25.7.0.59144) |
EANUPC | string | Item barcode Type: varchar (13) Available from: / (25.7.0.59144) |
Status | string | Order line status Type: varchar (3) Available from: / (25.7.0.59144) |
ArtName | string | Name of the item Type: varchar (120) Available from: / (25.7.0.59144) |
DF_Type | string | Direct Fulfillment type Type: varchar (1) Available from: / (25.7.0.59144) |
ItemRef | integer | Item ID Type: int Available from: / (25.7.0.59144) |
OrderNr | integer | Order number in pixi* Type: int Available from: / (25.7.0.59144) |
ItemNrInt | string | Shop item number Type: varchar (50) Available from: / (25.7.0.59144) |
OrderDate | string | Order date Type: datetime Available from: / (25.7.0.59144) |
SupplInfo | string | Supplier number of the supplier that is assigned to the order line Type: varchar (4) Available from: / (25.7.0.59144) |
ItemNrSuppl | string | Supplier item number Type: varchar (50) Available from: / (25.7.0.59144) |
OrderHistKey | integer | Unique key for the confirmation of an orderline by the DF supplier Type: int Available from: / (25.7.0.59144) |
OrderLineRef | integer | Order line ID Type: int Available from: / (25.7.0.59144) |
itemNrExternal | string | Item number external (Imported from Shop) Type: varchar (50) Available from: / (25.7.0.59144) |
OrderNrExternal | string | External order number Type: varchar (50) Available from: / (25.7.0.59144) |
StatusChangeDate | string | Order line status change date Type: datetime Available from: / (25.7.0.59144) |
oItemSpecialNote | string | Item note Type: varchar (8000) Available from: / (25.7.0.59144) |
InvoiceNrExternal | string | External invoice number that was set for the order line Type: varchar (20) Available from: / (25.7.0.59144) |
OrderCurrencyCode | string | Order's currency code Type: varchar (3) Available from: / (25.7.0.59144) |
BundleOrderlineRef | integer | Bundle order line ID Type: int Available from: / (25.7.0.59144) |
OrderlineConfirmed | string | Flag which is set by the supplier to confirm the order line Type: char Available from: / (25.7.0.59144) |
Response Example
<PixiDFGetOrderlinesPost200TextXmlResponse>
<OrderLineRef>0</OrderLineRef>
<OrderNr>0</OrderNr>
<ArtName>string</ArtName>
<EANUPC>string</EANUPC>
<ItemNrSuppl>string</ItemNrSuppl>
<itemNrExternal>string</itemNrExternal>
<Qty>0</Qty>
<Price>0</Price>
<Status>string</Status>
<OrderHistKey>0</OrderHistKey>
<StatusChangeDate>string</StatusChangeDate>
<OrderDate>string</OrderDate>
<OrderNrExternal>string</OrderNrExternal>
<oItemSpecialNote>string</oItemSpecialNote>
<SupplInfo>string</SupplInfo>
<InvoiceNrExternal>string</InvoiceNrExternal>
<DF_Type>string</DF_Type>
<ItemRef>0</ItemRef>
<OrderlineConfirmed>string</OrderlineConfirmed>
<OrderCurrencyCode>string</OrderCurrencyCode>
<BundleOrderlineRef>0</BundleOrderlineRef>
<ItemNrInt>string</ItemNrInt>
</PixiDFGetOrderlinesPost200TextXmlResponse>
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:pixiDFGetOrderlines>
<Secret xsi:type="xsd:string">abcdefg</Secret>
<OrderNR xsi:type="xsd:integer">123</OrderNR> <!-- required -->
<SupplNr xsi:type="xsd:string">abcd</SupplNr>
<AllOrderlines xsi:type="xsd:boolean">0 or 1</AllOrderlines>
</ns1:pixiDFGetOrderlines>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiDFGetOrderlines', [
'Secret' => 'abcdefg', // string
'OrderNR' => '123', // integer (required)
'SupplNr' => 'abcd', // string
'AllOrderlines' => '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);
}