GET
List cancelled sales
Company space For: Cashier and seller, Manager · Permission: orders.cashing.list Conditions
  • The caller must be a cashier or hold the orders.cashing.list permission.
  • A connected cashier must have an open register session, and sees only the cancelled orders of their own register and cashier since the register session opened; the filters are ignored for them.
  • Other members see orders cancelled inside the date range (the company’s current day when no range is sent).
  • to_date must not be before from_date, and from_date is required when to_date is sent.
Part of Run a register session.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from_date
string | null

Start of the date range on the cancellation time, ISO 8601 (Y-m-d or Y-m-dTH:i:s), read in the company's time zone. Defaults to the start of today. Ignored for a connected cashier.

to_date
string | null

End of the date range on the cancellation time, same format. A date without time covers the whole day. Defaults to the end of the day of from_date. Ignored for a connected cashier.

cash_register_id
string | null

Keeps only orders of this register (27-character identifier). Ignored for a connected cashier.

Required string length: 27
cashier_id
string | null

Keeps only orders cashed by the person with this id: the identifier of the agent account or user profile behind the cashier, not the cashier record id. Ignored for a connected cashier.

Required string length: 27
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
sort_by
string | null

Field the list is sorted by.

Required string length: 2 - 30
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, number, customer_id, customer_name, currency_code, items_net_total, items_tax_total, items_gross_total, discount, charge, order_tax_total, total, discount_applications, status, payment_status, seller_id, cash_register_id, cashier_id, confirmed_cashier_shift_id, confirmed_cash_register_instance_id, completed_at, cancelled_at, rejected_at, approved_by, rejected_by, approved_at, created_at, updated_at, is_credit, credit_detail, rendered_html.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: items, items.taxLines, items.allocations, taxLines, payments, seller, cashRegister, cashier.

Response

Resource.

data
OrderResource · object[]
required

Items of this page.

meta
object
required

Pagination details.