pixiGetSuppliers
API call returns supplier data
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
SupplNr | string | false | [optional] if value is passed, then only the supplier with specified SupplNr is returned. Otherwise, all suppliers are returned. See also parameter OnlyActive Type: varchar(4) Default value: NULL Example: abcd Available from: LOU Official (6.3.0.4452) |
OnlyActive | integer | false | Return only active suppliers Type: INT Default value: 1 Example: 0 or 1 Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetSuppliers>
<OnlyActive>0</OnlyActive>
<SupplNr>string</SupplNr>
</pixiGetSuppliers>
</Body>
</Envelope>
Response
1. Supplier data
Name | Type | Description |
---|---|---|
string | E-Mail address Type: varchar Available from: 25.06 (25.6.0.58802) |
|
CustNR | string | Customer number Type: varchar Available from: 25.06 (25.6.0.58802) |
SupZip | string | Supplier ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
SupCity | string | Supplier City Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplNr | string | Supplier number (code) Type: varchar Available from: 25.06 (25.6.0.58802) |
SupName2 | string | Supplier Name Type: varchar Available from: 25.06 (25.6.0.58802) |
SupAnrede | string | Supplier Title Type: varchar Available from: 25.06 (25.6.0.58802) |
SupPhone1 | string | Supplier Phone Type: varchar Available from: 25.06 (25.6.0.58802) |
SupPhone2 | string | Supplier 2nd phone number Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplCtry | string | Supplier Country Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplName | string | Supplier name Type: varchar Available from: 25.06 (25.6.0.58802) |
CurrencyId | string | Currency ID (always EUR) Type: smallint Available from: 25.06 (25.6.0.58802) |
SupAddress | string | Supplier Address Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplFaxNR | string | Fax number Type: varchar Available from: 25.06 (25.6.0.58802) |
SupplGroup | string | Supplier group Type: varchar Available from: 25.06 (25.6.0.58802) |
HomePageUrl | string | Supplier home page URL Type: nvarchar Available from: 25.06 (25.6.0.58802) |
SupplNameExt | string | External supplier name Type: varchar Available from: 25.06 (25.6.0.58802) |
MainContact_Fax | string | Main contact fax number Type: nvarchar Available from: 25.06 (25.6.0.58802) |
SupplierComment | string | Supplier comment Type: varchar Available from: 25.06 (25.6.0.58802) |
eMailSupplOrder | string | E-mail where to send the supplier order Type: varchar Available from: 25.06 (25.6.0.58802) |
MainContact_Email | string | Main contact e-mail address Type: nvarchar Available from: 25.06 (25.6.0.58802) |
MainContact_Phone | string | Main contact phone number Type: varchar Available from: 25.06 (25.6.0.58802) |
MainContact_Title | string | Main contact title Type: nvarchar Available from: 25.06 (25.6.0.58802) |
SupplierIsInactive | boolean | Indicator if the supplier is marked as inactive in pixi* Type: bit Available from: 25.06 (25.6.0.58802) |
DefaultDeliveryDays | integer | Default delivery days Type: int Available from: 25.06 (25.6.0.58802) |
MainContact_JobTitle | string | Main contact job title Type: nvarchar Available from: 25.06 (25.6.0.58802) |
MainContact_LastName | string | Main contact last name Type: nvarchar Available from: 25.06 (25.6.0.58802) |
MainContact_FirstName | string | Main contact first name Type: nvarchar Available from: 25.06 (25.6.0.58802) |
CanDoDirectFulfillment | boolean | Indicator if supplier can do direct fullfillment Type: bit Available from: 25.06 (25.6.0.58802) |
MainContact_JobFunction | string | Main contact job function Type: nvarchar Available from: 25.06 (25.6.0.58802) |
MainContact_MobilePhone | string | Main contact mobile phone number Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetSuppliersPost200TextXmlResponse>
<SupplNr>string</SupplNr>
<SupplName>string</SupplName>
<SupplNameExt>string</SupplNameExt>
<DefaultDeliveryDays>0</DefaultDeliveryDays>
<SupplFaxNR>string</SupplFaxNR>
<CustNR>string</CustNR>
<eMail>string</eMail>
<SupAnrede>string</SupAnrede>
<SupName2>string</SupName2>
<SupAddress>string</SupAddress>
<SupZip>string</SupZip>
<SupPhone1>string</SupPhone1>
<CanDoDirectFulfillment>true</CanDoDirectFulfillment>
<SupplGroup>string</SupplGroup>
<SupCity>string</SupCity>
<SupPhone2>string</SupPhone2>
<SupplCtry>string</SupplCtry>
<CurrencyId>string</CurrencyId>
<eMailSupplOrder>string</eMailSupplOrder>
<HomePageUrl>string</HomePageUrl>
<MainContact_Title>string</MainContact_Title>
<MainContact_FirstName>string</MainContact_FirstName>
<MainContact_LastName>string</MainContact_LastName>
<MainContact_JobTitle>string</MainContact_JobTitle>
<MainContact_JobFunction>string</MainContact_JobFunction>
<MainContact_Phone>string</MainContact_Phone>
<MainContact_MobilePhone>string</MainContact_MobilePhone>
<MainContact_Fax>string</MainContact_Fax>
<MainContact_Email>string</MainContact_Email>
<SupplierIsInactive>true</SupplierIsInactive>
<SupplierComment>string</SupplierComment>
</PixiGetSuppliersPost200TextXmlResponse>
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:pixiGetSuppliers>
<SupplNr xsi:type="xsd:string">abcd</SupplNr>
<OnlyActive xsi:type="xsd:integer">0 or 1</OnlyActive>
</ns1:pixiGetSuppliers>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetSuppliers', [
'SupplNr' => 'abcd', // string
'OnlyActive' => '0 or 1', // integer
]);
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);
}