API
Search…
⌃K

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