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
  • Stock packaging schema
  • Get stock packagings
  • Get stock packaging
  • Create stock packagings
  • Replace or create stock packagings
  • Replace or create stock packaging
  • Partial update of stock packaging
  • Delete stock packaging
  • Options stock packagings
  • Options stock packaging

Was this helpful?

Export as PDF
  1. Entity

Stock Packaging

Stock packaging schema

_cloudId integer Cloud ID

_productId long Product ID - stock item product 📶 EQUALS,ENUM

deleted boolean Stock packaging deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH

ean string[]? EAN codes 📶 EQUALS, ENUM

id long? Stock packaging ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

name string(400) Product name 📶 STRING🔽 BOTH

plu string[]? PLU codes 📶 EQUALS, ENUM

quantity double Quantity of stock packaging

unit enum Unit of stock packaging must be in the same group as the stock item product with _productId

versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

Stock packaging response

{
    "_cloudId": <integer>,
    "_productId": <long>,
    "deleted": <boolean>
    "ean": <string[]>,
    "id": <long>,
    "name": <string>,
    "plu": <string[]>,
    "quantity": <double>,
    "unit": <enum>,
    "versionDate": <timestamp>
}

Get stock packagings

GET https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

sort

string

filter

string

page

integer

limit

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Get stock packaging

GET https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name
Type
Description

cloudId*

integer

stockPackagingId*

long

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Create stock packagings

POST https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Auhtorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

array

Array of StockPackaging of max size 100.

Replace or create stock packagings

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

If-Match*

string

Etag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

array

Array of StockPackaging of maxim size 100

Replace or create stock packaging

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name
Type
Description

cloudId*

integer

stockPackagingId*

long

Headers

Name
Type
Description

If-Match*

string

Etag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

Name
Type
Description

*

object

StockPackaging

Partial update of stock packaging

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name
Type
Description

cloudId*

integer

stockPackagingId*

long

Headers

Name
Type
Description

If-Match*

string

Etag to update only if not changed.

Authorization*

string

Bearer accessToken

Delete stock packaging

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name
Type
Description

cloudId*

integer

stockPackagingId*

long

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options stock packagings

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings

Path Parameters

Name
Type
Description

cloudId*

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

Options stock packaging

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/stock-packagings/:stockPackagingId

Path Parameters

Name
Type
Description

cloudId*

integer

stockPackagingId*

long

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

PreviousReservationNextSupplier

Last updated 9 months ago

Was this helpful?