API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Supplier schema
  • Get suppliers
  • Get supplier
  • Create new suppliers
  • Replace or create suppliers
  • Replace or create supplier
  • Partial update of supplier
  • Delete supplier
  • Options suppliers
  • Options supplier

Was this helpful?

Export as PDF
  1. Entity

Supplier

PreviousStock PackagingNextTable

Last updated 3 years ago

Was this helpful?

Supplier schema

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

Supplier response

{
    "_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.

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)

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-None-Match

string

ETag to return results only if changed.

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag to update only if not changed.

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match*

string

ETag to update only if not changed.

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Options suppliers

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

Path Parameters

Name
Type
Description

cloudId*

integer

ID of the cloud.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

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.

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

websiteUrl string? Website URL. Validated by a .

Cloud ID
regex
regex