Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportReturnsCount

Pixi-Docs
Old Pixi-Docs

The call returns number of returns for different time periods.

Since pixi version: LOU Official (6.3.0.4452) Additional notes:

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
ShopID string false

Return only records for this shop.

Type: varchar(3)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
EndDate string false

Date to.

Type: datetime

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)
StartDate string false

Date from.

Type: datetime

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportReturnsCount>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <ShopID>string</ShopID>
    </pixiReportReturnsCount>
  </Body>
</Envelope>

Response

1. Return status

Name Type Description
ReturnsOnGivenDay integer

ReturnsOnGivenDay

Type: int

Available from: 25.06 (25.6.0.58802)
ReturnsInGivenMonth integer

ReturnsInGivenMonth

Type: int

Available from: 25.06 (25.6.0.58802)
ReturnsOnPreviousDay integer

ReturnsOnPreviousDay

Type: int

Available from: 25.06 (25.6.0.58802)
ReturnsInPreviousMonth integer

ReturnsInPreviousMonth

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportReturnsCountPost200TextXmlResponse>
  <ReturnsOnGivenDay>0</ReturnsOnGivenDay>
  <ReturnsOnPreviousDay>0</ReturnsOnPreviousDay>
  <ReturnsInGivenMonth>0</ReturnsInGivenMonth>
  <ReturnsInPreviousMonth>0</ReturnsInPreviousMonth>
</PixiReportReturnsCountPost200TextXmlResponse>

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:pixiReportReturnsCount>
            <ShopID xsi:type="xsd:string"></ShopID>
            <EndDate xsi:type="xsd:string"></EndDate>
            <StartDate xsi:type="xsd:string"></StartDate>
        </ns1:pixiReportReturnsCount>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportReturnsCount', [
    'ShopID' => '', // string
    'EndDate' => '', // string
    'StartDate' => '', // 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);
}