Skip to main content
GET
/
salesOrders
/
customfields
Query Sales Order Custom Fields
curl --request GET \
  --url https://api.jtl-cloud.com/erp/salesOrders/customfields \
  --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>'
[
  {
    "CustomFieldId": 123,
    "GroupName": "Example Group",
    "Name": "Technical Data",
    "Type": 0,
    "PossibleValues": "",
    "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,
      "FeldTyp": {
        "Id": 123,
        "Name": "<string>",
        "DatenTyp": 123,
        "RegEx": "<string>",
        "Typ": 0
      },
      "Bezeichnungen": [
        {
          "AttributId": 123,
          "SpracheId": 123,
          "Name": "<string>",
          "WertListe": "<string>"
        }
      ]
    }
  }
]

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

The requested custom fields for sales orders.

​
CustomFieldId
integer<int32>
required
​
GroupName
string
required

The group name for this custom field.

Example:

"Example Group"

​
Name
string
required

The custom field name.

Example:

"Technical Data"

​
Type
enum<integer>
required

0 = None, 1 = Integer, 2 = Decimal, 3 = Text, 4 = Checkbox, 5 = List, 6 = Url, 7 = Email, 8 = PhoneNumber, 9 = CountryIso, 10 = Price, 11 = Date, 12 = ShortText

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
​
PossibleValues
string[]
required

The possible values, when the custom field is a list.

Example:

""

​
Attribut
object