Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetInvoiceShippingInformation

Pixi-Docs
Old Pixi-Docs

API Call to get information about an invoice for Shipping

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

Shipping

Request

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

Request body

Name Type Required Description
InvoiceNr string true

InvoiceNr to Load Invoice

Type: varchar(50)

Default value:

Example: abc

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetInvoiceShippingInformation>
      <InvoiceNr>string</InvoiceNr>
    </pixiGetInvoiceShippingInformation>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Fax string

Fax

Type: varchar

Available from: 25.06 (25.6.0.58802)
ZIP string

ZIP

Type: varchar

Available from: 25.06 (25.6.0.58802)
City string

City

Type: varchar

Available from: 25.06 (25.6.0.58802)
Name string

Name (line 1)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Note string

Note for the Shipping Address (if any)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Shop string

Shop ID

Type: varchar

Available from: 25.06 (25.6.0.58802)
Name2 string

Name (line 2)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Phone string

Phone

Type: varchar

Available from: 25.06 (25.6.0.58802)
State string

State

Type: varchar

Available from: 25.06 (25.6.0.58802)
Total number

Total of the Invoice in EUR

Type: money

Available from: 25.06 (25.6.0.58802)
eMail string

eMail

Type: varchar

Available from: 25.06 (25.6.0.58802)
Anrede string

Salutation

Type: varchar

Available from: 25.06 (25.6.0.58802)
CareOf string

Company (if any)

Type: varchar

Available from: 25.06 (25.6.0.58802)
Street string

Street

Type: varchar

Available from: 25.06 (25.6.0.58802)
UsStId string

VAT ID for the Shipping Address

Type: varchar

Available from: 25.06 (25.6.0.58802)
Address string

Street and House Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
Country string

Country Code in pixi*

Type: varchar

Available from: 25.06 (25.6.0.58802)
HouseNr string

House Number

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvDate string

Invoice Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
Mailbox string

Mailbox

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderNr integer

pixi* order number

Type: int

Available from: 25.06 (25.6.0.58802)
Currency string

Currency of the Invoice

Type: varchar

Available from: 25.06 (25.6.0.58802)
LastName string

Last Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipCost number

Ship Costs in EUR

Type: money

Available from: 25.06 (25.6.0.58802)
ShopNote string

Shop Comment (if there are multiple orders merged in the invoice, there will be only the Shop Comment for the first order)

Type: varchar

Available from: 25.06 (25.6.0.58802)
DHLExtras string

Extra for DHL (if sent by shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)
FirstName string

First Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
InvoiceNr string

Invoice Nr

Type: varchar

Available from: 25.06 (25.6.0.58802)
DHLProdukt string

Produkt for DHL (if sent by shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)
ZIPMailbox string

ZIP for Mailbox

Type: varchar

Available from: 25.06 (25.6.0.58802)
CountryISO2 string

CountryCode in ISO-2 format

Type: char

Available from: 25.06 (25.6.0.58802)
CountryISO3 string

Country Code in ISO-3 format

Type: char

Available from: 25.06 (25.6.0.58802)
CountryName string

Country Name in pixi*

Type: varchar

Available from: 25.06 (25.6.0.58802)
GiftMessage string

Gift Message

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaymentCode string

Payment Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
PaymentText string

Payment Text

Type: varchar

Available from: 25.06 (25.6.0.58802)
DHLVerfahren string

Verfahren (if sent by shop)

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderShipDate string

Order Ship Date

Type: datetime

Available from: 25.06 (25.6.0.58802)
ShipVendorCode string

Shipping Vendor Code

Type: varchar

Available from: 25.06 (25.6.0.58802)
ShipVendorName string

Shipping Vendor

Type: varchar

Available from: 25.06 (25.6.0.58802)
Address_Remarks string

Address Remarks for this order ("Adresszusatz")

Type: varchar

Available from: 25.06 (25.6.0.58802)
OrderNrExternal string

External order number

Type: varchar

Available from: 25.06 (25.6.0.58802)
Total_OrderCurr number

Total in InvoiceCurrency

Type: money

Available from: 25.06 (25.6.0.58802)
PackageNetWeight number

Package net weight

Type: numeric

Available from: 25.06 (25.6.0.58802)
EasylogCountryName string

DHL EasyLog Country Name

Type: varchar

Available from: 25.06 (25.6.0.58802)
PackageGrossWeight number

Package gross weight

Type: numeric

Available from: 25.06 (25.6.0.58802)
ShipCost_OrderCurr number

Shipping Costs in Invoice Currency

Type: money

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetInvoiceShippingInformationPost200TextXmlResponse>
  <InvoiceNr>string</InvoiceNr>
  <InvDate>string</InvDate>
  <Shop>string</Shop>
  <PaymentCode>string</PaymentCode>
  <PaymentText>string</PaymentText>
  <ShipVendorCode>string</ShipVendorCode>
  <ShipVendorName>string</ShipVendorName>
  <Total>0</Total>
  <Currency>string</Currency>
  <Total_OrderCurr>0</Total_OrderCurr>
  <ShipCost>0</ShipCost>
  <ShipCost_OrderCurr>0</ShipCost_OrderCurr>
  <Anrede>string</Anrede>
  <Name>string</Name>
  <Name2>string</Name2>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <CareOf>string</CareOf>
  <Address>string</Address>
  <Street>string</Street>
  <HouseNr>string</HouseNr>
  <City>string</City>
  <State>string</State>
  <ZIP>string</ZIP>
  <Country>string</Country>
  <CountryName>string</CountryName>
  <EasylogCountryName>string</EasylogCountryName>
  <CountryISO2>string</CountryISO2>
  <CountryISO3>string</CountryISO3>
  <ZIPMailbox>string</ZIPMailbox>
  <Mailbox>string</Mailbox>
  <Phone>string</Phone>
  <Fax>string</Fax>
  <eMail>string</eMail>
  <UsStId>string</UsStId>
  <Note>string</Note>
  <Address_Remarks>string</Address_Remarks>
  <DHLVerfahren>string</DHLVerfahren>
  <DHLProdukt>string</DHLProdukt>
  <DHLExtras>string</DHLExtras>
  <GiftMessage>string</GiftMessage>
  <OrderShipDate>string</OrderShipDate>
  <ShopNote>string</ShopNote>
  <OrderNr>0</OrderNr>
  <OrderNrExternal>string</OrderNrExternal>
  <PackageNetWeight>0</PackageNetWeight>
  <PackageGrossWeight>0</PackageGrossWeight>
</PixiGetInvoiceShippingInformationPost200TextXmlResponse>

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:pixiGetInvoiceShippingInformation>
            <InvoiceNr xsi:type="xsd:string">abc</InvoiceNr> <!-- required -->
        </ns1:pixiGetInvoiceShippingInformation>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetInvoiceShippingInformation', [
    'InvoiceNr' => 'abc', // string (required)
]);

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);
}