Get Customer

Get Customer

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

import requests

url = "https://api.jtl-cloud.com/erp/customers/{customerId}"

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/customers/{customerId}', 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/customers/{customerId}",
  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/customers/{customerId}"

	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/customers/{customerId}")
  .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/customers/{customerId}")

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,
  "Number": "C1005486",
  "CustomerGroupId": 123,
  "BillingAddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "Shipmentaddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "CustomAddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "OtherAddresses": {
    "OtherBillingAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ],
    "OtherShippingAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ],
    "OtherCustomerAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ]
  },
  "PaymentSettings": {
    "PaymentMethodId": 123,
    "Discount": 5,
    "PaymentTarget": 3,
    "CreditLimit": 100,
    "StopPaymentRequest": false
  },
  "CustomerSince": "2023-02-01T13:30:00.0000000+00:00",
  "LastChange": "2023-02-01T13:30:00.0000000+00:00",
  "LanguageIso": "DE",
  "InternalCompanyId": 123,
  "CustomerCategoryId": 123,
  "TaxIdentificationNumber": "123/123/12345",
  "AccountsReceivableNumber": 10000,
  "CommercialRegisterNumber": "HRB 1234",
  "Website": "https://mywebsite.com",
  "InitialContact": "Amazon",
  "EbayUsername": "eBaybuyer123",
  "Birthday": "1985-01-01T",
  "IsLocked": false,
  "IsCashRegisterBased": false
}

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

GET

customers

{customerId}

Get Customer

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

import requests

url = "https://api.jtl-cloud.com/erp/customers/{customerId}"

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/customers/{customerId}', 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/customers/{customerId}",
  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/customers/{customerId}"

	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/customers/{customerId}")
  .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/customers/{customerId}")

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,
  "Number": "C1005486",
  "CustomerGroupId": 123,
  "BillingAddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "Shipmentaddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "CustomAddress": {
    "Id": 123,
    "Company": "Sportbedarf Sommer",
    "Company2": "Innovation Division",
    "FormOfAddress": "Mr.",
    "Title": "Dr.",
    "FirstName": "John",
    "LastName": "Doe",
    "Street": "Main St. 123",
    "Address2": "Floor 5, Apt 302",
    "PostalCode": "12345",
    "City": "Example City",
    "State": "Example State",
    "CountryIso": "DE",
    "VatID": "DE123456789",
    "PhoneNumber": "+49 1234 445556661",
    "MobilePhoneNumber": "+49 160 123 4567",
    "EmailAddress": "example@email.com",
    "Fax": "+49 1234 4455566615"
  },
  "OtherAddresses": {
    "OtherBillingAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ],
    "OtherShippingAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ],
    "OtherCustomerAddresses": [
      {
        "Id": 123,
        "Company": "Sportbedarf Sommer",
        "Company2": "Innovation Division",
        "FormOfAddress": "Mr.",
        "Title": "Dr.",
        "FirstName": "John",
        "LastName": "Doe",
        "Street": "Main St. 123",
        "Address2": "Floor 5, Apt 302",
        "PostalCode": "12345",
        "City": "Example City",
        "State": "Example State",
        "CountryIso": "DE",
        "VatID": "DE123456789",
        "PhoneNumber": "+49 1234 445556661",
        "MobilePhoneNumber": "+49 160 123 4567",
        "EmailAddress": "example@email.com",
        "Fax": "+49 1234 4455566615"
      }
    ]
  },
  "PaymentSettings": {
    "PaymentMethodId": 123,
    "Discount": 5,
    "PaymentTarget": 3,
    "CreditLimit": 100,
    "StopPaymentRequest": false
  },
  "CustomerSince": "2023-02-01T13:30:00.0000000+00:00",
  "LastChange": "2023-02-01T13:30:00.0000000+00:00",
  "LanguageIso": "DE",
  "InternalCompanyId": 123,
  "CustomerCategoryId": 123,
  "TaxIdentificationNumber": "123/123/12345",
  "AccountsReceivableNumber": 10000,
  "CommercialRegisterNumber": "HRB 1234",
  "Website": "https://mywebsite.com",
  "InitialContact": "Amazon",
  "EbayUsername": "eBaybuyer123",
  "Birthday": "1985-01-01T",
  "IsLocked": false,
  "IsCashRegisterBased": false
}

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

Path Parameters

customerId

integer<int32>

required

Response

Returns the customer for the given id.

Model Class: Customer

integer<int32>

required

Number

string

required

The customer's number.

Example:

"C1005486"

CustomerGroupId

integer<int32>

required

BillingAddress

object

required

Model Class: Address

Show child attributes

Shipmentaddress

object

required

Model Class: Address

Show child attributes

CustomAddress

object

required

Model Class: Address

Show child attributes

OtherAddresses

object

required

Model Class: OtherAddresses

Show child attributes

PaymentSettings

object

required

Model Class: PaymentSettings

Show child attributes

CustomerSince

string<date-time>

required

Date since they have been a customer.

Example:

"2023-02-01T13:30:00.0000000+00:00"

LastChange

string<date-time>

required

Date of the last customer's data change.

Example:

"2023-02-01T13:30:00.0000000+00:00"

LanguageIso

string

required

The customer's language.

Example:

"DE"

InternalCompanyId

integer<int32>

required

CustomerCategoryId

integer<int32>

required

TaxIdentificationNumber

string

required

The customer's tax identification number.

Example:

"123/123/12345"

AccountsReceivableNumber

integer<int32>

required

The customer's accounts receivable number.

Example:

10000

CommercialRegisterNumber

string

required

The customer's commercial register number.

Example:

"HRB 1234"

Website

string

required

The customer's website.

Example:

"https://mywebsite.com"

InitialContact

string

required

The source of initial contact. This could be for example a specific sales channel, a convention or a marketing campaign.

Example:

"Amazon"

EbayUsername

string

required

The customer's eBay username.

Example:

"eBaybuyer123"

Birthday

string<date-time>

required

The customer's date of birth.

Example:

"1985-01-01T"

IsLocked

boolean

required

The customer's locked status for online shop sales channels.

Example:

false

IsCashRegisterBased

boolean

required

States if a customer is from a cash-register or point of sale and if their data should be synchronized with JTL-POS, for example.

Example:

false

Create Customer Delete Customer

⌘I

Overview

REST API

Authorizations

Headers

Path Parameters

Response