Customer

Customer schema

id long? Customer ID - cannot be null in PUT/PATCH methods ๐Ÿ“ถ EQUALS,ENUM

_cloudId integer Cloudโ€‹

_discountGroupId long? Discount group ๐Ÿ“ถ EQUALS,ENUM

_sellerId long? Seller ๐Ÿ“ถ 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

{
"_cloudId": <integer>,
"_discountGroupId": <integer>,
"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>,
"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
Get customers

https://api.dotykacka.cz/v2/clouds/:cloudId/customers
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
page
optional
integer
โ€‹
limit
optional
integer
โ€‹
filter
optional
string
โ€‹
sort
optional
string
โ€‹
Response
200: OK
Cake successfully retrieved.
โ€‹
400: Bad Request
โ€‹
404: Not Found
Could not find a cake matching this query.
โ€‹

get
Get customer

https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId
Request
Response
Request
Path Parameters
customerId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
โ€‹
400: Bad Request
โ€‹
404: Not Found
โ€‹

post
Create customers

https://api.dotykacka.cz/v2/clouds/:cloudId/customers
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of Customer object
Response
200: OK
โ€‹
400: Bad Request
โ€‹
// 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
Replace or create customers

https://api.dotykacka.cz/v2/clouds/:cloudId/customers
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of Customer object
Response
200: OK
โ€‹
400: Bad Request
โ€‹
// 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
Replace or create customer

https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId
Request
Response
Request
Path Parameters
customerId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Customer object
Response
200: OK
โ€‹
400: Bad Request
โ€‹
// 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
Partial update of Customer

https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId
Request
Response
Request
Path Parameters
customerId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
string
Object with some Customer properties
Response
200: OK
โ€‹
400: Bad Request
โ€‹
404: Not Found
โ€‹

delete
Delete customer

https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId
Request
Response
Request
Path Parameters
customerId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
If-Match
optional
string
ETag ignored (temporarily) when deleting an entity.
Authorization
required
string
Bearer accessToken
Query Parameters
anonymize
optional
boolean
Default false
Response
200: OK
โ€‹
404: Not Found
โ€‹

options
Options customers

https://api.dotykacka.cz/v2/clouds/:cloudId/customers
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
โ€‹

options
Options customer

https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId
Request
Response
Request
Path Parameters
customerId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
โ€‹