CLclover
ORDERS

Get a list of line items from voided orders

Changed on

Retrieves a list of line items from voided orders, along with the reason for the void.

get/v3/merchants/{mId}/voided_line_items

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/voided_line_items
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant identifier (mId).

Query parameters

filterstring

Filter fields to display search results: [reason, quantity, orderId, revenueClassName, deleteType, isRevenue, approvedByUuid, sortByName, printed, orderType.id, price, name, showInReporting, lineItemUuid, id, deletedTime]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Successful response. Display line items from voided orders, along with the reason for the void.

reasonstring

Why was the line item voided

deleteTypestring

Indicates if the line item was deleted as part of order delete or a single item delete.

deletedTimeinteger

Timestamp of when this line item was deleted

environmentstring

Which environment was this recorded in

clientEventType'DELETED_LINE_ITEM' | 'MOVED_TABLE' | 'LEFT_TABLE' | 'CUSTOM_LINE_ITEM_CANCELLED' | 'WHILE_ADDING_LINE_ITEM_CANCELLED'

What event on the client removed this? Was it because of moving a table? Or was it plain old deleting a line item?

Changes