Unofficial Pixi-API-Documentation

by koempf24.de

pixiReportCustomerSales

Pixi-Docs
Old Pixi-Docs

Customer sales evaluation

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

KPIs Reports Statistics

Request

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

Request body

Name Type Required Description
DateTo string false

Date where to stop the report (excluding)

Type: datetime

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
ShopID string false

pixi Shop ID

Type: varchar(3)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
DateFrom string false

Date where to start the report (including)

Type: datetime

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
ItemNrSuppl string false

Supplier Item Nr.

Type: varchar(50)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
PaymentType string false

Payment Code

Type: char

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
CustomerNrExternal string false

Customer Number from Shop

Type: varchar(60)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiReportCustomerSales>
      <ItemNrSuppl>string</ItemNrSuppl>
      <ShopID>string</ShopID>
      <PaymentType>string</PaymentType>
      <CustomerNrExternal>string</CustomerNrExternal>
      <DateFrom>string</DateFrom>
      <DateTo>string</DateTo>
    </pixiReportCustomerSales>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Qty integer

Qty

Type: int

Available from: 25.06 (25.6.0.58802)
EANUPC string

EANUPC

Type: varchar

Available from: 25.06 (25.6.0.58802)
Company string

Company

Type: varchar

Available from: 25.06 (25.6.0.58802)
ItemNrSuppl string

ItemNrSuppl

Type: varchar

Available from: 25.06 (25.6.0.58802)
CurrencyCode string

CurrencyCode

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustomerName string

CustomerName

Type: varchar

Available from: 25.06 (25.6.0.58802)
LastSaleDate string

LastSaleDate

Type: datetime

Available from: 25.06 (25.6.0.58802)
ItemTotal_Net integer

ItemTotal_Net

Type: int

Available from: 25.06 (25.6.0.58802)
CustomerNrExternal string

CustomerNrExternal

Type: varchar

Available from: 25.06 (25.6.0.58802)
CountryCodeISO3_Billing string

CountryCodeISO3_Billing

Type: varchar

Available from: 25.06 (25.6.0.58802)
CountryCodeISO3_Shipping string

CountryCodeISO3_Shipping

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiReportCustomerSalesPost200TextXmlResponse>
  <ItemNrSuppl>string</ItemNrSuppl>
  <EANUPC>string</EANUPC>
  <Company>string</Company>
  <CustomerName>string</CustomerName>
  <CustomerNrExternal>string</CustomerNrExternal>
  <Qty>0</Qty>
  <ItemTotal_Net>0</ItemTotal_Net>
  <CountryCodeISO3_Billing>string</CountryCodeISO3_Billing>
  <CountryCodeISO3_Shipping>string</CountryCodeISO3_Shipping>
  <LastSaleDate>string</LastSaleDate>
  <CurrencyCode>string</CurrencyCode>
</PixiReportCustomerSalesPost200TextXmlResponse>

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:pixiReportCustomerSales>
            <DateTo xsi:type="xsd:string"></DateTo>
            <ShopID xsi:type="xsd:string"></ShopID>
            <DateFrom xsi:type="xsd:string"></DateFrom>
            <ItemNrSuppl xsi:type="xsd:string"></ItemNrSuppl>
            <PaymentType xsi:type="xsd:string"></PaymentType>
            <CustomerNrExternal xsi:type="xsd:string"></CustomerNrExternal>
        </ns1:pixiReportCustomerSales>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiReportCustomerSales', [
    'DateTo' => '', // string
    'ShopID' => '', // string
    'DateFrom' => '', // string
    'ItemNrSuppl' => '', // string
    'PaymentType' => '', // string
    'CustomerNrExternal' => '', // 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);
}