Unofficial Pixi-API-Documentation

by koempf24.de

pixiEmillInvoicesList

Pixi-Docs
Old Pixi-Docs

Enabled but undocumented

API call for eMail to get all invoices in a specific date range.

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

Invoices

Request

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

Request body

Name Type Required Description
DateTo string false

Date To

Type: datetime

Default value: NULL

Example:

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

Shop ID

Type: varchar(3)

Default value: NULL

Example:

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

Date From

Type: datetime

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

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

Response

1. Result set

Name Type Description
Email string

E-Mail address of this customer

Type: varchar

Available from: 25.06 (25.6.0.58802)
SName string

Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
SName2 string

Company

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvDate string

Invoice Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
OrderNr integer

Order Number

Type: int

Available from: 25.06 (25.6.0.58802)
SAnrede string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

Invoice Nr

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrdShopID string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderDate string

Order Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
InvoiceKey integer

ID for this invoice (pixi* internal)

Type: int

Available from: 25.06 (25.6.0.58802)
OrderNrExternal string

Order Number from Shop

Type: varchar

Available from: 25.06 (25.6.0.58802)
CustomerNrExternal string

customer number

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiEmillInvoicesListPost200TextXmlResponse>
  <InvoiceNr>string</InvoiceNr>
  <InvoiceKey>0</InvoiceKey>
  <CustomerNrExternal>string</CustomerNrExternal>
  <SAnrede>string</SAnrede>
  <SName>string</SName>
  <SName2>string</SName2>
  <Email>string</Email>
  <InvDate>string</InvDate>
  <OrderNr>0</OrderNr>
  <OrderNrExternal>string</OrderNrExternal>
  <OrdShopID>string</OrdShopID>
  <OrderDate>string</OrderDate>
</PixiEmillInvoicesListPost200TextXmlResponse>

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

PHP Example

<?php

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