Skip to main content
GET
/
v1
/
suppliers
Query Suppliers
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/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": "<string>",
    "Type": "<string>",
    "SupplierNo": "<string>",
    "InternalCustomerId": "<string>",
    "LanguageISO": "<string>",
    "FormOfAddress": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "Company": "<string>",
    "Company2": "<string>",
    "Contact": "<string>",
    "Street": "<string>",
    "Address2": "<string>",
    "PostalCode": "<string>",
    "City": "<string>",
    "State": "<string>",
    "CountryIso": "<string>",
    "Phone": "<string>",
    "PhoneExtension": "<string>",
    "Fax": "<string>",
    "Email": "<string>",
    "Website": "<string>",
    "Comment": "<string>",
    "VatID": "<string>",
    "Status": "<string>",
    "LastChangedDate": "2023-11-07T05:31:56Z"
  }
]

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

​
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-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Response

Returns all suppliers.

​
Id
integer<int32>
required

Unique ID to identify a supplier.

​
Name
string
required

Supplier name.

​
Type
string
required
​
SupplierNo
string
required

Supplier ID number.

​
InternalCustomerId
string
required

Internal customer ID of the supplier.

​
LanguageISO
string
required

The language ISO of a supplier.

​
FormOfAddress
string
required

The form of address of the supplier.

​
FirstName
string
required

Supplier first name.

​
LastName
string
required

Supplier last name.

​
Company
string
required

Name of the supplier's company.

​
Company2
string
required

The additional address infomation about the company.

​
Contact
string
required

Supplier's contact person.

​
Street
string
required

Supplier's street and house number.

​
Address2
string
required

Additional address information.

​
PostalCode
string
required

Supplier's postal code.

​
City
string
required

Supplier's city.

​
State
string
required

Supplier's state.

​
CountryIso
string
required

Country ISO code of the address.

​
Phone
string
required

Supplier's main telephone number.

​
PhoneExtension
string
required

Supplier's telephone number extension.

​
Fax
string
required

Supplier's fax number.

​
Email
string
required

Supplier's email address.

​
Website
string
required

Supplier's website.

​
Comment
string
required

Additional information about the supplier.

​
VatID
string
required

Supplier's VAT ID number.

​
Status
string
required

Supplier's status.

​
LastChangedDate
string<date-time>
required

Last change date of the supplier.