Query Suppliers

Query Suppliers

curl --request GET \
  --url https://api.jtl-cloud.com/erp/suppliers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/suppliers"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/suppliers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/suppliers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/suppliers")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/suppliers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
  }
]

{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

GET

suppliers

Query Suppliers

curl --request GET \
  --url https://api.jtl-cloud.com/erp/suppliers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/suppliers"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/suppliers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jtl-cloud.com/erp/suppliers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/suppliers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/suppliers")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/suppliers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "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"
  }
]

{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

Authorization

string

header

required

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

Headers

x-runas

string

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

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Response

Returns all suppliers.

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"

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"

Query Serial Number Per Warehouse Get Tax For Item

⌘I

Overview

REST API

Authorizations

Headers

Response