pixiGetShippedOrdersPerLocation
Get list of all shipped orders for time period, if ShowDetails=0 only number of orders, their total and currency will be returned.
Since pixi version: 21.01 (9.0.23.54983) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocId | string | false | Filter: All locations = empty string |one specific location = 001. Type: varchar(3) Default value: NULL Example: abc Available from: 21.01 (9.0.23.54983) |
ToDate | string | true | Filter: End of invoice date range. Type: varchar(25) Default value: Example: 2017-12-31 23:59:96 Available from: 21.01 (9.0.23.54983) |
FromDate | string | true | Filter: Start of invoice date range. Type: varchar(25) Default value: Example: 2017-01-01 00:00:00 Available from: 21.01 (9.0.23.54983) |
ShowDetails | integer | false | Return details or summary of shipped orders. Type: int Default value: 1 Example: 0 Available from: 21.01 (9.0.23.54983) |
CustomerNrExternal | string | false | Filter: Customer number external. Type: varchar(60) Default value: NULL Example: abc Available from: 21.01 (9.0.23.54983) |
SearchByScanOutDate | boolean | false | Filter: Select if @FromDate and @ToDate filter records by InvoiceDate (default) or by ScanOutDate. Type: bit Default value: 0 Example: 0 or 1 Available from: 21.01 (9.0.23.54983) |
IncludeOrdersWithTotalZero | boolean | false | Filter: Include orders with total = 0 in returned result set. Type: bit Default value: 0 Example: 0 or 1 Available from: 21.01 (9.0.23.54983) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetShippedOrdersPerLocation>
<ShowDetails>0</ShowDetails>
<FromDate>string</FromDate>
<ToDate>string</ToDate>
<CustomerNrExternal>string</CustomerNrExternal>
<IncludeOrdersWithTotalZero>true</IncludeOrdersWithTotalZero>
<SearchByScanOutDate>true</SearchByScanOutDate>
<LocId>string</LocId>
</pixiGetShippedOrdersPerLocation>
</Body>
</Envelope>
Response
1. Shipped orders (details).
Name | Type | Description |
---|---|---|
SZip | string | Postal code from shipping address. Type: varchar Available from: 25.06 (25.6.0.58802) |
SCity | string | City from shipping address. Type: varchar Available from: 25.06 (25.6.0.58802) |
SName | string | Customer name from shipping address. Type: varchar Available from: 25.06 (25.6.0.58802) |
total | number | Invoice total. Type: money Available from: 25.06 (25.6.0.58802) |
InvDate | string | Date of invoice creation. Type: datetime Available from: 25.06 (25.6.0.58802) |
SAddress | string | Street from shipping address. Type: varchar Available from: 25.06 (25.6.0.58802) |
SCountry | string | Country from shipping address. Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceNR | string | Invoice number. Type: varchar Available from: 25.06 (25.6.0.58802) |
LocationID | string | Location of shipped orders. Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipVendor | string | Shipping vendor code. Type: varchar Available from: 25.06 (25.6.0.58802) |
ScanOutDate | string | Invoice ship out date. Type: datetime Available from: 25.06 (25.6.0.58802) |
CurrencyCode | string | Currency code. Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | Order number external (shop order number). Type: varchar Available from: 25.06 (25.6.0.58802) |
CustomerNrExternal | string | External customer number. Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipMentTrackingID | string | Invoice tracking ID. Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetShippedOrdersPerLocationPost200TextXmlResponse>
<InvoiceNR>string</InvoiceNR>
<InvDate>string</InvDate>
<ScanOutDate>string</ScanOutDate>
<total>0</total>
<ShipMentTrackingID>string</ShipMentTrackingID>
<SName>string</SName>
<SAddress>string</SAddress>
<SCity>string</SCity>
<SZip>string</SZip>
<SCountry>string</SCountry>
<OrderNrExternal>string</OrderNrExternal>
<CurrencyCode>string</CurrencyCode>
<ShipVendor>string</ShipVendor>
<CustomerNrExternal>string</CustomerNrExternal>
<LocationID>string</LocationID>
</PixiGetShippedOrdersPerLocationPost200TextXmlResponse>
2. Shipped orders (summary).
Name | Type | Description |
---|---|---|
Total | number | Invoice SUM(total) in selected period. Type: money Available from: 25.06 (25.6.0.58802) |
LocationID | string | Location of shipped orders. Type: varchar Available from: 25.06 (25.6.0.58802) |
NrOfOrders | integer | Total number of orders in selected period. Type: int Available from: 25.06 (25.6.0.58802) |
CurrencyCode | string | Currency code. Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetShippedOrdersPerLocationPost200TextXmlResponse>
<InvoiceNR>string</InvoiceNR>
<InvDate>string</InvDate>
<ScanOutDate>string</ScanOutDate>
<total>0</total>
<ShipMentTrackingID>string</ShipMentTrackingID>
<SName>string</SName>
<SAddress>string</SAddress>
<SCity>string</SCity>
<SZip>string</SZip>
<SCountry>string</SCountry>
<OrderNrExternal>string</OrderNrExternal>
<CurrencyCode>string</CurrencyCode>
<ShipVendor>string</ShipVendor>
<CustomerNrExternal>string</CustomerNrExternal>
<LocationID>string</LocationID>
</PixiGetShippedOrdersPerLocationPost200TextXmlResponse>
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:pixiGetShippedOrdersPerLocation>
<LocId xsi:type="xsd:string">abc</LocId>
<ToDate xsi:type="xsd:string">2017-12-31 23:59:96</ToDate> <!-- required -->
<FromDate xsi:type="xsd:string">2017-01-01 00:00:00</FromDate> <!-- required -->
<ShowDetails xsi:type="xsd:integer">0</ShowDetails>
<CustomerNrExternal xsi:type="xsd:string">abc</CustomerNrExternal>
<SearchByScanOutDate xsi:type="xsd:boolean">0 or 1</SearchByScanOutDate>
<IncludeOrdersWithTotalZero xsi:type="xsd:boolean">0 or 1</IncludeOrdersWithTotalZero>
</ns1:pixiGetShippedOrdersPerLocation>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetShippedOrdersPerLocation', [
'LocId' => 'abc', // string
'ToDate' => '2017-12-31 23:59:96', // string (required)
'FromDate' => '2017-01-01 00:00:00', // string (required)
'ShowDetails' => '0', // integer
'CustomerNrExternal' => 'abc', // string
'SearchByScanOutDate' => '0 or 1', // boolean
'IncludeOrdersWithTotalZero' => '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);
}