pixiGetOrderHeadersByOrderDate
Get OrderHeaders by Date-Range (Create) - based on GetOrderHeaderForCustomer
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShopID | string | false | Shop ID Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
ToDate | string | true | End of order date range Type: datetime Default value: Example: Available from: LOU Official (6.3.0.4452) |
FromDate | string | true | Beginning of the order date range Type: datetime Default value: Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetOrderHeadersByOrderDate>
<FromDate>string</FromDate>
<ToDate>string</ToDate>
<ShopID>string</ShopID>
</pixiGetOrderHeadersByOrderDate>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Blz | string | Blz Type: varchar Available from: 25.06 (25.6.0.58802) |
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
ShopID | string | ShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
Account | string | Account Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrRef | integer | AddrRef Type: int Available from: 25.06 (25.6.0.58802) |
CustKey | integer | CustKey Type: int Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | OrderNr Type: int Available from: 25.06 (25.6.0.58802) |
BankName | string | BankName Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardNr | string | CcCardNr Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCost | string | ShipCost Type: datetime Available from: 25.06 (25.6.0.58802) |
Shipdate | string | Shipdate Type: datetime Available from: 25.06 (25.6.0.58802) |
ShopNote | integer | ShopNote Type: int Available from: 25.06 (25.6.0.58802) |
CcCardExp | string | CcCardExp Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | OrderDate Type: datetime Available from: 25.06 (25.6.0.58802) |
VoucherID | string | VoucherID Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardName | string | CcCardName Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardType | string | CcCardType Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | CreateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
OrderTotal | string | OrderTotal Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipVendor | string | ShipVendor Type: varchar Available from: 25.06 (25.6.0.58802) |
TrackingID | string | TrackingID Type: varchar Available from: 25.06 (25.6.0.58802) |
AccountName | string | AccountName Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderLocked | string | OrderLocked Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentType | string | PaymentType Type: varchar Available from: 25.06 (25.6.0.58802) |
CurrencyCode | string | CurrencyCode Type: varchar Available from: 25.06 (25.6.0.58802) |
LastShipdate | string | LastShipdate Type: datetime Available from: 25.06 (25.6.0.58802) |
VoucherAmount | string | VoucherAmount Type: varchar Available from: 25.06 (25.6.0.58802) |
AddressRemarks | string | AddressRemarks Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderHeaderKey | integer | OrderHeaderKey Type: int Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | OrderNrExternal Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderlinesTotal | string | OrderlinesTotal Type: varchar Available from: 25.06 (25.6.0.58802) |
WholeOrderState | string | WholeOrderState Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentAddressId | integer | PaymentAddressId Type: int Available from: 25.06 (25.6.0.58802) |
ShipmentAddressId | integer | ShipmentAddressId Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetOrderHeadersByOrderDatePost200TextXmlResponse>
<OrderHeaderKey>0</OrderHeaderKey>
<OrderNr>0</OrderNr>
<CreateDate>string</CreateDate>
<OrderNrExternal>string</OrderNrExternal>
<OrderTotal>string</OrderTotal>
<OrderlinesTotal>string</OrderlinesTotal>
<WholeOrderState>string</WholeOrderState>
<Shipdate>string</Shipdate>
<LastShipdate>string</LastShipdate>
<TrackingID>string</TrackingID>
<ShipVendor>string</ShipVendor>
<ShopID>string</ShopID>
<OrderDate>string</OrderDate>
<ShipCost>string</ShipCost>
<PaymentAddressId>0</PaymentAddressId>
<ShipmentAddressId>0</ShipmentAddressId>
<ShopNote>0</ShopNote>
<PaymentType>string</PaymentType>
<VoucherID>string</VoucherID>
<VoucherAmount>string</VoucherAmount>
<CcCardType>string</CcCardType>
<CcCardNr>string</CcCardNr>
<CcCardName>string</CcCardName>
<CcCardExp>string</CcCardExp>
<Account>string</Account>
<Blz>string</Blz>
<BankName>string</BankName>
<AccountName>string</AccountName>
<AddressRemarks>string</AddressRemarks>
<AddrRef>0</AddrRef>
<ZIP>string</ZIP>
<CustKey>0</CustKey>
<OrderLocked>string</OrderLocked>
<CurrencyCode>string</CurrencyCode>
</PixiGetOrderHeadersByOrderDatePost200TextXmlResponse>
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:pixiGetOrderHeadersByOrderDate>
<ShopID xsi:type="xsd:string"></ShopID>
<ToDate xsi:type="xsd:string"></ToDate> <!-- required -->
<FromDate xsi:type="xsd:string"></FromDate> <!-- required -->
</ns1:pixiGetOrderHeadersByOrderDate>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetOrderHeadersByOrderDate', [
'ShopID' => '', // string
'ToDate' => '', // string (required)
'FromDate' => '', // string (required)
]);
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);
}