pixiGetCustomerEvents
Enabled but undocumented
pipiGetCustomerEvents
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
DateTo | string | false | Date To Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CustKey | integer | false | Customer Id Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
EventID | string | false | Event ID Type: varchar(3) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
DateFrom | string | false | Date From Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetCustomerEvents>
<CustKey>0</CustKey>
<EventID>string</EventID>
<DateFrom>string</DateFrom>
<DateTo>string</DateTo>
</pixiGetCustomerEvents>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Amount | string | Amount Type: varchar Available from: 25.06 (25.6.0.58802) |
Number | string | Number Type: varchar Available from: 25.06 (25.6.0.58802) |
CustRef | integer | Cusomer Id Type: int Available from: 25.06 (25.6.0.58802) |
EventID | string | Event ID Type: varchar Available from: 25.06 (25.6.0.58802) |
DTAUSref | integer | DTAUS Reference Type: int Available from: 25.06 (25.6.0.58802) |
EventDate | string | Event Date Type: datetime Available from: 25.06 (25.6.0.58802) |
EventName | string | EventName Type: varchar Available from: 25.06 (25.6.0.58802) |
IsDeleted | boolean | Is Deleted Type: bit Available from: 25.06 (25.6.0.58802) |
Reference | string | Reference Type: varchar Available from: 25.06 (25.6.0.58802) |
InvoiceRef | integer | Invoice Reference Type: int Available from: 25.06 (25.6.0.58802) |
BanklineRef | integer | Bankline Reference Type: int Available from: 25.06 (25.6.0.58802) |
DoNotRefund | boolean | Do Not Refund Type: bit Available from: 25.06 (25.6.0.58802) |
OpenTOMatch | string | OpenTOMatch Type: varchar Available from: 25.06 (25.6.0.58802) |
AllowToDelete | integer | Allow To Delete Type: int Available from: 25.06 (25.6.0.58802) |
CCPTranLogKey | integer | CCPTran Log Key Type: int Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order Currency Type: varchar Available from: 25.06 (25.6.0.58802) |
ManualBookingRef | integer | Manual Booking Reference Type: int Available from: 25.06 (25.6.0.58802) |
CustomerAccountKey | integer | Customer Account Key Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetCustomerEventsPost200TextXmlResponse>
<CustomerAccountKey>0</CustomerAccountKey>
<CustRef>0</CustRef>
<EventDate>string</EventDate>
<EventID>string</EventID>
<EventName>string</EventName>
<Number>string</Number>
<Reference>string</Reference>
<Amount>string</Amount>
<OpenTOMatch>string</OpenTOMatch>
<DoNotRefund>true</DoNotRefund>
<InvoiceRef>0</InvoiceRef>
<BanklineRef>0</BanklineRef>
<DTAUSref>0</DTAUSref>
<ManualBookingRef>0</ManualBookingRef>
<AllowToDelete>0</AllowToDelete>
<IsDeleted>true</IsDeleted>
<CCPTranLogKey>0</CCPTranLogKey>
<OrderCurrency>string</OrderCurrency>
</PixiGetCustomerEventsPost200TextXmlResponse>
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:pixiGetCustomerEvents>
<DateTo xsi:type="xsd:string"></DateTo>
<CustKey xsi:type="xsd:integer"></CustKey>
<EventID xsi:type="xsd:string"></EventID>
<DateFrom xsi:type="xsd:string"></DateFrom>
</ns1:pixiGetCustomerEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetCustomerEvents', [
'DateTo' => '', // string
'CustKey' => '', // integer
'EventID' => '', // string
'DateFrom' => '', // 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);
}