Customers Lesen

pixiCustomerKeyByNumber

Liefert den internen Kundenschlüssel (CustKey) zu einer externen Kundennummer innerhalb eines Shops.

Sucht einen Kunden in der Tabelle Customers anhand der externen Kundennummer (CustomerNrExternal) und des Shops, dem der Kunde zugeordnet ist (CustomerOf = ShopId).

Bei AllowAmbiguous = 1 wird der Schlüssel eines passenden Kunden geliefert, auch wenn mehrere Kunden im Shop dieselbe externe Nummer haben.
Bei AllowAmbiguous = 0 wird nur dann ein Schlüssel geliefert, wenn genau ein Kunde passt. Bei mehreren Treffern ist die Ergebnismenge leer.
Gibt es keinen Treffer, ist die Ergebnismenge leer.

Es wird höchstens eine Zeile zurückgegeben.

Hinweise

Alle Parameter sind Pflicht; keiner hat einen Standardwert.
Die Abfrage nutzt TOP 1 ohne ORDER BY. Bei AllowAmbiguous = 1 und mehreren Treffern ist nicht festgelegt, welcher CustKey geliefert wird.
Gelesen wird mit NOLOCK, daher können nicht festgeschriebene Daten sichtbar sein.
Eine leere Ergebnismenge bedeutet entweder keinen Treffer oder, bei AllowAmbiguous = 0, einen mehrdeutigen Treffer. Der Aufrufer kann die beiden Fälle nicht unterscheiden.

Parameter

Parameter Typ Standardwert Beschreibung

Parameter	Typ	Standardwert	Beschreibung
`CustomerNrExternal` Pflicht	varchar(60) string	–	Externe Kundennummer, z. B. die Kundennummer im Onlineshop. Beispiel: `WEB-100245`
`ShopId` Pflicht	char(3) string	–	Shop-ID, der der Kunde zugeordnet ist. Der Wert wird mit `Customers.CustomerOf` verglichen. Beispiel: `SHP`
`AllowAmbiguous` Pflicht	bit boolean	–	Steuert, ob bei mehreren passenden Kunden ein Schlüssel geliefert wird. Erlaubte Werte `0` – Schlüssel nur liefern, wenn genau ein Kunde passt. `1` – Schlüssel eines passenden Kunden liefern, auch bei mehreren Treffern. Beispiel: `0`

CustomerNrExternal

Pflicht

varchar(60)
string

–

Externe Kundennummer, z. B. die Kundennummer im Onlineshop.

Beispiel: WEB-100245

ShopId

Pflicht

char(3)
string

–

Shop-ID, der der Kunde zugeordnet ist. Der Wert wird mit Customers.CustomerOf verglichen.

Beispiel: SHP

AllowAmbiguous

Pflicht

bit
boolean

–

Steuert, ob bei mehreren passenden Kunden ein Schlüssel geliefert wird.

Erlaubte Werte

0 – Schlüssel nur liefern, wenn genau ein Kunde passt.
1 – Schlüssel eines passenden Kunden liefern, auch bei mehreren Treffern.

Beispiel: 0

Antwort

Result-Set 1 · Immer. Enthält eine Zeile, wenn ein passender Kunde gefunden wird und die Eindeutigkeitsregel erfüllt ist, sonst keine Zeile.

Interner Schlüssel des gefundenen Kunden.

Spalte	Typ	Beschreibung
`CustKey`	int	Interner Kundenschlüssel aus `Customers.CustKey`.

Beispielantwort

<SqlRowSet1>
  <row>
    <CustKey>48213</CustKey>
  </row>
</SqlRowSet1>

Beispiele

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiCustomerKeyByNumber>
      <CustomerNrExternal>WEB-100245</CustomerNrExternal>
      <ShopId>SHP</ShopId>
      <AllowAmbiguous>0</AllowAmbiguous>
    </ns1:pixiCustomerKeyByNumber>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiCustomerKeyByNumber>
      <CustomerNrExternal>WEB-100245</CustomerNrExternal>
      <ShopId>SHP</ShopId>
      <AllowAmbiguous>0</AllowAmbiguous>
    </ns1:pixiCustomerKeyByNumber>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'CustomerNrExternal' => 'WEB-100245',
    'ShopId' => 'SHP',
    'AllowAmbiguous' => '0',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiCustomerKeyByNumber', $soapArguments);

Verwendete Tabellen

Customers · Lesen

SQL-Objekt:: dbo.pipiCustomerKeyByNumber