POST cashdesk/getDinerProductsPrice?Token={Token}
Retrieve products prices for current diner.
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
CashDeskGetDinerProductsPriceReqName | Description | Type | Additional information |
---|---|---|---|
CashDesk |
The cash desk identification. The cash desk identification is used to identify the cash desk where the request is coming from. |
string |
Required |
PersonSystemId |
Person system internal identifier. |
globally unique identifier |
Required |
Products |
List of products to get prices for. |
Collection of CashDeskProductPriceReq |
Required |
Request Formats
application/json
{"CashDesk":"CD1","PersonSystemId":"f1f8d01b-f3f8-414a-b264-03f81f1e8b19","Products":[{"Order":1,"ProductId":"6d44540a-e206-ef11-8188-40cc26b417b1","DeliveryDate":"\/Date(1747173600000)\/","Amount":1}]}
application/xml
<CashDeskGetDinerProductsPriceReq> <CashDesk>CD1</CashDesk> <PersonSystemId>f1f8d01b-f3f8-414a-b264-03f81f1e8b19</PersonSystemId> <Products> <CashDeskProductPriceReq> <Order>1</Order> <ProductId>6d44540a-e206-ef11-8188-40cc26b417b1</ProductId> <DeliveryDate>2025-05-14T00:00:00+02:00</DeliveryDate> <Amount>1</Amount> </CashDeskProductPriceReq> </Products> </CashDeskGetDinerProductsPriceReq>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 server refuses fo fulfill the request | 8 | Not licensed |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
Collection of CashDeskProductPriceRespName | Description | Type | Additional information |
---|---|---|---|
Order |
Order in the list. |
integer |
None. |
ProductId |
Product system internal identifier. |
globally unique identifier |
None. |
DeliveryDate |
Delivery date. |
date |
None. |
Amount |
The number of portions/pieces. |
integer |
None. |
Price |
Price of the product (with VAT). |
decimal number |
None. |
VatRate |
VAT rate. |
decimal number |
None. |
PriceWithoutVat |
Price of the product (without VAT). |
decimal number |
None. |
GrantAmount | integer |
None. |
|
GrantPrice | decimal number |
None. |
|
Ordered |
Amount of ordered products. |
integer |
None. |
Name |
Product name. |
string |
None. |
OrderCode |
Product order code. |
string |
None. |
ErrorCode |
Error code. 0 - no error, 1 - not registered cashdesk, 2 - diner not found, 3 - not valid diner, 4 - not properly configured casdesk, 7 - no products specified, 8 - not rights to purchase, 9 - spending limit exceeded, 12 - closed period, 13 - no conversion rate specified |
integer |
None. |
ErrorText |
Error description. |
string |
None. |
Response Formats
application/json
[{"Order":1,"ProductId":"6d44540a-e206-ef11-8188-40cc26b417b1","DeliveryDate":"\/Date(1747173600000)\/","Amount":1,"Price":29,"VatRate":12,"PriceWithoutVat":25.89,"GrantAmount":1,"GrantPrice":103,"Ordered":0,"Name":"Product 2","OrderCode":"P2","ErrorCode":0,"ErrorText":null}]
application/xml
<ArrayOfCashDeskProductPriceResp> <CashDeskProductPriceResp> <Order>1</Order> <ProductId>6d44540a-e206-ef11-8188-40cc26b417b1</ProductId> <DeliveryDate>2025-05-14T00:00:00+02:00</DeliveryDate> <Amount>1</Amount> <Price>29</Price> <VatRate>12</VatRate> <PriceWithoutVat>25.89</PriceWithoutVat> <GrantAmount>1</GrantAmount> <GrantPrice>103</GrantPrice> <Ordered>0</Ordered> <Name>Product 2</Name> <OrderCode>P2</OrderCode> <ErrorCode>0</ErrorCode> </CashDeskProductPriceResp> </ArrayOfCashDeskProductPriceResp>