JTjtl-software
customer

Query Customers

Query all customers

get/v2/customers

Request

  • Base URL
    https://scx-sbx.api.jtl-software.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesall.read, cusomters.read, customers.read
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopesall.read, cusomters.read, customers.read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

searchKeyWordstring

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

numberstring

Search for a specific customer number.

groupIdstring uuid
Example:b45f6432-2462-4c6f-b00f-1d9d01000000
categoryIdstring uuid
Example:b45f6432-2462-4c6f-b00f-1d9d01000000
lastChangeFromstring date-time

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

lastChangeTostring date-time

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

pageNumberinteger

Number of the page of items to fetch.

pageSizeinteger

Size of the page that is specified by pageNumber.

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 all customer, can be filtered by searchKeyWord or categoryId.

totalItemsinteger

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

pageNumberinteger

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

pageSizeinteger

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

totalPagesinteger

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

hasPreviousPageboolean

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

hasNextPageboolean

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

nextPageNumberinteger

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

previousPageNumberinteger

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

Example response

{
  "items": [
    {
      "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.