pixiDFGetOrders
This API call returns all open orders for a specific supplier.
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) |
SupplNr | string | false | Supplier number Type: varchar(4) Default value: NULL Example: abcdefg Available from: LOU Official - Update 46 (6.9.46.27927) |
AllOrders | boolean | false | 0 = not confirmed orders are returned; 1 = all orders of the supplier are returned 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="">
<pixiDFGetOrders>
<SupplNr>string</SupplNr>
<Secret>string</Secret>
<AllOrders>true</AllOrders>
</pixiDFGetOrders>
</Body>
</Envelope>
Response
1. Direct fulfilment orders
Name | Type | Description |
---|---|---|
Fax | string | Fax Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
ZIP | string | Postal number Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
Phone | string | Phone Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
string | E-Mail address Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
|
Anrede | string | Salutation Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
CareOf | string | Customer of Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Street | string | Street Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
HouseNr | string | House Number Type: varchar (12) Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
APayment | string | Payment code Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
Discount | number | Discount Type: money Available from: 25.06 (25.6.0.58802) |
LastName | string | Last Name Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
Referrer | string | Referrer Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ShipCost | number | The total shipping costs of the whole order Type: money 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) |
FirstName | string | First Name Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
AddrShopID | string | Shop Id Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
CntCodeISO2 | string | Country code (ISO 2) Type: char Available from: 25.06 (25.6.0.58802) |
CntCodeISO3 | string | Country code (ISO 3) Type: char Available from: 25.06 (25.6.0.58802) |
SubShopName | string | Shop name Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
ShipInstruct | string | Transport remark Type: varchar (255) Available from: 25.06 (25.6.0.58802) |
ShipVendorCode | string | Shipping vendor code Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
AddrNoChargeVAT | boolean | Charge VAT flag Type: bit Available from: 25.06 (25.6.0.58802) |
Address_Remarks | string | Address remark Type: varchar (255) Available from: 25.06 (25.6.0.58802) |
OrderCurrencyCode | string | Currency Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
PartialDeliveryActive | boolean | Partial delivery enabled Type: bit Available from: 25.06 (25.6.0.58802) |
PartialDeliveryMultiple | boolean | Enable multiple partial deliveries Type: bit Available from: 25.06 (25.6.0.58802) |
PartialDeliveryForceCancelAfterShipout | boolean | Cancel the rest of order after partial delivery Type: bit Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiDFGetOrdersPost200TextXmlResponse>
<OrderNr>0</OrderNr>
<Anrede>string</Anrede>
<CareOf>string</CareOf>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Street>string</Street>
<ZIP>string</ZIP>
<HouseNr>string</HouseNr>
<City>string</City>
<Country>string</Country>
<eMail>string</eMail>
<Phone>string</Phone>
<Address_Remarks>string</Address_Remarks>
<ShipInstruct>string</ShipInstruct>
<Shipdate>string</Shipdate>
<ShipVendorCode>string</ShipVendorCode>
<AddrShopID>string</AddrShopID>
<APayment>string</APayment>
<AddrNoChargeVAT>true</AddrNoChargeVAT>
<Discount>0</Discount>
<CntCodeISO2>string</CntCodeISO2>
<CntCodeISO3>string</CntCodeISO3>
<ShipCost>0</ShipCost>
<PartialDeliveryActive>true</PartialDeliveryActive>
<PartialDeliveryForceCancelAfterShipout>true</PartialDeliveryForceCancelAfterShipout>
<PartialDeliveryMultiple>true</PartialDeliveryMultiple>
<OrderCurrencyCode>string</OrderCurrencyCode>
<Fax>string</Fax>
<Referrer>string</Referrer>
<SubShopName>string</SubShopName>
</PixiDFGetOrdersPost200TextXmlResponse>
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:pixiDFGetOrders>
<Secret xsi:type="xsd:string">abcdefg</Secret>
<SupplNr xsi:type="xsd:string">abcdefg</SupplNr>
<AllOrders xsi:type="xsd:boolean">0 or 1</AllOrders>
</ns1:pixiDFGetOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiDFGetOrders', [
'Secret' => 'abcdefg', // string
'SupplNr' => 'abcdefg', // string
'AllOrders' => '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);
}