Skip to main content
GET
/
customers
/
{customerId}
Get Customer
curl --request GET \
  --url https://api.jtl-cloud.com/erp/customers/{customerId} \
  --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>'
{
  "Id": 123,
  "Number": "<string>",
  "CustomerGroupId": 123,
  "BillingAddress": {
    "Id": 123,
    "Company": "<string>",
    "Company2": "<string>",
    "FormOfAddress": "<string>",
    "Title": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "Street": "<string>",
    "Address2": "<string>",
    "PostalCode": "<string>",
    "City": "<string>",
    "State": "<string>",
    "CountryIso": "<string>",
    "VatID": "<string>",
    "PhoneNumber": "<string>",
    "MobilePhoneNumber": "<string>",
    "EmailAddress": "<string>",
    "Fax": "<string>"
  },
  "Shipmentaddress": {
    "Id": 123,
    "Company": "<string>",
    "Company2": "<string>",
    "FormOfAddress": "<string>",
    "Title": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "Street": "<string>",
    "Address2": "<string>",
    "PostalCode": "<string>",
    "City": "<string>",
    "State": "<string>",
    "CountryIso": "<string>",
    "VatID": "<string>",
    "PhoneNumber": "<string>",
    "MobilePhoneNumber": "<string>",
    "EmailAddress": "<string>",
    "Fax": "<string>"
  },
  "CustomAddress": {
    "Id": 123,
    "Company": "<string>",
    "Company2": "<string>",
    "FormOfAddress": "<string>",
    "Title": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "Street": "<string>",
    "Address2": "<string>",
    "PostalCode": "<string>",
    "City": "<string>",
    "State": "<string>",
    "CountryIso": "<string>",
    "VatID": "<string>",
    "PhoneNumber": "<string>",
    "MobilePhoneNumber": "<string>",
    "EmailAddress": "<string>",
    "Fax": "<string>"
  },
  "OtherAddresses": {
    "OtherBillingAddresses": [
      {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      }
    ],
    "OtherShippingAddresses": [
      {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      }
    ],
    "OtherCustomerAddresses": [
      {
        "Id": 123,
        "Company": "<string>",
        "Company2": "<string>",
        "FormOfAddress": "<string>",
        "Title": "<string>",
        "FirstName": "<string>",
        "LastName": "<string>",
        "Street": "<string>",
        "Address2": "<string>",
        "PostalCode": "<string>",
        "City": "<string>",
        "State": "<string>",
        "CountryIso": "<string>",
        "VatID": "<string>",
        "PhoneNumber": "<string>",
        "MobilePhoneNumber": "<string>",
        "EmailAddress": "<string>",
        "Fax": "<string>"
      }
    ]
  },
  "PaymentSettings": {
    "PaymentMethodId": 123,
    "Discount": 123,
    "PaymentTarget": 123,
    "CreditLimit": 123,
    "StopPaymentRequest": true
  },
  "CustomerSince": "2023-11-07T05:31:56Z",
  "LastChange": "2023-11-07T05:31:56Z",
  "LanguageIso": "<string>",
  "InternalCompanyId": 123,
  "CustomerCategoryId": 123,
  "TaxIdentificationNumber": "<string>",
  "AccountsReceivableNumber": 123,
  "CommercialRegisterNumber": "<string>",
  "Website": "<string>",
  "InitialContact": "<string>",
  "EbayUsername": "<string>",
  "Birthday": "2023-11-07T05:31:56Z",
  "IsLocked": true,
  "IsCashRegisterBased": true
}

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.

Path Parameters

​
customerId
integer<int32>
required

The id of the Customer to return. Represents a unique key for identifying a customer in the JTL system.

Response

Returns the customer for the given id.

Model Class: Customer

​
Id
integer<int32>
required

Unique ID to identify a customer.

​
Number
string
required

The customer's number.

​
CustomerGroupId
integer<int32>
required

The customer group ID.

​
BillingAddress
object
required

The customer's default billing address.

​
Shipmentaddress
object
required

The customer's default shipping address.

​
CustomAddress
object
required

The customer's default non-billing and non-shipping address.

​
OtherAddresses
object
required

All other non-default addresses of the customer.

​
PaymentSettings
object
required

The payment settings for the customer.

​
CustomerSince
string<date-time>
required

Date since they have been a customer.

​
LastChange
string<date-time>
required

Date of the last customer's data change.

​
LanguageIso
string
required

The customer's language.

​
InternalCompanyId
integer<int32>
required

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

​
CustomerCategoryId
integer<int32>
required

The customer category ID.

​
TaxIdentificationNumber
string
required

The customer's tax identification number.

​
AccountsReceivableNumber
integer<int32>
required

The customer's accounts receivable number.

​
CommercialRegisterNumber
string
required

The customer's commercial register number.

​
Website
string
required

The customer's website.

​
InitialContact
string
required

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

​
EbayUsername
string
required

The customer's eBay username.

​
Birthday
string<date-time>
required

The customer's date of birth.

​
IsLocked
boolean
required

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

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