CLclover
ORDERS

Get summary about line items and orders which were deleted

Returns detailed information about line items and orders which were deleted.

get/v3/merchants/{mId}/voided_line_items/totals

Request

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

Path parameters

mIdstring required

Merchant Id

Query parameters

filterstring

Filter fields: [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

printedinteger

number of printed line items deleted

unprintedinteger

number of unprinted line items deleted

priceinteger

sum of price of all the items, in cents of merchant currency.

priceWithQuantityinteger

sum of price of all the items, in cents of merchant currency multiplied by quantity.

priceWithQuantityAndModifiersinteger

sum of price of all the items multiplied with quantity and includes modifiers.

deletedOrdersinteger

number of orders deleted

deletedItemsinteger

number of line items deleted

Changes

No recorded changes to this operation across all 2 revisions of this API.