API call returns supplier data

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


Request

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

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)


Response

1. Supplier data

Name Type Description
eMail 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)