Order item

Order item schema

_branchId integer Branch ๐Ÿ“ถ EQUALS,ENUM

_categoryId long Category ๐Ÿ“ถ EQUALS,ENUM

_cloudId integer Cloud ๐Ÿ“ถ EQUALS,ENUM

_courseId long? Course ๐Ÿ“ถ EQUALS,ENUM

_customerId long? Customer ๐Ÿ“ถ EQUALS,ENUM

_eetSubjectId long? EET Subject ๐Ÿ“ถ EQUALS,ENUM

_employeeId long Employee ๐Ÿ“ถ EQUALS,ENUM

_orderId long Order ๐Ÿ“ถ EQUALS,ENUM

_productId long Product ๐Ÿ“ถ EQUALS,ENUM

_relatedOrderItemId long? Order item ๐Ÿ“ถ EQUALS,ENUM

_sellerId long? Seller ๐Ÿ“ถ EQUALS,ENUM

alternativeName string? Product alternative name

billedUnitPriceWithVat double Unit price with vat after discount

billedUnitPriceWithoutVat double Unit price without vat after discount

canceledDate timestamp? Date of item canceled ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

completed timestamp? Date of item (Order) completed ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

created timestamp Date of item created (added to Order) ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

currency string(3) Currency code

discountPercent double Discount percent

discountPermitted boolean Enabled discount ๐Ÿ“ถ EQUALS, ENUM

ean string[] EAN for item (from product) ๐Ÿ“ถ EQUALS, ENUM

flags integer Special settings for Order item in binary form. ๐Ÿ“ถ BITS

id long Primary ID for Order item

name string Name of item / product. ๐Ÿ“ถ STRING ๐Ÿ”ฝ BOTH

note string Note for item

onSale boolean Is item on sale ๐Ÿ“ถ EQUALS, ENUM

packaging double Packaging value for item / product

parked boolean Is item parked ๐Ÿ“ถ EQUALS, ENUM

points double Points value for Order item

quantity double Quantity of item / product

stockDeduct boolean ๐Ÿ“ถ EQUALS, ENUM

subtitle string

tags string[] Tags for item ๐Ÿ“ถ EQUALS, ENUM

totalPriceWithVat double Total is with quantity

totalPriceWithoutVat double Total is with quantity

unit enum Item / Product unitโ€‹

unitPriceWithVat double Unit price with vat before discount

unitPriceWithoutVat double Unit price without vat before discount

unitPurchasePrice double Value of purchase price per unit

updated timestamp Date updated ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

vat double Vat rate

versionDate timestamp Last modification date and time ๐Ÿ“ถ EQUALS, ENUM, NUMBER ๐Ÿ”ฝ BOTH

JSON response

{
"_branchId": <integer>,
"_categoryId": <long>,
"_cloudId": <integer>,
"_courseId": <long>,
"_customerId": <long>,
"_eetSubjectId": <long>,
"_employeeId": <long>,
"_orderId": <long>,
"_productId": <long>,
"_relatedOrderItemId": <long>,
"_sellerId": <long>,
"alternativeName": <string>,
"billedUnitPriceWithVat": <double>,
"billedUnitPriceWithoutVat": <double>,
"canceledDate": <timestamp>,
"completed": <timestamp>,
"created": <timestamp>,
"currency": <string>,
"discountPercent": <double>,
"discountPermitted": <boolean>,
"ean": <string[]>,
"flags": <integer>,
"id": <long>,
"name": <string>,
"note": <string>,
"onSale": <boolean>,
"packaging": <double>,
"parked": <boolean>,
"points": <double>,
"quantity": <double>,
"stockDeduct": <boolean>,
"subtitle": <string>,
"tags": <string[]>,
"totalPriceWithVat": <double>,
"totalPriceWithoutVat": <double>,
"unit": <enum>,
"unitPriceWithVat": <double>,
"unitPriceWithoutVat": <double>,
"unitPurchasePrice": <double>,
"updated": <timestamp>,
"vat": <double>,
"versionDate": <timestamp>
}

get
Get order items

https://api.dotykacka.cz/v2/clouds/:cloudId/order-items
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
sort
optional
string
โ€‹
filter
optional
string
โ€‹
page
optional
integer
โ€‹
limit
optional
integer
โ€‹
Response
200: OK
[
{
// tag schema
}
]

get
Get order item

https://api.dotykacka.cz/v2/clouds/:cloudId/order-items/:orderItemId
Request
Response
Request
Path Parameters
orderItemId
required
string
โ€‹
cloudId
required
string
โ€‹
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
{
// tag schema
}

options
Options order items

https://api.dotykacka.cz/v2/clouds/:cloudId/order-items
Request
Response
Request
Path Parameters
cloudId
required
integer
โ€‹
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
โ€‹

options
Options order item

https://api.dotykacka.cz/v2/clouds/:cloudId/order-items/:orderItemId
Request
Response
Request
Path Parameters
orderItemId
required
integer
โ€‹
cloudId
required
integer
โ€‹
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
โ€‹