Skip to main content
GET
/
v2
/
customers
Query Customers
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "totalItems": 123,
  "pageNumber": 123,
  "pageSize": 123,
  "items": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "number": "<string>",
      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "billingAddress": {
        "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "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": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "discount": 123,
        "paymentTarget": 123,
        "creditLimit": 123,
        "stopPaymentRequest": true
      },
      "customerSince": "2023-11-07T05:31:56Z",
      "lastChange": "2023-11-07T05:31:56Z",
      "languageIso": "<string>",
      "internalCompanyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "customerCategoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxIdentificationNumber": "<string>",
      "accountsReceivableNumber": 123,
      "commercialRegisterNumber": "<string>",
      "website": "<string>",
      "initialContact": "<string>",
      "ebayUsername": "<string>",
      "birthday": "2023-11-07T05:31:56Z",
      "isLocked": true,
      "isCashRegisterBased": true
    }
  ],
  "totalPages": 123,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 123,
  "previousPageNumber": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

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

Query Parameters

​
searchKeyWord
string

All Search Keywords for the customer, like the number and the most important fields from the billing address.

​
number
string

Search for a specific customer number.

​
groupId
string<uuid>
Example:

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

​
categoryId
string<uuid>
Example:

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

​
lastChangeFrom
string<date-time>

All customers where the last change happened after or equal the given time

​
lastChangeTo
string<date-time>

All customers where the last change happened before or equal the given time

​
pageNumber
integer<int32>

Number of the page of items to fetch.

​
pageSize
integer<int32>

Size of the page that is specified by pageNumber.

Response

Returns all customer, can be filtered by searchKeyWord or categoryId.

Represents a paginated list of items

​
totalItems
integer<int32>

Gets or sets the total number of items available in the data source.

​
pageNumber
integer<int32>

Gets or sets the current page number in the paginated list.

​
pageSize
integer<int32>

Gets or sets the number of items per page in the paginated list.

​
items
object[]

Gets or sets the collection of items contained in the paged list.

​
totalPages
integer<int32>

Gets the total number of pages based on the total number of items and the page size.

​
hasPreviousPage
boolean

Gets a value indicating whether there is a previous page available in the paginated list.

​
hasNextPage
boolean

Gets a value indicating whether there is a next page available.

​
nextPageNumber
integer<int32>

Gets the number of the next page if there is one; otherwise, returns the total number of pages.

​
previousPageNumber
integer<int32>

Gets the number of the previous page. If there is no previous page, it returns 1.