pixiDFGetChanges
API call for retrieving the DF Changes.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Secret | string | false | Secret parameter to check if data are save to be returned. Type: varchar(20) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
SupplNr | string | false | Supplier number. Type: varchar(4) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
ExcludeStatuses | string | false | Exclude statuses from resultset. Type: varchar(200) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
LockedCustomers | boolean | false | Show also locked customers. Type: bit Default value: 0 Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
OrderNRExternal | string | false | Order number external -filter only changes for one particular order. Type: varchar(50) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiDFGetChanges>
<SupplNr>string</SupplNr>
<Secret>string</Secret>
<OrderNRExternal>string</OrderNRExternal>
<ExcludeStatuses>string</ExcludeStatuses>
<LockedCustomers>true</LockedCustomers>
</pixiDFGetChanges>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Qty | integer | Qty Type: int Available from: 25.06 (25.6.0.58802) |
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar Available from: 25.06 (25.6.0.58802) |
string | Type: varchar Available from: 25.06 (25.6.0.58802) |
|
Phone | string | Phone Type: varchar Available from: 25.06 (25.6.0.58802) |
Price | integer | Price Type: int Available from: 25.06 (25.6.0.58802) |
Anrede | string | Anrede Type: varchar Available from: 25.06 (25.6.0.58802) |
CareOf | string | CareOf Type: varchar Available from: 25.06 (25.6.0.58802) |
EANUPC | string | EANUPC Type: varchar Available from: 25.06 (25.6.0.58802) |
Status | string | Status Type: varchar Available from: 25.06 (25.6.0.58802) |
Street | string | Street Type: varchar Available from: 25.06 (25.6.0.58802) |
ArtName | string | ArtName Type: varchar Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar Available from: 25.06 (25.6.0.58802) |
DF_Type | string | DF_Type Type: varchar Available from: 25.06 (25.6.0.58802) |
HouseNr | string | HouseNr Type: varchar Available from: 25.06 (25.6.0.58802) |
ordernr | integer | ordernr Type: int Available from: 25.06 (25.6.0.58802) |
APayment | string | APayment Type: varchar Available from: 25.06 (25.6.0.58802) |
LastName | string | LastName Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipCost | string | ShipCost Type: varchar Available from: 25.06 (25.6.0.58802) |
Shipdate | string | Shipdate Type: datetime Available from: 25.06 (25.6.0.58802) |
discount | string | discount Type: varchar Available from: 25.06 (25.6.0.58802) |
FirstName | string | FirstName Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderDate | string | OrderDate Type: datetime Available from: 25.06 (25.6.0.58802) |
SupplInfo | string | SupplInfo Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrShopID | string | AddrShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
AddressLock | string | AddressLock Type: varchar Available from: 25.06 (25.6.0.58802) |
ItemNrSuppl | string | ItemNrSuppl Type: varchar Available from: 25.06 (25.6.0.58802) |
CustomerLock | string | CustomerLock Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderHistKey | integer | OrderHistKey Type: int Available from: 25.06 (25.6.0.58802) |
OrderLineRef | integer | OrderLineRef Type: int Available from: 25.06 (25.6.0.58802) |
ShipInstruct | string | ShipInstruct Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipVendorCode | string | ShipVendorCode Type: varchar Available from: 25.06 (25.6.0.58802) |
itemNrExternal | string | itemNrExternal Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrNoChargeVAT | boolean | AddrNoChargeVAT Type: bit Available from: 25.06 (25.6.0.58802) |
Address_remarks | string | Address_remarks Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderNrExternal | string | OrderNrExternal Type: varchar Available from: 25.06 (25.6.0.58802) |
StatusChangeDate | string | StatusChangeDate Type: datetime Available from: 25.06 (25.6.0.58802) |
oItemSpecialNote | string | oItemSpecialNote Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceNrExternal | string | InvoiceNrExternal Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCurrencyCode | string | OrderCurrencyCode Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiDFGetChangesPost200TextXmlResponse>
<Anrede>string</Anrede>
<CareOf>string</CareOf>
<FirstName>string</FirstName>
<LastName>string</LastName>
<Street>string</Street>
<ZIP>string</ZIP>
<HouseNr>string</HouseNr>
<City>string</City>
<Country>string</Country>
<Email>string</Email>
<Phone>string</Phone>
<Address_remarks>string</Address_remarks>
<AddrNoChargeVAT>true</AddrNoChargeVAT>
<ShipInstruct>string</ShipInstruct>
<Shipdate>string</Shipdate>
<ShipVendorCode>string</ShipVendorCode>
<ArtName>string</ArtName>
<EANUPC>string</EANUPC>
<ItemNrSuppl>string</ItemNrSuppl>
<itemNrExternal>string</itemNrExternal>
<Qty>0</Qty>
<Price>0</Price>
<Status>string</Status>
<OrderHistKey>0</OrderHistKey>
<OrderLineRef>0</OrderLineRef>
<StatusChangeDate>string</StatusChangeDate>
<OrderDate>string</OrderDate>
<OrderNrExternal>string</OrderNrExternal>
<AddrShopID>string</AddrShopID>
<oItemSpecialNote>string</oItemSpecialNote>
<SupplInfo>string</SupplInfo>
<APayment>string</APayment>
<discount>string</discount>
<ShipCost>string</ShipCost>
<InvoiceNrExternal>string</InvoiceNrExternal>
<DF_Type>string</DF_Type>
<ordernr>0</ordernr>
<CustomerLock>string</CustomerLock>
<AddressLock>string</AddressLock>
<OrderCurrencyCode>string</OrderCurrencyCode>
</PixiDFGetChangesPost200TextXmlResponse>
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:pixiDFGetChanges>
<Secret xsi:type="xsd:string"></Secret>
<SupplNr xsi:type="xsd:string"></SupplNr>
<ExcludeStatuses xsi:type="xsd:string"></ExcludeStatuses>
<LockedCustomers xsi:type="xsd:boolean"></LockedCustomers>
<OrderNRExternal xsi:type="xsd:string"></OrderNRExternal>
</ns1:pixiDFGetChanges>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiDFGetChanges', [
'Secret' => '', // string
'SupplNr' => '', // string
'ExcludeStatuses' => '', // string
'LockedCustomers' => '', // boolean
'OrderNRExternal' => '', // 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);
}