Shopfront Developers
Sales
Object
SaleAction
The value below corresponds to the type of action that was taken:
- Product / customer scan: the barcode scanned
- Product / customer search: the string searched
- Product / customer key: the key's rules
- Quantity override: the new quantity
- Increment / decrement quantity: the amount incremented / decrement
- Remove product: "keyboard" or "trash"
- Remove customer: an empty string
- Add / remove payment: the index of the payment method
| Fields | Type | Description |
|---|---|---|
|
action |
The action that was performed |
|
|
value |
String! |
The value of the action performed |
|
affecting |
The item this action has affected |
|
|
user |
The user who performed the action |
|
|
timestamp |
The time the action occurred |
Object
SaleDiscount
| Fields | Type | Description |
|---|---|---|
|
amount |
String |
The discount amount |
|
reason |
String |
The reason the discount was applied |
Object
SaleItemContained
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of this line |
|
|
parentId |
The ID of the parent line |
|
|
saleItemId |
The ID of the sale line it relates to |
|
|
item |
The full item that this is |
|
|
quantity |
Float |
How many of the item was used |
|
price |
Float |
The adjustment price for this item |
Object
SaleItem
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the line |
|
|
quantity |
Float |
The quantity sold |
|
caseQuantity |
Float |
The case quantity of the item at the time of the sale |
|
loyaltyValue |
Float |
The loyalty value (in points) |
|
cost |
Float |
The cost of the item for the sale |
|
note |
String |
An externally visible note relating to the item |
|
basePrice |
Float |
The base price for the product (without discounts and savings) |
|
discount |
The discount for the item |
|
|
savings |
Float |
The promotional savings for the item |
|
tax |
Float |
The total amount of tax paid for the item |
|
taxRate |
The tax rate used at the time of the sale |
|
|
totalPrice |
Float |
The total price for the item (what the item was sold for) |
|
promotions |
A list of promotions that were applied to the item |
|
|
kitchenReadyAt |
The time the kitchen marked this item as ready to serve |
|
|
contains |
A list of items that were contained within this item (used for basket products and packages) |
|
|
item |
The item that was sold |
|
|
metaData |
Any related miscellaneous data |
Object
SalePayment
| Fields | Type | Description |
|---|---|---|
|
id |
Int |
The ID of the payment line |
|
paymentMethod |
The payment method used |
|
|
subtype |
String |
The "subtype" of the payment made on the sale if originally provided (e.g. VISA / MASTERCARD for EFTPOS) |
|
register |
The register that the payment method was paid at |
|
|
status |
The status of the payment |
|
|
amount |
Float |
The amount of money spent on the payment method |
|
rounding |
Float |
How much rounding was applied to the payment |
|
cashout |
Float |
How much money was withdrawn by the customer at the time of the payment |
|
processTime |
The time the payment occurred |
|
|
metaData |
Any related miscellaneous data |
|
|
sale |
The sale that the payment method was used on |
|
|
customerPayment |
The customer payment that is attached to this payment, if null this payment was paid at the time of the transaction |
|
|
receipt |
String |
The integrated receipt for this payment method |
|
cancelledAt |
The time the payment was cancelled |
Object
SalePromotion
| Fields | Type | Description |
|---|---|---|
|
promotion |
The promotion that was used |
|
|
rebateAmount |
Float |
The total value of the rebate that was applied |
|
rebateQuantity |
Float |
The quantity of the rebate |
|
savings |
Float |
How much money was saved by using this promotion |
|
quantity |
Float |
How many times the promotion was applied to the item |
Object
Sale
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the sale |
|
|
clientId |
String |
The local ID of the sale |
|
linkedSale |
A sale this is linked to (for a return for example) |
|
|
register |
The register that the sale was performed at |
|
|
user |
The user who performed the sale |
|
|
customer |
The customer who the sale is for |
|
|
status |
The current status of the sale |
|
|
accountSale |
Boolean |
Whether the sale was put on account |
|
invoiceId |
String! |
The ID of the invoice (normally numbers, but can contain any string) (typically called "invoice number") |
|
note |
String |
A public note for the sale |
|
internalNote |
String |
An internal note for the sale |
|
orderReference |
String! |
The order reference for this sale, typically used when selling products to other companies, this will mostly be blank |
|
discount |
Any discounts that were applied to the sale |
|
|
loyaltyValue |
Float |
The loyalty value (in points) for the sale |
|
totalSingles |
Int |
How many singles were sold on the sale |
|
totalCases |
Int |
How many cases were sold on the sale |
|
totalQuantity |
Int |
The total quantity sold on the sale |
|
totalCost |
Float |
The total cost of the sale |
|
totalBase |
Float |
The base price for the sale (without discounts and promotions) |
|
totalSavings |
Float |
The total promotional savings for the sale |
|
totalDiscount |
Float |
The total discount for the sale |
|
totalTax |
Float |
The total tax for the sale |
|
cashout |
Float |
The total amount of money withdrawn by the customer |
|
totalChange |
Float |
The total amount of change provided to the customer |
|
totalRounding |
Float |
The total amount of rounding on the sale |
|
totalPrice |
Float |
The total price for the sale |
|
outstanding |
Float |
The amount of money left unpaid on this sale |
|
modifyReason |
String |
The reason the sale was modified |
|
refundReason |
String |
The reason this sale was refunded |
|
metaData |
Customisable unstructured meta data related to the sale |
|
|
items |
The items that were sold on this sale |
|
|
payments |
The payments made on this sale |
|
|
actions |
The actions that occurred during the sale |
|
|
createdAt |
The time the sale was created / processed |
|
|
updatedAt |
The last time the sale was updated |
|
|
uploadedAt |
The time the sale was uploaded to the server |
|
|
revisions |
The revisions for the sale |
|
|
isCancellable |
Boolean! |
Whether the sale can be cancelled |
SaleRevisionConnection
Object — ConnectionType of Revision
Sortable Fields
Fields from Revision that can be used to sort the connection items
- timestamp
Object
Surcharge
Implements
List of interfaces this object implements
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the surcharge (this is always |