User Manual

Customer

Please see the Breaking changes page for more info on the planned changes in validation.

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

birthday timestamp? The date of birth

city string?(255) City 📶 EQUALS,STRING

companyId string(255) Customer company ID (CZ: IČO, PL: REGON) 📶 STRING

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, must not contain any of these characters: ,^?*()[]$ 📶 EQUALS, ENUM

vatId string(255) Customer VAT ID (CZ: DIČ, PL: NIP). Validation regex. 📶 STRING

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>,
    "birthday": <timestamp>,
    "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 customers

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

page

integer

limit

integer

filter

string

sort

string

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

Get customer

GET https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name
Type
Description

customerId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

Create customers

POST https://api.dotykacka.cz/v2/clouds/:cloudId/customers

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

array

Array of Customer object

// 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>,
    }
]

Replace or create customers

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/customers

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

array

Array of Customer object

// 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>,
    }
]

Replace or create customer

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name
Type
Description

customerId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

object

Customer object

// 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>,
}

Partial update of Customer

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name
Type
Description

customerId*

integer

cloudId*

integer

Headers

Name
Type
Description

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

string

Object with some Customer properties

Delete customer

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name
Type
Description

customerId*

integer

cloudId*

integer

Query Parameters

Name
Type
Description

anonymize

boolean

Default false

Headers

Name
Type
Description

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options customers

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/customers

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options customer

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/customers/:customerId

Path Parameters

Name
Type
Description

customerId*

integer

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

PreviousCourseNextCustomer Account

Last updated