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 suppliers

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

Get a custom-sorted paginated list of suppliers matching the filter criteria.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-None-Match	string	ETag to return results only if changed.

Query Parameters

Name	Type	Description
filter	string	Filter conditions.
sort	string	Sort parameter.
page	integer	Page to start with.
limit	integer	Page size (100 records maximum)

Responses

200

Get supplier

GET https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Get a single supplier identified by its ID.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
entityId*	integer	ID of the supplier to get.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-None-Match	string	ETag to return results only if changed.

Responses

200

Create new suppliers

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

Create a list of new suppliers.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken

Responses

200

Replace or create suppliers

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

Replace a list of suppliers.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match	string	ETag to update only if not changed.

Responses

200

Replace or create supplier

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Replace a single supplier identified by its ID.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
entityId*	integer	ID of the supplier to replace.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match	string	ETag to update only if not changed.

Responses

200

Partial update of supplier

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Update a single supplier identified by its ID.

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
entityId*	integer	ID of the supplier to update.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match*	string	ETag to update only if not changed.

Responses

200

Delete supplier

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Delete a single supplier identified by its ID.

Path Parameters

Name	Type	Description
cloudId*	string	ID of the cloud.
entityId*	string	ID of the supplier to delete.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken
If-Match	string	ETag ignored (temporarily) when deleting an entity.

Responses

200404

Options suppliers

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

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken

Responses

200

Options supplier

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/suppliers/:entityId

Path Parameters

Name	Type	Description
cloudId*	integer	ID of the cloud.
entityId*	integer	ID of the supplier to get the options for.

Header Parameters

Name	Type	Description
Authorization*	string	Bearer accessToken

Responses

200