BETA - Get Aborted Orders | Lightspeed Restaurant K-Series API documentation (prod)

BETA - Get Aborted Orders Beta

GET /f/v2/beta/business-location/{businessLocationId}/aborted-orders

Retrieves a list of aborted orders for a specified business day.

An aborted order is defined as an instance where items were added to an order, but all items were subsequently removed without being committed.

Path parameters

businessLocationId integer(int64) Required

The unique identifier for the business location.

Minimum value is 1.

Query parameters

date string(date) Required

The business date of the aborted orders.

Responses

200 application/json

Aborted orders returned successfully.
Hide response attributes Show response attributes object
- staffName string
  
  The name of the staff member who aborted the order.
- timeOfAbortedOrder string(date-time)
  
  The timestamp when the order was aborted and all line items fully cleared.
- totalAmountAborted string
  
  The total value of the aborted order.
- abortedLineItems array[object]
  
  A list of all line items that were removed from the aborted order.
  
  Hide abortedLineItems attributes Show abortedLineItems attributes object
  
  itemName string
  
  The name of the item that was removed from the order.
  
  itemSku string
  
  The SKU of the item that was removed from the order.
  
  itemQuantity string
  
  The quantity of the item removed from the order.
  
  itemAmount string
  
  The total price for this item (itemPrice * itemQuantity).
  
  itemPrice string
  
  The unit price of the item removed from the order.
400 application/json

Bad Request - Invalid request parameters or format.
Hide response attribute Show response attribute object
- error string Required
500 application/json

Internal Server Error - An error occurred on the server.
Hide response attributes Show response attributes object
- timestamp string(date-time) Required
- path string Required
- status integer(int32) Required
- error string Required
- requestId string Required

GET /f/v2/beta/business-location/{businessLocationId}/aborted-orders

curl \
 --request GET https://api.lsk.lightspeed.app/f/v2/beta/business-location/45454565682155/aborted-orders?date=2023-01-01 \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "staffName": "Employee 1",
    "timeOfAbortedOrder": "2023-03-14T19:58:48.224Z",
    "totalAmountAborted": "33.32",
    "abortedLineItems": [
      {
        "itemName": "Soda",
        "itemSku": "9",
        "itemQuantity": "4.000",
        "itemAmount": "33.32",
        "itemPrice": "8.33"
      }
    ]
  }
]

Response examples (400)

{
  "error": "string"
}

Response examples (500)

{
  "timestamp": "2025-05-04T09:42:00+00:00",
  "path": "string",
  "status": 42,
  "error": "string",
  "requestId": "string"
}