Supplier
Last updated
Was this helpful?
Last updated
Was this helpful?
id
long?
Supplier ID - cannot be null in PUT/PATCH methods
📶 EQUALS
,ENUM
🔽 NONE
_cloudId
integer
🔽 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 .
📶 EQUALS
,ENUM
🔽 NONE
versionDate
timestamp?
Last modification date and time
📶 EQUALS
, ENUM
, NUMBER
🔽 BOTH
zip
string(20)
ZIP code
📶 EQUALS
,ENUM
🔽 NONE
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Get a custom-sorted paginated list of suppliers matching the filter criteria.
cloudId*
integer
ID of the cloud.
filter
string
Filter conditions.
sort
string
Sort parameter.
page
integer
Page to start with.
limit
integer
Page size (100 records maximum)
Authorization*
string
Bearer accessToken
If-None-Match
string
ETag to return results only if changed.
GET
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Get a single supplier identified by its ID.
cloudId*
integer
ID of the cloud.
entityId*
integer
ID of the supplier to get.
Authorization*
string
Bearer accessToken
If-None-Match
string
ETag to return results only if changed.
POST
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Create a list of new suppliers.
cloudId*
integer
ID of the cloud.
Authorization*
string
Bearer accessToken
PUT
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
Replace a list of suppliers.
cloudId*
integer
ID of the cloud.
Authorization*
string
Bearer accessToken
If-Match
string
ETag to update only if not changed.
PUT
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Replace a single supplier identified by its ID.
cloudId*
integer
ID of the cloud.
entityId*
integer
ID of the supplier to replace.
Authorization*
string
Bearer accessToken
If-Match
string
ETag to update only if not changed.
PATCH
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Update a single supplier identified by its ID.
cloudId*
integer
ID of the cloud.
entityId*
integer
ID of the supplier to update.
Authorization*
string
Bearer accessToken
If-Match*
string
ETag to update only if not changed.
DELETE
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
Delete a single supplier identified by its ID.
cloudId*
string
ID of the cloud.
entityId*
string
ID of the supplier to delete.
Authorization*
string
Bearer accessToken
If-Match
string
ETag ignored (temporarily) when deleting an entity.
OPTIONS
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers
cloudId*
integer
ID of the cloud.
Authorization*
string
Bearer accessToken
OPTIONS
https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId
cloudId*
integer
ID of the cloud.
entityId*
integer
ID of the supplier to get the options for.
Authorization*
string
Bearer accessToken
websiteUrl
string?
Website URL. Validated by a .