JTjtl-software
CustomerDomainCommand

Creates a customer

post/v2/customer/create

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
      Scopescustomers.write
    • or OAuth 2
      Client credentials
      Token URLhttps://auth.jtl-cloud.com/oauth2/token
      Scopescustomers.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

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.

Request body

companyIdstring uuid

Represents a key for identifying a firm within the application.

customerGroupIdstring uuid
customerCategoryIdstring uuid
paymentMethodIdstring uuid
accountsReceivableNumberinteger

The accounts receivable number of the customer.

birthdaystring date-time

The customer's date of birth.

commercialRegisterNumberstring

The customer's commercial register number.

customerNumberstring

Number of the customer. If no number is given when posting a customer, the number will be generated automatically.

ebayNamestring

The customers ebay name.

homepagestring

The customers homepage URL.

initialContactstring

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

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.

isLockedboolean

The customer's locked status.

languageIsostring

The customer's preferred language in ISO format (e.g. "de", "en").

taxIdentificationNumberstring

The customer's tax identification number.

Example request

{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerCategoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Response

Customer created successfully

Changes

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