Create Customer - JTL Developer Documentation

curl --request POST \ --url https://api.jtl-cloud.com/erp/customers \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --header 'x-appid: <x-appid>' \ --header 'x-appversion: <x-appversion>' \ --header 'x-tenant-id: <x-tenant-id>' \ --data ' { "CustomerGroupId": 123, "BillingAddress": { "City": "<string>", "CountryIso": "<string>", "Company": "<string>", "Company2": "<string>", "FormOfAddress": "<string>", "Title": "<string>", "FirstName": "<string>", "LastName": "<string>", "Street": "<string>", "Address2": "<string>", "PostalCode": "<string>", "State": "<string>", "VatID": "<string>", "PhoneNumber": "<string>", "MobilePhoneNumber": "<string>", "EmailAddress": "<string>", "Fax": "<string>" }, "LanguageIso": "<string>", "InternalCompanyId": 123, "Number": "<string>", "OtherAddresses": { "OtherBillingAddresses": [ { "City": "<string>", "CountryIso": "<string>", "Company": "<string>", "Company2": "<string>", "FormOfAddress": "<string>", "Title": "<string>", "FirstName": "<string>", "LastName": "<string>", "Street": "<string>", "Address2": "<string>", "PostalCode": "<string>", "State": "<string>", "VatID": "<string>", "PhoneNumber": "<string>", "MobilePhoneNumber": "<string>", "EmailAddress": "<string>", "Fax": "<string>" } ], "OtherShippingAddresses": [ { "City": "<string>", "CountryIso": "<string>", "Company": "<string>", "Company2": "<string>", "FormOfAddress": "<string>", "Title": "<string>", "FirstName": "<string>", "LastName": "<string>", "Street": "<string>", "Address2": "<string>", "PostalCode": "<string>", "State": "<string>", "VatID": "<string>", "PhoneNumber": "<string>", "MobilePhoneNumber": "<string>", "EmailAddress": "<string>", "Fax": "<string>" } ], "OtherCustomerAddresses": [ { "City": "<string>", "CountryIso": "<string>", "Company": "<string>", "Company2": "<string>", "FormOfAddress": "<string>", "Title": "<string>", "FirstName": "<string>", "LastName": "<string>", "Street": "<string>", "Address2": "<string>", "PostalCode": "<string>", "State": "<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", "CustomerCategoryId": 123, "TaxIdentificationNumber": "<string>", "AccountsReceivableNumber": 123, "CommercialRegisterNumber": "<string>", "Website": "<string>", "InitialContact": "<string>", "EbayUsername": "<string>", "Birthday": "2023-11-07T05:31:56Z", "IsLocked": true, "IsCashRegisterBased": true } '

{ "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.

Query Parameters

disableAutomaticWorkflows

boolean

If true, the workflows do not trigger automatic.

Body

application/json

The customer to create.

Model Class: CreateCustomer

CustomerGroupId

integer<int32>

required

The customer group ID.

BillingAddress

object

required

The customer's default billing address.

Show child attributes

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

Number

string

The customer's number.

Shipmentaddress

object

The customer's default shipping address.

Show child attributes

CustomAddress

object

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

Show child attributes

OtherAddresses

object

All other non-default addresses of the customer.

Show child attributes

PaymentSettings

object

The payment settings for the customer.

Show child attributes

CustomerSince

string<date-time>

Date since they have been a customer.

LastChange

string<date-time>

Date of the last customer's data change.

CustomerCategoryId

integer<int32>

The customer category ID.

TaxIdentificationNumber

string

The customer's tax identification number.

AccountsReceivableNumber

integer<int32>

The customer's accounts receivable number.

CommercialRegisterNumber

string

The customer's commercial register number.

Website

string

The customer's website.

InitialContact

string

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

EbayUsername

string

The customer's eBay username.

Birthday

string<date-time>

The customer's date of birth.

IsLocked

boolean

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

IsCashRegisterBased

boolean

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.

Response

The created customer.

Model Class: Customer

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.

Show child attributes

Shipmentaddress

object

required

The customer's default shipping address.

Show child attributes

CustomAddress

object

required

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

Show child attributes

OtherAddresses

object

required

All other non-default addresses of the customer.

Show child attributes

PaymentSettings

object

required

The payment settings for the customer.

Show child attributes

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.

REST API

Authorizations

Headers

Query Parameters

Body

Response