Version 1.1 Changes
The following changes were introduced to support Pay at Table scenarios.
-
Added the update sale endpoint to allow both the POS and partner App to update the
OPENsale. -
Added the
SALE_UPDATEDwebhook event for the POS to be notified when changes are made to the sale. -
Added the
SALE_CLOSEDwebhook event for the POS to be notified when the sale status changes fromOPENtoCLOSED.
The following change was introduced to support reopened sales.
-
Added the
SALE_REOPENEDwebhook event for the App to be notified when a new sale has been created with statusREOPENED.
The following change was introduced to support sales listing.
-
Added the
dateTypefilter which allows the searching of sales on different date fields (previously only createdAt).
Sale Entity
| New/updated Field | Description | Change | Change Description |
|---|---|---|---|
| version | Represents the last read version of the sale returned by the GET request. If this version is out of date, the request will fail with a 412. Get the latest sale and merge it with the values from this request, then retry with the latest version. | New | Added to handle accidental overwrites for the PATCH request since multiple partners can modify the same sale. |
| status | An enum describing the status of the sale | Updated | New status enum values OPEN and REOPENED added |
| closedZonedDateTime | The time local time the sale was closed on the partner. | Updated | This value is now optional for OPEN sales |
| parentSaleId | The original sale id referencing the previous sale that was reopened | New | This attribute can only be set when creating a REOPENED sale |
| items.hidden | This can be set by the POS to indicate that this item should be hidden by the partner App | New | Added new optional hidden field to items |
| payments.method | The payment method | Updated | New payment enum added called ONLINE for sales made via partner App |
| payments.items | Optional list that indicates which line items this payment is for | New | Added optional items array to payments. This allows partners to track which items are partially or fully paid for |
| payments | Payments made for the sale | Updated | Payments is now optional for OPEN sales |
| tax | The total amount (in cents) of tax collected for this sale by the merchant. | Updated | Tax is now optional for OPEN sales |
| customer.name | Name of the customer | Removed | Customer name has been removed as it was deprecated in version 1.0 |
| customer.id | Id of the customer | Updated | Customer id is now optional |
| register | Information about which register in the venue was used | Updated | Register fields are now optional |