Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetInvoiceShippingReport

Pixi-Docs
Old Pixi-Docs

API Call to get all invoices within a timeframe

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

Invoices

Request

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

Request body

Name Type Required Description
DateTo string false

End of the date range peroid.

Type: datetime

Default value: NULL

Example: YYYY-MM-DD

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

Shop ID

Type: varchar(3)

Default value: NULL

Example: abc

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

Begining of the date range peroid.

Type: datetime

Default value: NULL

Example: YYYY-MM-DD

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

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

Response

1. Result set

Name Type Description
PLZ string

PLZ

Type: varchar

Available from: 25.06 (25.6.0.58802)
Land string

Land

Type: varchar

Available from: 25.06 (25.6.0.58802)
Firma string

Firma

Type: varchar

Available from: 25.06 (25.6.0.58802)
Stadt string

Stadt

Type: varchar

Available from: 25.06 (25.6.0.58802)
eMail string

eMail

Type: varchar

Available from: 25.06 (25.6.0.58802)
Strasse string

Strasse

Type: varchar

Available from: 25.06 (25.6.0.58802)
Vorname string

Vorname

Type: varchar

Available from: 25.06 (25.6.0.58802)
Nachname string

Nachname

Type: varchar

Available from: 25.06 (25.6.0.58802)
Datevnummer string

Datev nummer

Type: varchar

Available from: 25.06 (25.6.0.58802)
Rechnungsnummer string

Rechnungs nummer

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoiceShippingReportPost200TextXmlResponse>
  <Datevnummer>string</Datevnummer>
  <Rechnungsnummer>string</Rechnungsnummer>
  <Vorname>string</Vorname>
  <Nachname>string</Nachname>
  <Firma>string</Firma>
  <Strasse>string</Strasse>
  <PLZ>string</PLZ>
  <Stadt>string</Stadt>
  <Land>string</Land>
  <eMail>string</eMail>
</PixiGetInvoiceShippingReportPost200TextXmlResponse>

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

PHP Example

<?php

getPixiSoapClientResponse('pixiGetInvoiceShippingReport', [
    'DateTo' => 'YYYY-MM-DD', // string
    'ShopID' => 'abc', // string
    'DateFrom' => 'YYYY-MM-DD', // 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);
}