API
Searchโ€ฆ
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
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

1
{
2
"_cloudId": <integer>,
3
"_discountGroupId": <integer>,
4
"_sellerId": <long>,
5
"addressLine1": <string>,
6
"addressLine2": <string>,
7
"barcode": <string>,
8
"city": <string>,
9
"companyId": <string>,
10
"companyName": <string>,
11
"country": <string>,
12
"created": <timestamp>,
13
"deleted": <boolean>,
14
"display": <boolean>,
15
"email": <string>,
16
"expireDate": <timestamp>,
17
"externalId": <string>,
18
"firstName": <string>,
19
"headerPrint": <string>,
20
"hexColor": <string>,
21
"id": <long>,
22
"internalNote": <string>,
23
"lastName": <string>,
24
"modifiedBy": <string>,
25
"note": <string>,
26
"phone":<string>,
27
"points": <double>,
28
"tags": <string[]>,
29
"vatId": <string>,
30
"versionDate": <timestamp>,
31
"zip": <string>
32
}
Copied!
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
1
// Body request minimmum
2
[
3
{
4
"_cloudId": <integer>,
5
"addressLine1": <string>,
6
"barcode": <string>,
7
"companyId": <string>,
8
"companyName": <string>,
9
"deleted": <boolean>,
10
"display": <boolean>,
11
"email": <string>,
12
"firstName": <string>,
13
"headerPrint": <string>,
14
"hexColor": <string>,
15
"internalNote": <string>,
16
"lastName": <string>,
17
"phone":<string>,
18
"points": <double>,
19
"tags": <string[]>,
20
"vatId": <string>,
21
"zip": <string>,
22
}
23
]
Copied!
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers
Replace or create customers
1
// Body request minimmum
2
[
3
{
4
"_cloudId": <integer>,
5
"addressLine1": <string>,
6
"barcode": <string>,
7
"companyId": <string>,
8
"companyName": <string>,
9
"deleted": <boolean>,
10
"display": <boolean>,
11
"email": <string>,
12
"firstName": <string>,
13
"headerPrint": <string>,
14
"hexColor": <string>,
15
"id": <long>,
16
"internalNote": <string>,
17
"lastName": <string>,
18
"phone":<string>,
19
"points": <double>,
20
"tags": <string[]>,
21
"vatId": <string>,
22
"zip": <string>,
23
}
24
]
Copied!
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/customers/:customerId
Replace or create customer
1
// Body request minimmum
2
{
3
"_cloudId": <integer>,
4
"addressLine1": <string>,
5
"barcode": <string>,
6
"companyId": <string>,
7
"companyName": <string>,
8
"deleted": <boolean>,
9
"display": <boolean>,
10
"email": <string>,
11
"firstName": <string>,
12
"headerPrint": <string>,
13
"hexColor": <string>,
14
"id": <long>,
15
"internalNote": <string>,
16
"lastName": <string>,
17
"phone":<string>,
18
"points": <double>,
19
"tags": <string[]>,
20
"vatId": <string>,
21
"zip": <string>,
22
}
Copied!
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
Last modified 12h ago