Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
customer

Get Customer

Get a specific customer

get/v2/customers/{customerId}

Path parameters

customerIdstring uuid required

Represents a unique key for identifying a customer in the JTL system.

Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the Customer to return.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Response

Returns the customer for the given id.

idstring uuid

Represents a unique key for identifying a customer in the JTL system.

numberstring

The customer's number.

customerGroupIdstring uuid
customerSincestring date-time

Date since they have been a customer.

lastChangestring date-time

Date of the last customer's data change.

languageIsostring

The customer's language.

internalCompanyIdstring uuid

Represents a key for identifying a firm within the application.

customerCategoryIdstring uuid
taxIdentificationNumberstring

The customer's tax identification number.

accountsReceivableNumberinteger

The customer's accounts receivable number.

commercialRegisterNumberstring

The customer's commercial register number.

websitestring

The customer's website.

initialContactstring

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

ebayUsernamestring

The customer's eBay username.

birthdaystring date-time

The customer's date of birth.

isLockedboolean

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

isCashRegisterBasedboolean

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 response

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "billingAddress": {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "shipmentaddress": {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "customAddress": {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "otherAddresses": {
    "otherBillingAddresses": [
      {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      }
    ],
    "otherShippingAddresses": [
      {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      }
    ],
    "otherCustomerAddresses": [
      {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      }
    ]
  },
  "paymentSettings": {
    "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  },
  "internalCompanyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerCategoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}