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": "Example City", "CountryIso": "DE", "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "State": "Example State", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "LanguageIso": "DE", "InternalCompanyId": 123, "Number": "C1005486", "OtherAddresses": { "OtherBillingAddresses": [ { "City": "Example City", "CountryIso": "DE", "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "State": "Example State", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ], "OtherShippingAddresses": [ { "City": "Example City", "CountryIso": "DE", "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "State": "Example State", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ], "OtherCustomerAddresses": [ { "City": "Example City", "CountryIso": "DE", "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "State": "Example State", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ] }, "PaymentSettings": { "PaymentMethodId": 123, "Discount": 5, "PaymentTarget": 3, "CreditLimit": 100, "StopPaymentRequest": false }, "CustomerSince": "2023-02-01T13:30:00.0000000+00:00", "LastChange": "2023-02-01T13:30:00.0000000+00:00", "CustomerCategoryId": 123, "TaxIdentificationNumber": "123/123/12345", "AccountsReceivableNumber": 10000, "CommercialRegisterNumber": "HRB 1234", "Website": "https://mywebsite.com", "InitialContact": "Amazon", "EbayUsername": "eBaybuyer123", "Birthday": "1985-01-01T", "IsLocked": false, "IsCashRegisterBased": false } '

{ "Id": 123, "Number": "C1005486", "CustomerGroupId": 123, "BillingAddress": { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "Shipmentaddress": { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "CustomAddress": { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" }, "OtherAddresses": { "OtherBillingAddresses": [ { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ], "OtherShippingAddresses": [ { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ], "OtherCustomerAddresses": [ { "Id": 123, "Company": "Sportbedarf Sommer", "Company2": "Innovation Division", "FormOfAddress": "Mr.", "Title": "Dr.", "FirstName": "John", "LastName": "Doe", "Street": "Main St. 123", "Address2": "Floor 5, Apt 302", "PostalCode": "12345", "City": "Example City", "State": "Example State", "CountryIso": "DE", "VatID": "DE123456789", "PhoneNumber": "+49 1234 445556661", "MobilePhoneNumber": "+49 160 123 4567", "EmailAddress": "example@email.com", "Fax": "+49 1234 4455566615" } ] }, "PaymentSettings": { "PaymentMethodId": 123, "Discount": 5, "PaymentTarget": 3, "CreditLimit": 100, "StopPaymentRequest": false }, "CustomerSince": "2023-02-01T13:30:00.0000000+00:00", "LastChange": "2023-02-01T13:30:00.0000000+00:00", "LanguageIso": "DE", "InternalCompanyId": 123, "CustomerCategoryId": 123, "TaxIdentificationNumber": "123/123/12345", "AccountsReceivableNumber": 10000, "CommercialRegisterNumber": "HRB 1234", "Website": "https://mywebsite.com", "InitialContact": "Amazon", "EbayUsername": "eBaybuyer123", "Birthday": "1985-01-01T", "IsLocked": false, "IsCashRegisterBased": false }

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

BillingAddress

object

required

Model Class: CreateAddress

Show child attributes

LanguageIso

string

required

The customer's language.

Example:

"DE"

InternalCompanyId

integer<int32>

required

Number

string

Example:

"C1005486"

Shipmentaddress

object

Model Class: CreateAddress

Show child attributes

CustomAddress

object

Model Class: CreateAddress

Show child attributes

OtherAddresses

object

Model Class: CreateOtherAddresses

Show child attributes

PaymentSettings

object

Model Class: CreatePaymentSettings

Show child attributes

CustomerSince

string<date-time>

Example:

"2023-02-01T13:30:00.0000000+00:00"

LastChange

string<date-time>

Example:

"2023-02-01T13:30:00.0000000+00:00"

CustomerCategoryId

integer<int32>

TaxIdentificationNumber

string

Example:

"123/123/12345"

AccountsReceivableNumber

integer<int32>

Example:

10000

CommercialRegisterNumber

string

Example:

"HRB 1234"

Website

string

Example:

"https://mywebsite.com"

InitialContact

string

Example:

"Amazon"

EbayUsername

string

Example:

"eBaybuyer123"

Birthday

string<date-time>

Example:

"1985-01-01T"

IsLocked

boolean

Example:

false

IsCashRegisterBased

boolean

Example:

false

Response

The created customer.

Model Class: Customer

integer<int32>

required

Number

string

required

The customer's number.

Example:

"C1005486"

CustomerGroupId

integer<int32>

required

BillingAddress

object

required

Model Class: Address

Show child attributes

Shipmentaddress

object

required

Model Class: Address

Show child attributes

CustomAddress

object

required

Model Class: Address

Show child attributes

OtherAddresses

object

required

Model Class: OtherAddresses

Show child attributes

PaymentSettings

object

required

Model Class: PaymentSettings

Show child attributes

CustomerSince

string<date-time>

required

Date since they have been a customer.

Example:

"2023-02-01T13:30:00.0000000+00:00"

LastChange

string<date-time>

required

Date of the last customer's data change.

Example:

"2023-02-01T13:30:00.0000000+00:00"

LanguageIso

string

required

The customer's language.

Example:

"DE"

InternalCompanyId

integer<int32>

required

CustomerCategoryId

integer<int32>

required

TaxIdentificationNumber

string

required

The customer's tax identification number.

Example:

"123/123/12345"

AccountsReceivableNumber

integer<int32>

required

The customer's accounts receivable number.

Example:

10000

CommercialRegisterNumber

string

required

The customer's commercial register number.

Example:

"HRB 1234"

Website

string

required

The customer's website.

Example:

"https://mywebsite.com"

InitialContact

string

required

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

Example:

"Amazon"

EbayUsername

string

required

The customer's eBay username.

Example:

"eBaybuyer123"

Birthday

string<date-time>

required

The customer's date of birth.

Example:

"1985-01-01T"

IsLocked

boolean

required

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

Example:

false

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.

Example:

false

REST API

Authorizations

Headers

Query Parameters

Body

Response