pixiGetReminders
Returns list of Invoices (Reminder candidates) for given parameters - Reminder level, Payment type, Shop and Reminder days.
Since pixi version: LOU Official (6.3.0.4452) Additional notes: Customers data is taken from Billing Address
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShopID | string | true | Allows to filter results by Shop. Type: char Default value: Example: Available from: LOU Official (6.3.0.4452) |
PaymentType | string | true | Allows to filter results by Invoice Payment type. Type: char Default value: Example: Available from: LOU Official (6.3.0.4452) |
ReminderDays | integer | false | Allows to filter results by Invoice age (in days). If not set, DB setting or default values are used. Type: int Default value: Example: Available from: LOU Official (6.3.0.4452) |
ReminderLevel | integer | true | Allows to filter results by Reminder level. Value should be 1 or higher. Type: int Default value: Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetReminders>
<ReminderLevel>0</ReminderLevel>
<PaymentType>string</PaymentType>
<ShopID>string</ShopID>
<ReminderDays>0</ReminderDays>
</pixiGetReminders>
</Body>
</Envelope>
Response
1. Returns list of Reminders
Name | Type | Description |
---|---|---|
zip | string | ZIP from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
city | string | City from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
name | string | Name of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
string | Email address from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
|
name2 | string | Name of customer (2nd part) - optional Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
phone | string | Phone number from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
state | string | State from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
total | number | Invoice total amount Type: MONEY Available from: 25.06 (25.6.0.58802) |
careof | string | Company of customer - optional Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
street | string | Street from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
country | string | Country code from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
housenr | string | House number from address of customer Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
invdate | string | Invoice creation date Type: DATETIME Available from: 25.06 (25.6.0.58802) |
payment | string | Invoice payment type Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
CuseMail | string | Shop email address Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
ShopName | string | Shop name Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
invoicenr | string | Invoice number Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
shipmenttrackingid | string | Shipment tracking Id. Can contain multiple values, separated by delimiter (semicolon by default) Type: VARCHAR Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetRemindersPost200TextXmlResponse>
<invoicenr>string</invoicenr>
<invdate>string</invdate>
<total>0</total>
<payment>string</payment>
<shipmenttrackingid>string</shipmenttrackingid>
<name>string</name>
<name2>string</name2>
<careof>string</careof>
<street>string</street>
<housenr>string</housenr>
<city>string</city>
<state>string</state>
<zip>string</zip>
<country>string</country>
<phone>string</phone>
<email>string</email>
<ShopName>string</ShopName>
<CuseMail>string</CuseMail>
</PixiGetRemindersPost200TextXmlResponse>
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:pixiGetReminders>
<ShopID xsi:type="xsd:string"></ShopID> <!-- required -->
<PaymentType xsi:type="xsd:string"></PaymentType> <!-- required -->
<ReminderDays xsi:type="xsd:integer"></ReminderDays>
<ReminderLevel xsi:type="xsd:integer"></ReminderLevel> <!-- required -->
</ns1:pixiGetReminders>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetReminders', [
'ShopID' => '', // string (required)
'PaymentType' => '', // string (required)
'ReminderDays' => '', // integer
'ReminderLevel' => '', // integer (required)
]);
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);
}