v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

FinancialV2

BETA - Get 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.

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

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

Query parameters

datestring date required

Example:2023-01-01

The business date of the aborted orders.

Response

Aborted orders returned successfully.

staffNamestring

The name of the staff member who aborted the order.

timeOfAbortedOrderstring date-time

The timestamp when the order was aborted and all line items fully cleared.

totalAmountAbortedstring

The total value of the aborted order.

Example response

[
  {
    "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"
      }
    ]
  }
]