v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

ORDERS

Create a list of voided line items

Creates a list of voided line items for an order.

post/v3/merchants/{mId}/orders/{orderId}/voided_line_items

mIdstring required

Merchant identifier.

orderIdstring required

Order identifier.

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

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?

Successful response. List of voided line items created.