pixiGetOrderHeader
Retrieve Orderheaders based on several filters.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShopID | string | false | Shop ID Type: char Default value: NULL Example: ABC Available from: LOU Official (6.3.0.4452) |
CustKey | integer | false | Customer ID, references table customers. Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
OrderNr | integer | false | pixi* order number Type: int Default value: 0 Example: 123 Available from: LOU Official (6.3.0.4452) |
FromTime | string | false | Beginning of the order date range Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official (6.3.0.4452) |
RowCount | integer | false | Maximum number of rows returned Type: int Default value: 1000 Example: 123 Available from: LOU Official - Update 46 (6.9.46.27927) |
UntilTime | string | false | End of order date range Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: LOU Official (6.3.0.4452) |
PaymentType | string | false | Payment TYPE, references table payments Type: char Default value: NULL Example: Single character : "g" Available from: LOU Official (6.3.0.4452) |
FromUpdateTime | string | false | Beginning of the order update date range Type: datetime Default value: NULL Example: YYYY-MM-DD hh:mm:ss Available from: 18.07 (8.4.43.34931) |
OrderNrExternal | string | false | Shop order number Type: varchar(50) Default value: Example: abcdefg Available from: LOU Official (6.3.0.4452) |
ShippingCountry | string | false | Shipping country reference Type: varchar(3) Default value: NULL Example: abcdefg Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetOrderHeader>
<OrderNr>0</OrderNr>
<OrderNrExternal>string</OrderNrExternal>
<CustKey>0</CustKey>
<FromTime>string</FromTime>
<UntilTime>string</UntilTime>
<ShopID>string</ShopID>
<PaymentType>string</PaymentType>
<ShippingCountry>string</ShippingCountry>
<RowCount>0</RowCount>
<FromUpdateTime>string</FromUpdateTime>
</pixiGetOrderHeader>
</Body>
</Envelope>
Response
1. Order details
Name | Type | Description |
---|---|---|
Blz | string | Bank Code Type: varchar Available from: 25.06 (25.6.0.58802) |
ZIP | string | Postal code Type: varchar Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar Available from: 25.06 (25.6.0.58802) |
Tags | string | Tag Names of an order separated by pipe symbol Type: varchar Available from: 25.06 (25.6.0.58802) |
Gender | integer | Gender Type: int Available from: 25.06 (25.6.0.58802) |
ShopID | string | Shop ID Type: varchar Available from: 25.06 (25.6.0.58802) |
Street | string | Street Type: varchar Available from: 25.06 (25.6.0.58802) |
Account | string | Bank account number Type: varchar Available from: 25.06 (25.6.0.58802) |
CustKey | integer | Customer ID Type: int Available from: 25.06 (25.6.0.58802) |
HouseNr | string | House number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
BankName | string | Name of the Bank Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardNr | string | Number of the credit card used for payment Type: varchar Available from: 25.06 (25.6.0.58802) |
LastName | string | Last Name Type: varchar Available from: 25.06 (25.6.0.58802) |
Referrer | string | Referrer link or text Type: varchar 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) |
ShopNote | string | Note received with this order from the shop Type: varchar Available from: 25.06 (25.6.0.58802) |
BirthDate | string | Birth date Type: datetime Available from: 25.06 (25.6.0.58802) |
CcCardExp | string | Expiry date of the creditcard Type: varchar Available from: 25.06 (25.6.0.58802) |
FirstName | string | First Name Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Shop order date (imported) Type: datetime Available from: 25.06 (25.6.0.58802) |
OrderType | string | Order type - B2B or B2C Type: varchar Available from: 25.06 (25.6.0.58802) |
VoucherID | string | ID of the voucher Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardName | string | Name of the credit institute Type: varchar Available from: 25.06 (25.6.0.58802) |
CcCardType | string | Type of creditcard Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: datetime Available from: 25.06 (25.6.0.58802) |
CustomerNr | string | Customer name Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderTotal | number | Order total Type: money Available from: 25.06 (25.6.0.58802) |
ShipVendor | string | Shipping vendor code Type: varchar Available from: 25.06 (25.6.0.58802) |
TrackingID | string | Tracking ID of the shipment. Applies to the orders that have been shipped Type: varchar Available from: 25.06 (25.6.0.58802) |
AccountName | string | Name of the owner of this bank account Type: varchar Available from: 25.06 (25.6.0.58802) |
GiftMessage | string | Gift Message Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderLocked | string | Y/N flag indicating whether the order is locked Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentType | string | Payment type code Type: varchar Available from: 25.06 (25.6.0.58802) |
SubShopLogo | string | Shop logo Type: varchar Available from: 25.06 (25.6.0.58802) |
SubShopName | string | Shop name Type: varchar Available from: 25.06 (25.6.0.58802) |
DeliveryDate | string | Delivery date Type: datetime Available from: 25.06 (25.6.0.58802) |
LastShipdate | string | Date of last (partial) shipment Type: datetime Available from: 25.06 (25.6.0.58802) |
ShipInstruct | string | Shipping instruction notes Type: varchar Available from: 25.06 (25.6.0.58802) |
CustomerEmail | string | Customer e-mail Type: varchar Available from: 25.06 (25.6.0.58802) |
LastInvoiceNr | string | Last invoice number connected to the order Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order currency Type: varchar Available from: 25.06 (25.6.0.58802) |
TotalDiscount | number | Total discount Type: money Available from: 25.06 (25.6.0.58802) |
VoucherAmount | number | Amount covered with the associated voucher Type: money Available from: 25.06 (25.6.0.58802) |
AddressRemarks | string | Notes related to the address Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderHeaderKey | integer | ID of the order header record Type: int Available from: 25.06 (25.6.0.58802) |
SalutationText | string | Salutation text Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | External order number Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderShipVendor | string | Shipping vendor for the order Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderlinesTotal | number | Orderlines total Type: money Available from: 25.06 (25.6.0.58802) |
ShippingCountry | string | Shipping country Type: varchar Available from: 25.06 (25.6.0.58802) |
WholeOrderState | string | Status of the order Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentAddressId | integer | Payment address ID Type: int Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Estimated delivery of items on the order Type: datetime Available from: 25.06 (25.6.0.58802) |
ShipmentAddressId | integer | Shipment address ID Type: int Available from: 25.06 (25.6.0.58802) |
CustomerNrExternal | string | External Reference to the Customer (imported from Shop) Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderTotal_OrderCurr | number | Order total Type: money Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetOrderHeaderPost200TextXmlResponse>
<OrderHeaderKey>0</OrderHeaderKey>
<OrderNr>0</OrderNr>
<CreateDate>string</CreateDate>
<OrderNrExternal>string</OrderNrExternal>
<OrderTotal>0</OrderTotal>
<OrderlinesTotal>0</OrderlinesTotal>
<WholeOrderState>string</WholeOrderState>
<Shipdate>string</Shipdate>
<LastShipdate>string</LastShipdate>
<TrackingID>string</TrackingID>
<ShipVendor>string</ShipVendor>
<ShopID>string</ShopID>
<OrderDate>string</OrderDate>
<ShipCost>0</ShipCost>
<PaymentAddressId>0</PaymentAddressId>
<ShipmentAddressId>0</ShipmentAddressId>
<ShopNote>string</ShopNote>
<PaymentType>string</PaymentType>
<VoucherID>string</VoucherID>
<VoucherAmount>0</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>
<CustKey>0</CustKey>
<SalutationText>string</SalutationText>
<Gender>0</Gender>
<LastName>string</LastName>
<FirstName>string</FirstName>
<ShippingCountry>string</ShippingCountry>
<ZIP>string</ZIP>
<City>string</City>
<Street>string</Street>
<HouseNr>string</HouseNr>
<BirthDate>string</BirthDate>
<CustomerNr>string</CustomerNr>
<SubShopName>string</SubShopName>
<SubShopLogo>string</SubShopLogo>
<Referrer>string</Referrer>
<GiftMessage>string</GiftMessage>
<OrderCurrency>string</OrderCurrency>
<OrderTotal_OrderCurr>0</OrderTotal_OrderCurr>
<CustomerEmail>string</CustomerEmail>
<CustomerNrExternal>string</CustomerNrExternal>
<EstimatedDelivery>string</EstimatedDelivery>
<OrderLocked>string</OrderLocked>
<ShipInstruct>string</ShipInstruct>
<OrderShipVendor>string</OrderShipVendor>
<DeliveryDate>string</DeliveryDate>
<LastInvoiceNr>string</LastInvoiceNr>
<TotalDiscount>0</TotalDiscount>
<OrderType>string</OrderType>
<Tags>string</Tags>
</PixiGetOrderHeaderPost200TextXmlResponse>
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:pixiGetOrderHeader>
<ShopID xsi:type="xsd:string">ABC</ShopID>
<CustKey xsi:type="xsd:integer">123</CustKey>
<OrderNr xsi:type="xsd:integer">123</OrderNr>
<FromTime xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</FromTime>
<RowCount xsi:type="xsd:integer">123</RowCount>
<UntilTime xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</UntilTime>
<PaymentType xsi:type="xsd:string">Single character : "g"</PaymentType>
<FromUpdateTime xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</FromUpdateTime>
<OrderNrExternal xsi:type="xsd:string">abcdefg</OrderNrExternal>
<ShippingCountry xsi:type="xsd:string">abcdefg</ShippingCountry>
</ns1:pixiGetOrderHeader>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetOrderHeader', [
'ShopID' => 'ABC', // string
'CustKey' => '123', // integer
'OrderNr' => '123', // integer
'FromTime' => 'YYYY-MM-DD hh:mm:ss', // string
'RowCount' => '123', // integer
'UntilTime' => 'YYYY-MM-DD hh:mm:ss', // string
'PaymentType' => 'Single character : "g"', // string
'FromUpdateTime' => 'YYYY-MM-DD hh:mm:ss', // string
'OrderNrExternal' => 'abcdefg', // string
'ShippingCountry' => 'abcdefg', // 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);
}