getUnfinishedSales

Get a list of not completed and cancelled point of sale transactions.

This is a special integration with Berlin POS. When a sale in progress is cancelled (by clicking the red "trash can" button), the items that had been scanned so far get recorded as a "cancelled sale". If Berlin POS is configured to automatically delete pending sales at the end of a shift, these deleted documentsget recorded as "sales not completed".

This API call returns both of these records.

Input parameters

Parameter name Description Possible value Required
startTimestamp  Specify the beginning of the time range.  Integer (Unix timestamp)  yes  
endTimestamp  Specify the end of the time range.  Integer (Unix timestamp)  yes  
pointOfSaleID  Optionally retrieve information about one specific register only. When omitted, records from all registers are returned.  Integer    
recordsOnPage  Number of records API should return. By default 20, at most 100.  Integer    
pageNo  API returns at most recordsOnPage items at a time. To retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1".  Integer    

Response

Field name Type Description
transactionID  Integer  An identifier for the cancelled / not completed transaction.  
pointOfSaleID  Integer  Register where the transaction was made.  
timestamp  Integer (Unix timestamp)  Time of deletion or cancelling. (Note that this makes sense for cancelled transactions only. "Not completed" transactions are all deleted at the end of the shift. The timestamp refers to the time of deletion, and does not indicate when that transaction was started.)  
type  String  Possible values: "CANCELLED", "NOT_COMPLETED".  
transactionTotal  Decimal  Total value of the transaction — in account's default currency, with VAT.