Supplier

Supplier schema
id long?
Supplier ID - cannot be null in PUT/PATCH methods
📶 EQUALS,ENUM 🔽 NONE
_cloudId integer
Cloud ID
🔽 NONE
addressLine1 string(180)
Address line 1
📶 EQUALS,STRING 🔽 NONE
addressLine2 string?(180)
Address line 2
📶 EQUALS,STRING 🔽 NONE
city string(100)
City
📶 EQUALS,STRING 🔽 NONE
companyId string(255)
Supplier company ID (CZ: IČO, PL: REGON)
📶 EQUALS,ENUM 🔽 NONE
country string?(10)
Country code
📶 EQUALS,ENUM 🔽 NONE
deleted boolean
Supplier deleted - cannot be true in POST/PUT/PATCH methods
📶 EQUALS, ENUM 🔽 BOTH
deliveryNoteIds string?()
Delivery note IDs
🔽 NONE
display boolean
Supplier displayed
📶 EQUALS, ENUM 🔽 BOTH
email string(100)
E-mail address
🔽 NONE
externalId string?(256)
External ID
📶 EQUALS,ENUM 🔽 NONE
name string(180)
Supplier name
📶 EQUALS,STRING 🔽 BOTH
phone string(20)
Phone number
🔽 NONE
vatId string(255)
Supplier VAT ID (CZ: DIČ, PL: NIP). Validation regex.
📶 EQUALS,ENUM 🔽 NONE
versionDate timestamp?
Last modification date and time
📶 EQUALS, ENUM, NUMBER 🔽 BOTH
zip string(20)
ZIP code
📶 EQUALS,ENUM 🔽 NONE
Supplier response
JSON
JSON
{
    "_cloudId": <integer>,
    "addressLine1": <string>,
    "addressLine2": <string>,
    "city": <string>,
    "companyId": <string>,
    "country": <string>,
    "deleted": <boolean>,
    "deliveryNoteIds": <string>,
    "display": <boolean>,
    "email": <string>,
    "externalId": null,
    "id": <long>,
    "name": <string>,
    "phone": <string>,
    "vatId": <string>,
    "versionDate": <timestamp>,
    "zip": <string>
}
get
Get suppliers
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Get a custom-sorted paginated list of suppliers matching the filter criteria.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Query Parameters
filter
optional
string
Filter conditions.
sort
optional
string
Sort parameter.
page
optional
integer
Page to start with.
limit
optional
integer
Page size (100 records maximum)
Response
200: OK
​
get
Get supplier
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Get a single supplier identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the supplier to get.
Headers
Authorization
required
string
Bearer accessToken
If-None-Match
optional
string
ETag to return results only if changed.
Response
200: OK
​
post
Create new suppliers
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Create a list of new suppliers.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​
put
Replace or create suppliers
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Replace a list of suppliers.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​
put
Replace or create supplier
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Replace a single supplier identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the supplier to replace.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​
patch
Partial update of supplier
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Update a single supplier identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the supplier to update.
Headers
Authorization
required
string
Bearer accessToken
If-Match
required
string
ETag to update only if not changed.
Response
200: OK
​
delete
Delete supplier
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Delete a single supplier identified by its ID.
Request
Response
Request
Path Parameters
cloudId
required
string
ID of the cloud.
entityId
required
string
ID of the supplier to delete.
Headers
Authorization
required
string
Bearer accessToken
If-Match
optional
string
ETag ignored (temporarily) when deleting an entity.
Response
200: OK
Cake successfully retrieved.
​
404: Not Found
Could not find a cake matching this query.
​
options
Options suppliers
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​
options
Options supplier
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Request
Response
Request
Path Parameters
cloudId
required
integer
ID of the cloud.
entityId
required
integer
ID of the supplier to get the options for.
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​