Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetCAEventsAndReminders

Pixi-Docs
Old Pixi-Docs

API call returns all customer account events matched in a given time range. Reminder level changes, are also treated as CA events

Since pixi version: AVA 17.02 (8.4.26.28957) Additional notes:

Customers

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetCAEventsAndReminders

Request body

Name Type Required Description
ShopId string false

[mandatory] pixi* shop ID.

Type: varchar(3)

Default value:

Example:

Available from: AVA 17.02 (8.4.26.28957)
EndDate string false

[optional] The end of the date range. Default is set to the end of the current day.

Type: datetime

Default value:

Example:

Available from: AVA 17.02 (8.4.26.28957)
StartDate string false

[optional] The start of the date range. Default is set to the beginning of the current month.

Type: datetime

Default value:

Example:

Available from: AVA 17.02 (8.4.26.28957)
CustomerNumberIsNumeric boolean false

[optional] Filter that checks if "CustomerNumberExteranal" is a numeric value. Default is set to "false".

Type: bit

Default value:

Example:

Available from: AVA 17.02 (8.4.26.28957)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetCAEventsAndReminders>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <ShopId>string</ShopId>
      <CustomerNumberIsNumeric>true</CustomerNumberIsNumeric>
    </pixiGetCAEventsAndReminders>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiGetCAEventsAndRemindersPost200TextXmlResponse />

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:pixiGetCAEventsAndReminders>
            <ShopId xsi:type="xsd:string"></ShopId>
            <EndDate xsi:type="xsd:string"></EndDate>
            <StartDate xsi:type="xsd:string"></StartDate>
            <CustomerNumberIsNumeric xsi:type="xsd:boolean"></CustomerNumberIsNumeric>
        </ns1:pixiGetCAEventsAndReminders>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetCAEventsAndReminders', [
    'ShopId' => '', // string
    'EndDate' => '', // string
    'StartDate' => '', // string
    'CustomerNumberIsNumeric' => '', // boolean
]);

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);
}