Skip to main content
GET
/
configuration
/
numberRanges
Get Number Ranges
curl --request GET \
  --url https://api.jtl-cloud.com/erp/configuration/numberRanges \
  --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>'
[
  {
    "Identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "Name": "<string>",
    "Description": "<string>",
    "Prefix": "<string>",
    "CurrentNumber": 123,
    "Suffix": "<string>",
    "MaxLength": 123,
    "ExampleNumber": "<string>",
    "IsDeletable": true,
    "CompanyId": 123
  }
]

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-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

The available Number Ranges

​
Identifier
string<uuid>
required

The Unique Identifier of a Sync

​
Name
string
required

The Name of the Number Range

​
Description
string
required

The Name of the Number Range

​
Prefix
string
required

The Number Prefix for the NumberRange

​
CurrentNumber
integer<int32>
required

The Current Number of the NumberRange

​
Suffix
string
required

The Number Suffix for the NumberRange

​
MaxLength
integer<int32>
required

The Max Length of an Number Range

​
ExampleNumber
string
required

The Example of a Number

​
IsDeletable
boolean
required

Can the Number Range be deleted

​
CompanyId
integer<int32>

The internal ID of the company associated with the customer. This is configured in the company and email settings in JTL-Wawi