General Read

pixiGetShops

Returns the master data of all shops or of a single shop, including address, contact, footer-based bank details and cost center.

Reads the shop master data from the shops table.

If ShopID is passed, only the shop with this ID is returned.
If ShopID is omitted, NULL or an empty string, all shops are returned.

No sort order is defined, so rows come back in whatever order the database returns them. Some columns are renamed in the result: SI_WebAddr becomes ShopURL, SI_Address becomes ShopCompany, and the footer lines SI_FootLine1 to SI_FootLine4 are returned as BIC, IBAN, KontoBLZ and BankName.

Notes

The table is read with NOLOCK, so uncommitted data can appear in the result.
The bank-related column names (BIC, IBAN, KontoBLZ, BankName) are only aliases for the generic footer lines SI_FootLine1 to SI_FootLine4. They contain whatever has been entered in these footer lines, which is not necessarily bank data.
An unknown ShopID does not raise an error; the result set is simply empty.

Tables used

shops · Read

Parameter	Type	Default	Description
`ShopID`	varchar(3) string	NULL	ID of the shop to return. If it is empty or `NULL`, all shops are returned. Example: `ABC`

Result set 1 · Always (empty if no shop matches)

One row per shop.

Column	Type	Description
`ShopID`	varchar(3) string	Shop ID.
`ShopName` Nullable	string	Name of the shop.
`ShopURL` Nullable	string	Web address of the shop (`SI_WebAddr`).
`Address` Nullable	string	Street address.
`City` Nullable	string	City.
`State` Nullable	string	State or region.
`ZIP` Nullable	string	Postal code.
`Country` Nullable	string	Country.
`Contact` Nullable	string	Contact person.
`Phone` Nullable	string	Phone number.
`Fax` Nullable	string	Fax number.
`ShopCompany` Nullable	string	Company address line used for shop documents (`SI_Address`).
`eMail` Nullable	string	E-mail address.
`SI_fon` Nullable	string	Phone number used for shop documents.
`SI_Fax` Nullable	string	Fax number used for shop documents.
`BIC` Nullable	string	Footer line 1 (`SI_FootLine1`), intended for the BIC.
`IBAN` Nullable	string	Footer line 2 (`SI_FootLine2`), intended for the IBAN.
`KontoBLZ` Nullable	string	Footer line 3 (`SI_FootLine3`), intended for account number and bank code.
`BankName` Nullable	string	Footer line 4 (`SI_FootLine4`), intended for the bank name.
`CostCenter` Nullable	string	Cost center assigned to the shop.

Response example

<SqlRowSet1>
  <row>
    <ShopID>ABC</ShopID>
    <ShopName>Example Shop</ShopName>
    <ShopURL>https://www.example-shop.de</ShopURL>
    <Address>Hauptstraße 1</Address>
    <City>München</City>
    <State>BY</State>
    <ZIP>80331</ZIP>
    <Country>DE</Country>
    <Contact>Max Mustermann</Contact>
    <Phone>+49 89 123456</Phone>
    <Fax>+49 89 123457</Fax>
    <ShopCompany>Example GmbH</ShopCompany>
    <eMail>info@example-shop.de</eMail>
    <SI_fon>+49 89 123456</SI_fon>
    <SI_Fax>+49 89 123457</SI_Fax>
    <BIC>BIC: DEUTDEMMXXX</BIC>
    <IBAN>IBAN: DE89370400440532013000</IBAN>
    <KontoBLZ>Konto 532013000 BLZ 37040044</KontoBLZ>
    <BankName>Deutsche Bank</BankName>
    <CostCenter>100</CostCenter>
  </row>
</SqlRowSet1>

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:pixiGetShops>
      <!-- <ShopID>ABC</ShopID> -->
    </ns1:pixiGetShops>
  </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:pixiGetShops>
      <!-- <ShopID>ABC</ShopID> -->
    </ns1:pixiGetShops>
  </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 = [
    // 'ShopID' => 'ABC',
];

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

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

SQL object:: dbo.pipiGetShops