Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetAddress

Pixi-Docs
Old Pixi-Docs

Recommended

Return address and customer data for given AddrKey (internal Id).

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

Customers

Request

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

Request body

Name Type Required Description
AddrKey integer true

Get data for this AddrKey (internal Address Id).

Type: int

Default value:

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetAddress>
      <AddrKey>0</AddrKey>
    </pixiGetAddress>
  </Body>
</Envelope>

Response

1. Address and customer data for given AddrKey (internal Id).

Name Type Description
BIC string

Bank Identifier Code.

Type: VARCHAR(11)

Available from: 25.06 (25.6.0.58802)
BLZ string

Bank code.

Type: VARCHAR(8)

Available from: 25.06 (25.6.0.58802)
Fax string

Fax number from address of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
ZIP string

ZIP from address of customer.

Type: VARCHAR(10)

Available from: 25.06 (25.6.0.58802)
City string

City from address of customer.

Type: VARCHAR(50)

Available from: 25.06 (25.6.0.58802)
IBAN string

International Bank Account Number.

Type: VARCHAR(35)

Available from: 25.06 (25.6.0.58802)
Name string

Full name of customer.

Type: VARCHAR(121)

Available from: 25.06 (25.6.0.58802)
Note string

Address note (remarks).

Type: VARCHAR(MAX)

Available from: 25.06 (25.6.0.58802)
Email string

Email address from address of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
Phone string

Phone number from address of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
Title string

Title (salutation) of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
VatID string

VAT Id of customer.

Type: VARCHAR(20)

Available from: 25.06 (25.6.0.58802)
Street string

Street from address of customer.

Type: VARCHAR(100)

Available from: 25.06 (25.6.0.58802)
AddrKey integer

Address Id - internal.

Type: INT

Available from: 25.06 (25.6.0.58802)
Address string

Full street address of customer.

Type: VARCHAR(110)

Available from: 25.06 (25.6.0.58802)
CntName string

Country code from address.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
Company string

Company of customer - optional.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
Country string

Country code from address of customer.

Type: VARCHAR(3)

Available from: 25.06 (25.6.0.58802)
CustKey integer

Customer Id - internal.

Type: INT

Available from: 25.06 (25.6.0.58802)
HouseNr string

House number from address of customer.

Type: VARCHAR(12)

Available from: 25.06 (25.6.0.58802)
AddrType string

Address Type: B - Billing address, S - Shipping address.

Type: VARCHAR(1)

Available from: 25.06 (25.6.0.58802)
LastName string

Last name of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
AccountNr string

Bank account number from address.

Type: VARCHAR(10)

Available from: 25.06 (25.6.0.58802)
BirthDate string

Customers birth date from address.

Type: DATETIME

Available from: 25.06 (25.6.0.58802)
FirstName string

First name of customer.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)
CreateDate string

Address creation date.

Type: DATETIME

Available from: 25.06 (25.6.0.58802)
CntCodeISO2 string

ISO 2 Country code from address.

Type: VARCHAR(2)

Available from: 25.06 (25.6.0.58802)
CntCodeISO3 string

ISO 3 Country code from address.

Type: VARCHAR(3)

Available from: 25.06 (25.6.0.58802)
PaymentType string

Payment type code from address.

Type: VARCHAR(1)

Available from: 25.06 (25.6.0.58802)
AccountOwner string

Bank account owner name from address.

Type: VARCHAR(27)

Available from: 25.06 (25.6.0.58802)
CustomerNrExternal string

External Customer number.

Type: VARCHAR(60)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiGetAddressPost200TextXmlResponse>
  <AddrKey>0</AddrKey>
  <AddrType>string</AddrType>
  <CustomerNrExternal>string</CustomerNrExternal>
  <Title>string</Title>
  <Name>string</Name>
  <FirstName>string</FirstName>
  <LastName>string</LastName>
  <Company>string</Company>
  <Address>string</Address>
  <Street>string</Street>
  <HouseNr>string</HouseNr>
  <City>string</City>
  <ZIP>string</ZIP>
  <Country>string</Country>
  <Phone>string</Phone>
  <Fax>string</Fax>
  <Email>string</Email>
  <CreateDate>string</CreateDate>
  <Note>string</Note>
  <CustKey>0</CustKey>
  <VatID>string</VatID>
  <CntName>string</CntName>
  <CntCodeISO2>string</CntCodeISO2>
  <CntCodeISO3>string</CntCodeISO3>
  <AccountNr>string</AccountNr>
  <AccountOwner>string</AccountOwner>
  <BLZ>string</BLZ>
  <BIC>string</BIC>
  <IBAN>string</IBAN>
  <PaymentType>string</PaymentType>
  <BirthDate>string</BirthDate>
</PixiGetAddressPost200TextXmlResponse>

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:pixiGetAddress>
            <AddrKey xsi:type="xsd:integer"></AddrKey> <!-- required -->
        </ns1:pixiGetAddress>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetAddress', [
    'AddrKey' => '', // integer (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);
}