pixiReport_NewCustomersStats
Deprecated
New Customers report Multi Currency: Return database currency code in field dbCurrency depend on if Multi Currency is Enabled then we:
- calculate and return data in database currency else
- calculate and return data in order / original currency (with value NULL for currency code).
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
Shop | string | false | Shop ID Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Year | integer | false | Year as a date range for report Type: int Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Country | string | false | Country code Type: varchar(3) Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiReport_NewCustomersStats>
<Year>0</Year>
<Shop>string</Shop>
<Country>string</Country>
</pixiReport_NewCustomersStats>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Average | number | Average Type: numeric Available from: 25.06 (25.6.0.58802) |
Month01 | number | Month01 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month02 | number | Month02 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month03 | number | Month03 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month04 | number | Month04 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month05 | number | Month05 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month06 | number | Month06 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month07 | number | Month07 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month08 | number | Month08 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month09 | number | Month09 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month10 | number | Month10 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month11 | number | Month11 Type: numeric Available from: 25.06 (25.6.0.58802) |
Month12 | number | Month12 Type: numeric Available from: 25.06 (25.6.0.58802) |
ParShop | string | ParShop Type: varchar Available from: 25.06 (25.6.0.58802) |
ParYear | integer | ParYear Type: int Available from: 25.06 (25.6.0.58802) |
LineLabel | string | LineLabel Type: varchar Available from: 25.06 (25.6.0.58802) |
LineNumber | integer | LineNumber Type: int Available from: 25.06 (25.6.0.58802) |
ParCountry | string | ParCountry Type: varchar Available from: 25.06 (25.6.0.58802) |
dbCurrency | string | dbCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
GroupNumber | integer | GroupNumber Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReport_NewCustomersStatsPost200TextXmlResponse>
<GroupNumber>0</GroupNumber>
<LineNumber>0</LineNumber>
<LineLabel>string</LineLabel>
<Month01>0</Month01>
<Month02>0</Month02>
<Month03>0</Month03>
<Month04>0</Month04>
<Month05>0</Month05>
<Month06>0</Month06>
<Month07>0</Month07>
<Month08>0</Month08>
<Month09>0</Month09>
<Month10>0</Month10>
<Month11>0</Month11>
<Month12>0</Month12>
<Average>0</Average>
<ParYear>0</ParYear>
<ParShop>string</ParShop>
<ParCountry>string</ParCountry>
<dbCurrency>string</dbCurrency>
</PixiReport_NewCustomersStatsPost200TextXmlResponse>
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:pixiReport_NewCustomersStats>
<Shop xsi:type="xsd:string"></Shop>
<Year xsi:type="xsd:integer"></Year>
<Country xsi:type="xsd:string"></Country>
</ns1:pixiReport_NewCustomersStats>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReport_NewCustomersStats', [
'Shop' => '', // string
'Year' => '', // integer
'Country' => '', // 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);
}