Skip to content

Void Transaction

POST /transactions/{id}/void action bearer

Voids an in-progress POS transaction before payment completion, releasing any held inventory.

Overview
ID void-transaction-api
Method POST
Path /transactions/{id}/void
Classification action
Domain commerce
Capability checkout
Service cancel-order
Application pos — POS
Auth bearer

Response
Business Object order
Description Confirmed commercial commitment created from checkout or assisted selling.
Lifecycle draft → confirmed → in-fulfilment → partially-fulfilled → completed → return-in-progress → cancelled

Events Emitted

Event Classification Object Description
checkout-cancelled transitioned basket An in-progress checkout was abandoned or explicitly cancelled before payment completion.

Scenarios using checkout

Scenario Description
Buy Online, Pick Up In Store Customer browses and purchases online, then collects the order from a physical store. The canonical
Unified Omnichannel Checkout Customer completes a standard commerce checkout journey from basket through pricing, promotions, pay
Clienteling Sale A store associate uses a clienteling application to identify a known customer, review their purchase
Endless Aisle Store associate helps a customer order an item that is not physically stocked in the current store b
Exchange Anywhere Customer exchanges an item purchased in any channel at any supported touchpoint. The original item i
Loss Prevention Case Handling A checkout or item-identification anomaly is captured as evidence, triaged under an approved interve
Loyalty Enrollment A customer is enrolled into the retailer's loyalty programme during or after a transaction — in-stor
Reserve and Collect Customer reserves stock online for in-store collection without paying at the time of reservation. Th
Scan and Go Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in
Self-Checkout Customer scans and bags items at a self-checkout kiosk, receives applicable promotions, settles paym
Ship From Store An online order is fulfilled by shipping the goods directly from a physical store rather than a cent
Ship To Store Customer places an online order for collection at a chosen store while stock is sourced from a wareh
Voucher Redemption Customer redeems a voucher or gift card during checkout in store or online. The flow covers voucher
API Method Path Type
Create Transaction POST /transactions command
Create Basket POST /baskets command
Add Line to Basket POST /baskets/{id}/lines command
Checkout Basket POST /baskets/{id}/checkout action
Get Product GET /products/{id} query