Unofficial Pixi-API-Documentation

by koempf24.de

pixiCustomerKeyByNumber

Pixi-Docs
Old Pixi-Docs

Call returns a customer key that is found using the input parameters - shop id and external customer number

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

Customers

Request

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

Request body

Name Type Required Description
ShopId string true

The shop id to look for in the Customers table

Type: char

Default value: NULL

Example: NEW

Available from: LOU Official (6.3.0.4452)
AllowAmbiguous boolean true

Setting to define whether ambiguous results are returned. If set to 0 (false) and the number of returned rows does not equal 1, NULL is returned as a result

Type: bit

Default value: NULL

Example: NEW

Available from: LOU Official (6.3.0.4452)
CustomerNrExternal string true

The external customer number to look for in the Customers table

Type: varchar(60)

Default value: NULL

Example: 1SS_With_BM

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCustomerKeyByNumber>
      <CustomerNrExternal>string</CustomerNrExternal>
      <ShopId>string</ShopId>
      <AllowAmbiguous>true</AllowAmbiguous>
    </pixiCustomerKeyByNumber>
  </Body>
</Envelope>

Response

1. Result set

Name Type Description
CustKey integer

Customer ID

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCustomerKeyByNumberPost200TextXmlResponse>
  <CustKey>0</CustKey>
</PixiCustomerKeyByNumberPost200TextXmlResponse>

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:pixiCustomerKeyByNumber>
            <ShopId xsi:type="xsd:string">NEW</ShopId> <!-- required -->
            <AllowAmbiguous xsi:type="xsd:boolean">NEW</AllowAmbiguous> <!-- required -->
            <CustomerNrExternal xsi:type="xsd:string">1SS_With_BM</CustomerNrExternal> <!-- required -->
        </ns1:pixiCustomerKeyByNumber>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCustomerKeyByNumber', [
    'ShopId' => 'NEW', // string (required)
    'AllowAmbiguous' => 'NEW', // boolean (required)
    'CustomerNrExternal' => '1SS_With_BM', // 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);
}