Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportTurnover

Pixi-Docs
Old Pixi-Docs

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:

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
ShopID string false

Shop Id.

Type: varchar(3)

Default value:

Example: ABC

Available from: LOU Official (6.3.0.4452)
toDate string false

Date to.

Type: datetime

Default value: NULL

Example: 20.06.2023

Available from: LOU Official (6.3.0.4452)
fromDate string false

Date from.

Type: datetime

Default value: NULL

Example: 20.06.2023

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportTurnover>
      <fromDate>string</fromDate>
      <toDate>string</toDate>
      <ShopID>string</ShopID>
    </pixiReportTurnover>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
dbCurrency string

dbCurrency

Type: varchar

Available from: 25.06 (25.6.0.58802)
TurnoverNetDayBefore string

Turnover for day before given date - yesterday

Type: varchar

Available from: 25.06 (25.6.0.58802)
TurnoverNetGivenDate string

Turnover on gived date - today

Type: varchar

Available from: 25.06 (25.6.0.58802)
TurnoverNetGivenMonth string

Turnover for given month - this month

Type: varchar

Available from: 25.06 (25.6.0.58802)
TurnoverNetPreviousMonth string

Turnover for month before given date - previous month

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportTurnoverPost200TextXmlResponse>
  <TurnoverNetGivenDate>string</TurnoverNetGivenDate>
  <TurnoverNetDayBefore>string</TurnoverNetDayBefore>
  <TurnoverNetGivenMonth>string</TurnoverNetGivenMonth>
  <TurnoverNetPreviousMonth>string</TurnoverNetPreviousMonth>
  <dbCurrency>string</dbCurrency>
</PixiReportTurnoverPost200TextXmlResponse>

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:pixiReportTurnover>
            <ShopID xsi:type="xsd:string">ABC</ShopID>
            <toDate xsi:type="xsd:string">20.06.2023</toDate>
            <fromDate xsi:type="xsd:string">20.06.2023</fromDate>
        </ns1:pixiReportTurnover>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportTurnover', [
    'ShopID' => 'ABC', // string
    'toDate' => '20.06.2023', // string
    'fromDate' => '20.06.2023', // 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);
}