API
Searchโ€ฆ
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). Validated by a regex. ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE
versionDate timestamp? Last modification date and time ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH
zip string(20) ZIP code ๐Ÿ“ถ EQUALS,ENUM ๐Ÿ”ฝ NONE
websiteUrl string? Website URL. Validated by a regex.

Supplier response

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
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers
Get suppliers
get
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers/:entityId
Get supplier
post
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers
Create new suppliers
put
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers
Replace or create suppliers
put
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers/:entityId
Replace or create supplier
patch
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers/:entityId
Partial update of supplier
delete
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers/:entityId
Delete supplier
options
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers
Options suppliers
options
https://api.dotykacka.cz/v2
/clouds/:cloudId/suppliers/:entityId
Options supplier