Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetItemSalesStats

Pixi-Docs
Old Pixi-Docs

API call returns sales statistics for selected item

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

Items Stock

Request

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

Request body

Name Type Required Description
EANUPC string false

Filter: Item barcode

Type: varchar(13)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
ItemNrInt string false

Filter: Shop item number

Type: varchar(50)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetItemSalesStats>
      <EANUPC>string</EANUPC>
      <ItemNrInt>string</ItemNrInt>
    </pixiGetItemSalesStats>
  </Body>
</Envelope>

Response

1. Sales statistics for selected item

Name Type Description
ABC string

Item system tag

Type: char

Available from: / (25.7.0.59144)
Open1SS integer

Possible open 1 scan shipping orders

Type: int

Available from: / (25.7.0.59144)
Sales30 integer

Sales in last 30 days

Type: int

Available from: / (25.7.0.59144)
Sales120 integer

Sales in last 120 days

Type: int

Available from: / (25.7.0.59144)
Sales365 integer

Sales in last 365 days

Type: int

Available from: / (25.7.0.59144)
OrderQtyANG integer

Item quantity on orders with status ANG

Type: int

Available from: / (25.7.0.59144)
OrderQtyHAL integer

Item quantity on orders with status HAL

Type: int

Available from: / (25.7.0.59144)

Response Example

<PixiGetItemSalesStatsPost200TextXmlResponse>
  <Open1SS>0</Open1SS>
  <ABC>string</ABC>
  <Sales30>0</Sales30>
  <Sales120>0</Sales120>
  <Sales365>0</Sales365>
  <OrderQtyANG>0</OrderQtyANG>
  <OrderQtyHAL>0</OrderQtyHAL>
</PixiGetItemSalesStatsPost200TextXmlResponse>

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:pixiGetItemSalesStats>
            <EANUPC xsi:type="xsd:string">abcdefg</EANUPC>
            <ItemNrInt xsi:type="xsd:string">abcdefg</ItemNrInt>
        </ns1:pixiGetItemSalesStats>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetItemSalesStats', [
    'EANUPC' => 'abcdefg', // string
    'ItemNrInt' => 'abcdefg', // 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);
}