Create Number Range

Create Number Range

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "prefix": "<string>",
  "currentNumber": 123,
  "suffix": "<string>"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}"

payload = {
    "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "prefix": "<string>",
    "currentNumber": 123,
    "suffix": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    prefix: '<string>',
    currentNumber: 123,
    suffix: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}', 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/number-ranges/{numberRangeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    'prefix' => '<string>',
    'currentNumber' => 123,
    'suffix' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}"

	payload := strings.NewReader("{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}")

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

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}"

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

{
  "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "prefix": "<string>",
  "currentNumber": 123,
  "suffix": "<string>",
  "maxLength": 123,
  "exampleNumber": "<string>",
  "isDeletable": true,
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

{
  "errorCode": "<string>",
  "validationErrors": {},
  "errors": {},
  "errorMessage": "<string>",
  "stacktrace": "<string>"
}

POST

number-ranges

{numberRangeId}

Create Number Range

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "prefix": "<string>",
  "currentNumber": 123,
  "suffix": "<string>"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}"

payload = {
    "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "prefix": "<string>",
    "currentNumber": 123,
    "suffix": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    companyId: 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    prefix: '<string>',
    currentNumber: 123,
    suffix: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}', 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/number-ranges/{numberRangeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companyId' => 'b45f6432-2462-4c6f-b00f-1d9d01000000',
    'prefix' => '<string>',
    'currentNumber' => 123,
    'suffix' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}"

	payload := strings.NewReader("{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/number-ranges/{numberRangeId}")

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

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyId\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\",\n  \"prefix\": \"<string>\",\n  \"currentNumber\": 123,\n  \"suffix\": \"<string>\"\n}"

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

{
  "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "prefix": "<string>",
  "currentNumber": 123,
  "suffix": "<string>",
  "maxLength": 123,
  "exampleNumber": "<string>",
  "isDeletable": true,
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

{
  "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.

FlowAuthorization Code

Authorization URL: https://auth.jtl-cloud.com/oauth2/auth
Token URL: https://auth.jtl-cloud.com/oauth2/token

Scopes1

system.config.write

Grants permission to modify the system configuration.

Headers

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.

Path Parameters

numberRangeId

string<uuid>

required

The ID of the number range on which this number range is based. Schlüssel für einen Nummernkreis Datensatz

Body

application/json

The relevant information of the number range.

A Individuel NumberRange

companyId

string<uuid>

required

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

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

prefix

string

The Number Prefix for the NumberRange

currentNumber

integer<int32>

The Current Number of the NumberRange

suffix

string

The Number Suffix for the NumberRange

Response

The created number range.

A Individuel NumberRange

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

string<uuid>

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

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Overview

GraphQL

REST API

Authorizations

Headers

Path Parameters

Body

Response