Skip to main content
GET
/
suppliers
Query Suppliers
curl --request GET \
  --url https://api.jtl-cloud.com/erp/suppliers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "Name": "Global Transport",
    "Type": "Default",
    "SupplierNo": "SP12345",
    "InternalCustomerId": "12",
    "LanguageISO": "DE",
    "FormOfAddress": "Muster Str. 15",
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Tradewell Company",
    "Company2": "Office Department",
    "Contact": "John Smith",
    "Street": "Example St. 15",
    "Address2": "Apartment 201",
    "PostalCode": "10115",
    "City": "Berlin",
    "State": "Berlin",
    "CountryIso": "DE",
    "Phone": "040 / 12345",
    "PhoneExtension": "10",
    "Fax": "040 / 12345-19",
    "Email": "info@a-company-domain.com",
    "Website": "https://a-company-domain.com",
    "Comment": "Comment about the supplier",
    "VatID": "DE123456789",
    "Status": "aktiv"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

Returns all suppliers.

​
Id
integer<int32>
required
​
Name
string
required

Supplier name.

Example:

"Global Transport"

​
Type
string
required
Example:

"Default"

​
SupplierNo
string
required

Supplier ID number.

Example:

"SP12345"

​
InternalCustomerId
string
required

Internal customer ID of the supplier.

Example:

"12"

​
LanguageISO
string
required

The language ISO of a supplier.

Example:

"DE"

​
FormOfAddress
string
required

The form of address of the supplier.

Example:

"Muster Str. 15"

​
FirstName
string
required

Supplier first name.

Example:

"John"

​
LastName
string
required

Supplier last name.

Example:

"Smith"

​
Company
string
required

Name of the supplier's company.

Example:

"Tradewell Company"

​
Company2
string
required

The additional address infomation about the company.

Example:

"Office Department"

​
Contact
string
required

Supplier's contact person.

Example:

"John Smith"

​
Street
string
required

Supplier's street and house number.

Example:

"Example St. 15"

​
Address2
string
required

Additional address information.

Example:

"Apartment 201"

​
PostalCode
string
required

Supplier's postal code.

Example:

"10115"

​
City
string
required

Supplier's city.

Example:

"Berlin"

​
State
string
required

Supplier's state.

Example:

"Berlin"

​
CountryIso
string
required

Country ISO code of the address.

Example:

"DE"

​
Phone
string
required

Supplier's main telephone number.

Example:

"040 / 12345"

​
PhoneExtension
string
required

Supplier's telephone number extension.

Example:

"10"

​
Fax
string
required

Supplier's fax number.

Example:

"040 / 12345-19"

​
Email
string
required

Supplier's email address.

Example:

"info@a-company-domain.com"

​
Website
string
required

Supplier's website.

Example:

"https://a-company-domain.com"

​
Comment
string
required

Additional information about the supplier.

Example:

"Comment about the supplier"

​
VatID
string
required

Supplier's VAT ID number.

Example:

"DE123456789"

​
Status
string
required

Supplier's status.

Example:

"aktiv"