Query Sales Order Custom Fields
curl --request GET \
--url https://api.jtl-cloud.com/erp/v2/sales-orders/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <x-tenant-id>'import requests
url = "https://api.jtl-cloud.com/erp/v2/sales-orders/custom-fields"
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/v2/sales-orders/custom-fields', 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/v2/sales-orders/custom-fields",
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/v2/sales-orders/custom-fields"
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/v2/sales-orders/custom-fields")
.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/v2/sales-orders/custom-fields")
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[
{
"customFieldId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"groupName": "<string>",
"name": "<string>",
"type": 0,
"possibleValues": [
"<string>"
],
"attribut": {
"id": 123,
"istMehrsprachig": 123,
"istFreifeld": 123,
"sortierung": 123,
"beschreibung": "<string>",
"bezugstyp": 123,
"ausgabeweg": 123,
"istStandard": 123,
"feldTypId": 123,
"regEx": "<string>",
"gruppeName": "<string>",
"readOnly": 123,
"aktivFuerArtikelOhneWarengruppe": true,
"istPflichtfeld": true,
"attributId": "<string>",
"istUnsichtbar": true,
"skipHooks": true,
"feldTyp": {
"id": 123,
"name": "<string>",
"datenTyp": 123,
"regEx": "<string>",
"skipHooks": true,
"typ": 0
},
"bezeichnungen": [
{
"attributId": 123,
"spracheId": 123,
"name": "<string>",
"wertListe": "<string>",
"skipHooks": true
}
]
}
}
]{
"errorCode": "<string>",
"validationErrors": {},
"errors": {},
"errorMessage": "<string>",
"stacktrace": "<string>"
}Sales Order
Query Sales Order Custom Fields
Queries all custom fields for a sales order.
GET
/
v2
/
sales-orders
/
custom-fields
Query Sales Order Custom Fields
curl --request GET \
--url https://api.jtl-cloud.com/erp/v2/sales-orders/custom-fields \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <x-tenant-id>'import requests
url = "https://api.jtl-cloud.com/erp/v2/sales-orders/custom-fields"
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/v2/sales-orders/custom-fields', 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/v2/sales-orders/custom-fields",
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/v2/sales-orders/custom-fields"
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/v2/sales-orders/custom-fields")
.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/v2/sales-orders/custom-fields")
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[
{
"customFieldId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
"groupName": "<string>",
"name": "<string>",
"type": 0,
"possibleValues": [
"<string>"
],
"attribut": {
"id": 123,
"istMehrsprachig": 123,
"istFreifeld": 123,
"sortierung": 123,
"beschreibung": "<string>",
"bezugstyp": 123,
"ausgabeweg": 123,
"istStandard": 123,
"feldTypId": 123,
"regEx": "<string>",
"gruppeName": "<string>",
"readOnly": 123,
"aktivFuerArtikelOhneWarengruppe": true,
"istPflichtfeld": true,
"attributId": "<string>",
"istUnsichtbar": true,
"skipHooks": true,
"feldTyp": {
"id": 123,
"name": "<string>",
"datenTyp": 123,
"regEx": "<string>",
"skipHooks": true,
"typ": 0
},
"bezeichnungen": [
{
"attributId": 123,
"spracheId": 123,
"name": "<string>",
"wertListe": "<string>",
"skipHooks": true
}
]
}
}
]{
"errorCode": "<string>",
"validationErrors": {},
"errors": {},
"errorMessage": "<string>",
"stacktrace": "<string>"
}Authorizations
oauth2-authorization-codeoauth2-client-credentials
The access token received from the authorization server in the OAuth 2.0 flow.
FlowAuthorization Code
- Authorization URL
- https://auth.jtl-cloud.com/oauth2/auth
- Token URL
- https://auth.jtl-cloud.com/oauth2/token
Scopes2
salesorders.read
Grants permission to read sales orders.
all.read
Allows the application to read all data.
Headers
The Company-Id (int or uuid) of the company on whose behalf the request is executed.
The tenant ID for the target ERP instance.
Response
The requested custom fields for sales orders.
Unique ID to identify a custom field.
Example:
"b45f6432-2462-4c6f-b00f-1d9d01000000"
The group name for this custom field.
The custom field name.
The custom field type.
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 The possible values, when the custom field is a list.
Attribute dienen zur flexibleren Verteilung von Eigenschaften zu bestimmten Objekten
Show child attributes
Show child attributes
Was this page helpful?