pixiCAGetCustomerEvents
API Call to show all CA Events and Statistics for a selected customer; New fields: OrderCurrency - return data in order currency. AccountCurrencyCode - return data (CustomerBalance, OpenOrders, SuggestedRefound) in base or order currency for customer.
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: 123 Available from: LOU Official (6.3.0.4452) |
CustRef | integer | false | ID of customer Type: int Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
CustNrExt | string | false | External Reference to the Customer (imported from Shop) Type: varchar(60) Default value: NULL Example: 123 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiCAGetCustomerEvents>
<CustRef>0</CustRef>
<CustNrExt>string</CustNrExt>
<ShopID>string</ShopID>
</pixiCAGetCustomerEvents>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Amount | number | As shown on F11 tab in CustomerService client. Type: money Available from: 25.06 (25.6.0.58802) |
Number | string | As shown on F11 tab in CustomerService client. Type: varchar Available from: 25.06 (25.6.0.58802) |
CustRef | integer | CustKey from table dbo.Customers. Type: int Available from: 25.06 (25.6.0.58802) |
EventID | string | As shown on F11 tab in CustomerService client. Type: varchar Available from: 25.06 (25.6.0.58802) |
EventDate | string | As shown on F11 tab in CustomerService client. Type: datetime Available from: 25.06 (25.6.0.58802) |
IsDeleted | boolean | Is Deleted Type: bit Available from: 25.06 (25.6.0.58802) |
Reference | string | As shown on F11 tab in CustomerService client. Type: varchar Available from: 25.06 (25.6.0.58802) |
OpenOrders | number | As shown on F11 tab in CustomerService client. Type: money Available from: 25.06 (25.6.0.58802) |
DoNotRefund | boolean | DoNotRefund Type: bit Available from: 25.06 (25.6.0.58802) |
OpenToMatch | number | As shown on F11 tab in CustomerService client. Type: money Available from: 25.06 (25.6.0.58802) |
OrderCurrency | string | Order Currency Type: varchar Available from: 25.06 (25.6.0.58802) |
CustomerBalance | number | As shown on F11 tab in CustomerService client. Type: money Available from: 25.06 (25.6.0.58802) |
IsAcountMatched | boolean | As shown on F11 tab in CustomerService client. Type: bit Available from: 25.06 (25.6.0.58802) |
SuggestedRefound | number | As shown on F11 tab in CustomerService client. Type: money Available from: 25.06 (25.6.0.58802) |
AccountCurrencyCode | string | Account Currency Code Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiCAGetCustomerEventsPost200TextXmlResponse>
<CustRef>0</CustRef>
<EventDate>string</EventDate>
<EventID>string</EventID>
<Number>string</Number>
<Reference>string</Reference>
<Amount>0</Amount>
<OpenToMatch>0</OpenToMatch>
<DoNotRefund>true</DoNotRefund>
<OrderCurrency>string</OrderCurrency>
<IsAcountMatched>true</IsAcountMatched>
<CustomerBalance>0</CustomerBalance>
<OpenOrders>0</OpenOrders>
<SuggestedRefound>0</SuggestedRefound>
<IsDeleted>true</IsDeleted>
<AccountCurrencyCode>string</AccountCurrencyCode>
</PixiCAGetCustomerEventsPost200TextXmlResponse>
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:pixiCAGetCustomerEvents>
<ShopID xsi:type="xsd:string">123</ShopID>
<CustRef xsi:type="xsd:integer">123</CustRef>
<CustNrExt xsi:type="xsd:string">123</CustNrExt>
</ns1:pixiCAGetCustomerEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiCAGetCustomerEvents', [
'ShopID' => '123', // string
'CustRef' => '123', // integer
'CustNrExt' => '123', // 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);
}