Unofficial Pixi-API-Documentation

by koempf24.de

pixiGetAddressesByEmail

Pixi-Docs
Old Pixi-Docs

Return email address data.

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

Customers

Request

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

Request body

Name Type Required Description
Email string true

Email

Type: varchar(60)

Default value:

Example:

Available from: LOU Official (6.3.0.4452)
ShopId string false

ShopId

Type: char

Default value: NULL

Example:

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetAddressesByEmail>
      <Email>string</Email>
      <ShopId>string</ShopId>
    </pixiGetAddressesByEmail>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
Fax string

Fax

Type: varchar

Available from: / (25.7.0.59144)
ZIP string

ZIP

Type: varchar

Available from: / (25.7.0.59144)
City string

City

Type: varchar

Available from: / (25.7.0.59144)
Name string

Name

Type: varchar

Available from: / (25.7.0.59144)
Note string

Note

Type: varchar

Available from: / (25.7.0.59144)
Phone string

Phone

Type: varchar

Available from: / (25.7.0.59144)
Title string

Title

Type: varchar

Available from: / (25.7.0.59144)
eMail string

eMail

Type: varchar

Available from: / (25.7.0.59144)
Street string

Street

Type: varchar

Available from: / (25.7.0.59144)
AddrKey integer

Addr Key

Type: int

Available from: / (25.7.0.59144)
Address string

Address

Type: varchar

Available from: / (25.7.0.59144)
Company string

Company

Type: varchar

Available from: / (25.7.0.59144)
Country string

Country

Type: varchar

Available from: / (25.7.0.59144)
CustKey integer

Cust Key

Type: int

Available from: / (25.7.0.59144)
HouseNr string

House Nr

Type: varchar

Available from: / (25.7.0.59144)
AddrType string

Addr Type

Type: varchar

Available from: / (25.7.0.59144)
LastName string

Last Name

Type: varchar

Available from: / (25.7.0.59144)
FirstName string

First Name

Type: varchar

Available from: / (25.7.0.59144)
CreateDate string

Create Date

Type: datetime

Available from: / (25.7.0.59144)
CountryName string

Country Name

Type: varchar

Available from: / (25.7.0.59144)
CountryCodeISO2 string

Country Code for ISO2

Type: varchar

Available from: / (25.7.0.59144)
CountryCodeISO3 string

Country Code for ISO3

Type: varchar

Available from: / (25.7.0.59144)
CustomerNrExternal string

Customer Nr External

Type: varchar

Available from: / (25.7.0.59144)

Response Example

<PixiGetAddressesByEmailPost200TextXmlResponse>
  <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>
  <CountryName>string</CountryName>
  <CountryCodeISO2>string</CountryCodeISO2>
  <CountryCodeISO3>string</CountryCodeISO3>
</PixiGetAddressesByEmailPost200TextXmlResponse>

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:pixiGetAddressesByEmail>
            <Email xsi:type="xsd:string"></Email> <!-- required -->
            <ShopId xsi:type="xsd:string"></ShopId>
        </ns1:pixiGetAddressesByEmail>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetAddressesByEmail', [
    'Email' => '', // string (required)
    'ShopId' => '', // 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);
}