pixiGetChangedOrders
Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTimeFrom | string | true | Begging of date time range for changed orders Type: datetime Default value: Example: YYYY-MM-DD hh:mm:ss Available from: AVA Official - Update 7 (8.4.7.23158) |
skipGetXMLValue | boolean | false | Not in use Type: bit Default value: 1 Example: 0 or 1 Available from: AVA Official - Update 7 (8.4.7.23158) |
ReturnOnlyDFOrders | boolean | false | Show only direct fulfillment orders Type: bit Default value: 0 Example: 0 or 1 Available from: AVA Official - Update 7 (8.4.7.23158) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetChangedOrders>
<DateTimeFrom>string</DateTimeFrom>
<skipGetXMLValue>true</skipGetXMLValue>
<ReturnOnlyDFOrders>true</ReturnOnlyDFOrders>
</pixiGetChangedOrders>
</Body>
</Envelope>
Response
1. List of changed orders
Name | Type | Description |
---|---|---|
ShopID | string | Shop ID Type: varchar Available from: 25.06 (25.6.0.58802) |
CustKey | integer | Customer ID Type: int Available from: 25.06 (25.6.0.58802) |
OrderNr | integer | Order number in pixi* Type: int Available from: 25.06 (25.6.0.58802) |
Referrer | string | Referrer 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) |
ShopNote | string | Note received with this order from the shop Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | Order date from external system Type: datetime Available from: 25.06 (25.6.0.58802) |
VoucherID | string | ID of the voucher Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | Create date Type: datetime Available from: 25.06 (25.6.0.58802) |
DateTimeTo | string | Orders changed till this time Type: datetime 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) |
DeliveryDate | string | Delivery date Type: datetime Available from: 25.06 (25.6.0.58802) |
CustomerEmail | string | Customers e-mail Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order currency Type: varchar 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 | Addres remarks 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) |
ShipVendorCode | string | Shipping vendor code 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) |
WholeOrderState | string | Status of the order Type: varchar Available from: 25.06 (25.6.0.58802) |
PaymentAddressId | integer | Billing address ID Type: int Available from: 25.06 (25.6.0.58802) |
EstimatedDelivery | string | Estimated delivery Type: datetime Available from: 25.06 (25.6.0.58802) |
ShipmentAddressId | integer | Shipping 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) |
Response Example
<PixiGetChangedOrdersPost200TextXmlResponse>
<DateTimeTo>string</DateTimeTo>
<OrderHeaderKey>0</OrderHeaderKey>
<OrderNr>0</OrderNr>
<CreateDate>string</CreateDate>
<OrderNrExternal>string</OrderNrExternal>
<WholeOrderState>string</WholeOrderState>
<ShipVendorCode>string</ShipVendorCode>
<ShopID>string</ShopID>
<ShipCost>0</ShipCost>
<PaymentAddressId>0</PaymentAddressId>
<ShipmentAddressId>0</ShipmentAddressId>
<DeliveryDate>string</DeliveryDate>
<Referrer>string</Referrer>
<GiftMessage>string</GiftMessage>
<AddressRemarks>string</AddressRemarks>
<ShopNote>string</ShopNote>
<PaymentType>string</PaymentType>
<CustKey>0</CustKey>
<CustomerEmail>string</CustomerEmail>
<CustomerNrExternal>string</CustomerNrExternal>
<OrderLocked>string</OrderLocked>
<OrderDate>string</OrderDate>
<VoucherID>string</VoucherID>
<VoucherAmount>0</VoucherAmount>
<OrderCurrency>string</OrderCurrency>
<EstimatedDelivery>string</EstimatedDelivery>
</PixiGetChangedOrdersPost200TextXmlResponse>
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:pixiGetChangedOrders>
<DateTimeFrom xsi:type="xsd:string">YYYY-MM-DD hh:mm:ss</DateTimeFrom> <!-- required -->
<skipGetXMLValue xsi:type="xsd:boolean">0 or 1</skipGetXMLValue>
<ReturnOnlyDFOrders xsi:type="xsd:boolean">0 or 1</ReturnOnlyDFOrders>
</ns1:pixiGetChangedOrders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetChangedOrders', [
'DateTimeFrom' => 'YYYY-MM-DD hh:mm:ss', // string (required)
'skipGetXMLValue' => '0 or 1', // boolean
'ReturnOnlyDFOrders' => '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);
}