API
Search…
⌃K

Customer

Customer schema

id long? Customer ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM
_cloudId integer Cloud ID
_discountGroupId long? Discount group ID 📶 EQUALS,ENUM
_sellerId long? Seller ID 📶 EQUALS,ENUM
addressLine1 string(180) Address line 1 📶 STRING
addressLine2 string?(180) Address line 2 📶 STRING
barcode string(50) Bar code 📶 EQUALS,ENUM
city string?(255) City 📶 EQUALS,STRING
companyId string(255) Customer company ID (CZ: IČO, PL: REGON) 📶 ENUM
companyName string(180) [1] Customer company name 📶 STRING 🔽 BOTH
country string?(10) Country code 📶 STRING
created timestamp? Customer created date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH
deleted boolean Customer deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH
display boolean Customer displayed 📶 EQUALS, ENUM 🔽 BOTH
email string(100) E-mail address 📶 STRING
expireDate timestamp? Customer expire date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH
externalId string?(256) External ID 📶 EQUALS,ENUM
firstName string(180) [1] First name 📶 STRING 🔽 BOTH
flags long Customer flags 📶 BITS
headerPrint string(256) Header for printing
hexColor string(7) Product color
internalNote string(1000) Internal note
lastName string(180) [1] Last name 📶 STRING 🔽 BOTH
modifiedBy string?(32) Customer modified by
note string?(500) Customer note
phone string(20) Phone 📶 STRING
points double Customer points - must be greater than or equal to 0 📶 NUMBER
tags string[](255) Tags for a customer 📶 EQUALS, ENUM
vatId string(255) Customer VAT ID (CZ: DIČ, PL: NIP). Validation regex.
versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH
zip string(20) ZIP code 📶 STRING
[1] Properties firstName, lastName and companyName must not be blank. At least one of these properties must contain a non-blank value.

JSON response

{
"_cloudId": <integer>,
"_discountGroupId": <integer>,
"_sellerId": <long>,
"addressLine1": <string>,
"addressLine2": <string>,
"barcode": <string>,
"city": <string>,
"companyId": <string>,
"companyName": <string>,
"country": <string>,
"created": <timestamp>,
"deleted": <boolean>,
"display": <boolean>,
"email": <string>,
"expireDate": <timestamp>,
"externalId": <string>,
"firstName": <string>,
"flags": <long>,
"headerPrint": <string>,
"hexColor": <string>,
"id": <long>,
"internalNote": <string>,
"lastName": <string>,
"modifiedBy": <string>,
"note": <string>,
"phone":<string>,
"points": <double>,
"tags": <string[]>,
"vatId": <string>,
"versionDate": <timestamp>,
"zip": <string>
}
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers
Get customers
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Get customer
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers
Create customers
// Body request minimmum
[
{
"_cloudId": <integer>,
"addressLine1": <string>,
"barcode": <string>,
"companyId": <string>,
"companyName": <string>,
"deleted": <boolean>,
"display": <boolean>,
"email": <string>,
"firstName": <string>,
"headerPrint": <string>,
"hexColor": <string>,
"internalNote": <string>,
"lastName": <string>,
"phone":<string>,
"points": <double>,
"tags": <string[]>,
"vatId": <string>,
"zip": <string>,
}
]
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers
Replace or create customers
// Body request minimmum
[
{
"_cloudId": <integer>,
"addressLine1": <string>,
"barcode": <string>,
"companyId": <string>,
"companyName": <string>,
"deleted": <boolean>,
"display": <boolean>,
"email": <string>,
"firstName": <string>,
"headerPrint": <string>,
"hexColor": <string>,
"id": <long>,
"internalNote": <string>,
"lastName": <string>,
"phone":<string>,
"points": <double>,
"tags": <string[]>,
"vatId": <string>,
"zip": <string>,
}
]
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Replace or create customer
// Body request minimmum
{
"_cloudId": <integer>,
"addressLine1": <string>,
"barcode": <string>,
"companyId": <string>,
"companyName": <string>,
"deleted": <boolean>,
"display": <boolean>,
"email": <string>,
"firstName": <string>,
"headerPrint": <string>,
"hexColor": <string>,
"id": <long>,
"internalNote": <string>,
"lastName": <string>,
"phone":<string>,
"points": <double>,
"tags": <string[]>,
"vatId": <string>,
"zip": <string>,
}
patch
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Partial update of Customer
delete
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Delete customer
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers
Options customers
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Options customer