Suppliers Read

pixiGetSuppliers

Returns supplier master data including the main contact person, optionally limited to active suppliers or to one supplier number.

Reads the supplier master records from Suppliers. Each supplier is joined with its main contact in pixi.Contact via ContactId.

Filtering:

An empty SupplNr is treated like NULL.
If SupplNr is set, only the supplier with this number is returned. It is returned regardless of its active state, so OnlyActive has no effect in this case.
If SupplNr is not set and OnlyActive is 0, all suppliers are returned, including inactive ones.
If SupplNr is not set and OnlyActive has any other value (default 1), only suppliers with Disabled = 0 are returned.

The result is sorted by SupplName.

The main contact fields (MainContact_*) are returned as empty strings if the supplier has no contact or the contact field is empty. The column SupplierIsInactive contains the Disabled flag of the supplier.

Notes

Both tables are read with NOLOCK, so uncommitted changes may be visible.
Any non-zero value of OnlyActive acts like 1. With this filter, suppliers whose Disabled value is NULL are not returned.
Some columns are renamed compared to the table: SupplFaxNr → SupplFaxNR, CustNr → CustNR, MailBox → eMail, Disabled → SupplierIsInactive, SupplComment → SupplierComment.
The column types are not visible in the code; they are taken from the Suppliers and pixi.Contact tables.

Tables used

Suppliers · Read Contact · Read

Parameter Type Default Description

Parameter	Type	Default	Description
`OnlyActive`	int	1	`0` returns all suppliers including inactive ones; any other value returns only active suppliers. Ignored if `SupplNr` is set. Allowed values `0` – Return active and inactive suppliers. `1` – Return only active suppliers (`Disabled = 0`). Example: `1`
`SupplNr`	varchar(4) string	NULL	Supplier number. If set, only this supplier is returned, even if it is inactive. Empty string or `NULL` returns all suppliers matching `OnlyActive`. Example: `LI01`

OnlyActive

int

0 returns all suppliers including inactive ones; any other value returns only active suppliers. Ignored if SupplNr is set.

Allowed values

0 – Return active and inactive suppliers.
1 – Return only active suppliers (`Disabled = 0`).

Example: 1

SupplNr

varchar(4)
string

NULL

Supplier number. If set, only this supplier is returned, even if it is inactive. Empty string or NULL returns all suppliers matching OnlyActive.

Example: LI01

Result set 1 · Always (may be empty if no supplier matches).

One row per supplier with master data and main contact, sorted by SupplName.

Column	Type	Description
`SupplNr`	string	Supplier number.
`SupplName` Nullable	string	Supplier name.
`SupplNameExt` Nullable	string	Extended supplier name.
`DefaultDeliveryDays` Nullable	int	Default delivery time in days.
`SupplFaxNR` Nullable	string	Fax number of the supplier (column `SupplFaxNr`).
`CustNR` Nullable	string	Own customer number at the supplier (column `CustNr`).
`eMail` Nullable	string	E-mail address of the supplier (column `MailBox`).
`SupAnrede` Nullable	string	Salutation of the supplier address.
`SupName2` Nullable	string	Second name line of the supplier address.
`SupAddress` Nullable	string	Street address of the supplier.
`SupZip` Nullable	string	Postal code of the supplier.
`SupPhone1` Nullable	string	First phone number of the supplier.
`CanDoDirectFulfillment` Nullable	boolean	Flag whether the supplier can do direct fulfillment (drop shipping).
`SupplGroup` Nullable	string	Supplier group.
`SupCity` Nullable	string	City of the supplier.
`SupPhone2` Nullable	string	Second phone number of the supplier.
`SupplCtry` Nullable	string	Country of the supplier.
`CurrencyId` Nullable	string	Currency of the supplier.
`eMailSupplOrder` Nullable	string	E-mail address for supplier orders.
`HomePageUrl` Nullable	string	Website of the supplier.
`MainContact_Title`	string	Title of the main contact; empty string if not available.
`MainContact_FirstName`	string	First name of the main contact; empty string if not available.
`MainContact_LastName`	string	Last name of the main contact; empty string if not available.
`MainContact_JobTitle`	string	Job title of the main contact; empty string if not available.
`MainContact_JobFunction`	string	Job function of the main contact; empty string if not available.
`MainContact_Phone`	string	Phone number of the main contact; empty string if not available.
`MainContact_MobilePhone`	string	Mobile phone number of the main contact; empty string if not available.
`MainContact_Fax`	string	Fax number of the main contact; empty string if not available.
`MainContact_Email`	string	E-mail address of the main contact; empty string if not available.
`SupplierIsInactive` Nullable	boolean	Inactive flag of the supplier (column `Disabled`); `0` = active.
`SupplierComment` Nullable	string	Comment on the supplier (column `SupplComment`).

Response example

<SqlRowSet1>
  <row>
    <SupplNr>LI01</SupplNr>
    <SupplName>Muster Großhandel GmbH</SupplName>
    <SupplNameExt>Abteilung Einkauf</SupplNameExt>
    <DefaultDeliveryDays>3</DefaultDeliveryDays>
    <SupplFaxNR>+49 89 1234567-9</SupplFaxNR>
    <CustNR>K-100234</CustNR>
    <eMail>info@muster-grosshandel.de</eMail>
    <SupAnrede>Firma</SupAnrede>
    <SupName2/>
    <SupAddress>Industriestraße 12</SupAddress>
    <SupZip>80331</SupZip>
    <SupPhone1>+49 89 1234567-0</SupPhone1>
    <CanDoDirectFulfillment>0</CanDoDirectFulfillment>
    <SupplGroup>A</SupplGroup>
    <SupCity>München</SupCity>
    <SupPhone2/>
    <SupplCtry>DE</SupplCtry>
    <CurrencyId>EUR</CurrencyId>
    <eMailSupplOrder>bestellung@muster-grosshandel.de</eMailSupplOrder>
    <HomePageUrl>https://www.muster-grosshandel.de</HomePageUrl>
    <MainContact_Title/>
    <MainContact_FirstName>Anna</MainContact_FirstName>
    <MainContact_LastName>Schmidt</MainContact_LastName>
    <MainContact_JobTitle>Key Account Managerin</MainContact_JobTitle>
    <MainContact_JobFunction>Vertrieb</MainContact_JobFunction>
    <MainContact_Phone>+49 89 1234567-21</MainContact_Phone>
    <MainContact_MobilePhone>+49 171 2345678</MainContact_MobilePhone>
    <MainContact_Fax/>
    <MainContact_Email>a.schmidt@muster-grosshandel.de</MainContact_Email>
    <SupplierIsInactive>0</SupplierIsInactive>
    <SupplierComment>Lieferung nur werktags</SupplierComment>
  </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:pixiGetSuppliers>
      <!-- <OnlyActive>1</OnlyActive> -->
      <!-- <SupplNr>LI01</SupplNr> -->
    </ns1:pixiGetSuppliers>
  </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:pixiGetSuppliers>
      <!-- <OnlyActive>1</OnlyActive> -->
      <!-- <SupplNr>LI01</SupplNr> -->
    </ns1:pixiGetSuppliers>
  </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 = [
    // 'OnlyActive' => '1',
    // 'SupplNr' => 'LI01',
];

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

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

SQL object:: dbo.pipiGetSuppliers