Create a transaction
Records a transaction your own system processed, such as an order taken on your website. Send a UUID version 7 as id; sending the same one again returns the transaction already recorded rather than creating a second. lane_id and employee_id must reference the virtual lane and employee Vori provisions for your store — find the lane with GET /v1/lanes?virtual=true, and contact Support if your store has none.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
A completed checkout to record against a lane and cashier, with its products, payments, and totals.
Unique transaction ID generated by your system (UUID version 7). Sending the same transaction twice with the same ID will not create a duplicate.
When the transaction was completed in your system.
ID of the employee to record this transaction under.
^[0-9]+$ID of the lane to record this transaction under.
^[0-9]+$Products on the transaction.
1 - 2500 elementsPayments applied to the transaction.
1 - 50 elementsTotal sales tax charged on the transaction. Must equal the sum of the line-item tax totals.
^[0-9]+(\.[0-9]+)?$"199.99"
Final transaction total including tax. Must equal the sum of the line totals, and the payments must add up to this amount.
^[0-9]+(\.[0-9]+)?$"199.99"
ID of the loyalty shopper who placed the transaction, if known. Links the transaction to their loyalty account.
Response
A completed checkout at a store, covering the lane, cashier, and shopper, the products sold, the savings applied, the payments collected, and any refunds against it.
Unique identifier for the record.
Cash back requested by the shopper, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Date and time when the transaction was finalized.
Total savings from coupons, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Total savings from manual or employee discounts, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
ID of the employee who processed the transaction.
^[0-9]+$Gift cards purchased in the transaction.
Total face value of gift cards purchased in the transaction, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Coupons issued to the shopper by the transaction.
Total value of item modifiers, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
ID of the checkout lane that processed the transaction.
^[0-9]+$Product line items included in the transaction.
Total savings from loyalty reward redemptions, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Payments collected for the transaction.
Total savings from promotions, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Sum of line-item totals after promotions are applied, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
How the shopper took their receipt.
noReceipt, print, sms Total value refunded against this transaction, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Refunds of the transaction. Retrieve one with GET /v1/transactions/{id} for the products returned and how the money went back.
Sum of line-item retail totals after promotions and before discounts and tax, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Human-readable transaction identifier shown to the shopper.
ID of the loyalty shopper associated with the transaction, or null for an anonymous transaction.
Date and time when the cashier started the transaction.
Current lifecycle status of the transaction.
completed, expired, suspended, voided ID of the store where the transaction was placed.
^[0-9]+$Sum of line-item subtotals before promotions, discounts, and tax, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Total tax charged on the transaction, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Portion of the transaction subject to tax, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Tip added by the shopper, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Final transaction amount including tax, as a decimal string in major/minor currency units. Sales are positive and refunds are negative.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Total collected from the shopper, including the transaction total, tip, and cash back, as a decimal string in major/minor currency units.
^-?[0-9]+(\.[0-9]+)?$"199.99"
Financial transaction type represented by the transaction.
refund, sale, void