pixiReportOrderOverview
Report with an overview of orders with billing address information, totals and gross profit. Gross Profit is calculated from standard supplier price at the time of order - not comparable with other reports in pixi!
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RowCount | integer | false | Nr of Rows to return Type: int Default value: 1000 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderDateTo | string | false | Filter order until orderdate. Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNrStart | integer | false | Start Orders with OrderNr X or higher Type: int Default value: Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderDateFrom | string | false | Filter order from orderdate. Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReportOrderOverview>
<OrderDateFrom>string</OrderDateFrom>
<OrderDateTo>string</OrderDateTo>
<OrderNrStart>0</OrderNrStart>
<RowCount>0</RowCount>
</pixiReportOrderOverview>
</Body>
</Envelope>
Response
1. Report Order Overview
Name | Type | Description |
---|---|---|
ZIP | string | ZIP 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) |
Name | string | Name Type: varchar (121) 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 | Anrede Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
CareOf | string | Care Of Type: varchar (60) Available from: 25.06 (25.6.0.58802) |
ShopID | string | Shop ID Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
Address | string | Address Type: varchar (110) Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
OrderNR | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
Discount | number | Discount Type: money 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) |
OrderDate | string | Order Date Type: datetime Available from: 25.06 (25.6.0.58802) |
Shop_Note | string | Shop Note Type: varchar (-1) Available from: 25.06 (25.6.0.58802) |
OrderTotal | number | Order Total Type: money Available from: 25.06 (25.6.0.58802) |
GiftMessage | string | Gift Message Type: varchar (8000) Available from: 25.06 (25.6.0.58802) |
OrderStatus | string | Order Status Type: varchar (10) Available from: 25.06 (25.6.0.58802) |
PaymentCode | string | Payment Code Type: varchar (1) Available from: 25.06 (25.6.0.58802) |
CurrencyCode | string | Currency code Type: varchar (3) Available from: 25.06 (25.6.0.58802) |
Address_Remarks | string | Address Remarks Type: varchar (255) Available from: 25.06 (25.6.0.58802) |
OrderLinesTotal | number | Order Lines Total Type: money Available from: 25.06 (25.6.0.58802) |
GrossProfit_Netto | number | Gross Profit Netto Type: money Available from: 25.06 (25.6.0.58802) |
OrderLinesDiscount | number | Order Lines Discount Type: money Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReportOrderOverviewPost200TextXmlResponse>
<OrderNR>0</OrderNR>
<Anrede>string</Anrede>
<Name>string</Name>
<CareOf>string</CareOf>
<Address>string</Address>
<City>string</City>
<ZIP>string</ZIP>
<Country>string</Country>
<eMail>string</eMail>
<Shop_Note>string</Shop_Note>
<GiftMessage>string</GiftMessage>
<Address_Remarks>string</Address_Remarks>
<PaymentCode>string</PaymentCode>
<OrderStatus>string</OrderStatus>
<OrderLinesTotal>0</OrderLinesTotal>
<OrderLinesDiscount>0</OrderLinesDiscount>
<ShipCost>0</ShipCost>
<Discount>0</Discount>
<OrderTotal>0</OrderTotal>
<GrossProfit_Netto>0</GrossProfit_Netto>
<OrderDate>string</OrderDate>
<ShopID>string</ShopID>
<CurrencyCode>string</CurrencyCode>
</PixiReportOrderOverviewPost200TextXmlResponse>
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:pixiReportOrderOverview>
<RowCount xsi:type="xsd:integer">123</RowCount>
<OrderDateTo xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</OrderDateTo>
<OrderNrStart xsi:type="xsd:integer">123</OrderNrStart>
<OrderDateFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</OrderDateFrom>
</ns1:pixiReportOrderOverview>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReportOrderOverview', [
'RowCount' => '123', // integer
'OrderDateTo' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderNrStart' => '123', // integer
'OrderDateFrom' => 'YYYY-MM-DD hh:mm:ss', // 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);
}