Skip to main content
POST
Create Customer

Authorizations

Authorization
string
header
required

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

Headers

x-runas
string

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

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

LanguageIso
string
required

The customer's language.

Example:

"DE"

InternalCompanyId
integer<int32>
required
Number
string
Example:

"C1005486"

Shipmentaddress
object

Model Class: CreateAddress

CustomAddress
object

Model Class: CreateAddress

OtherAddresses
object

Model Class: CreateOtherAddresses

PaymentSettings
object

Model Class: CreatePaymentSettings

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

Id
integer<int32>
required
Number
string
required

The customer's number.

Example:

"C1005486"

CustomerGroupId
integer<int32>
required
BillingAddress
object
required

Model Class: Address

Shipmentaddress
object
required

Model Class: Address

CustomAddress
object
required

Model Class: Address

OtherAddresses
object
required

Model Class: OtherAddresses

PaymentSettings
object
required

Model Class: PaymentSettings

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