Create a list of voided line items

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/orders/{orderId}/voided_line_items

Creates a list of voided line items for an order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant identifier.

orderId

string

required

Order identifier.

Body Params

lineItem

object

The line item that was voided

merchant

object

reason

string

Why was the line item voided

removedBy

object

Employee who voided the item

approvedBy

object

Optional. Employee who approved deletion of line item in case current employee does not have the permission

deleteType

string

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

device

object

Optional. Device used to void the line item

createdBy

object

Employee who created the order from which the line item was voided

deletedTime

int64

Timestamp of when this line item was deleted

environment

string

Which environment was this recorded in

clientEventType

string

enum

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

Allowed:

Headers

User-Agent

string

required

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

Response

200

Successful response. List of voided line items created.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here!