Skip to main content
GET
List transactions

Authorizations

Authorization
string
header
required

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

Query Parameters

completed_at
string<date-time>

When the transaction was completed. UTC unless the value carries an offset.

completed_at[gt]
string<date-time>

When the transaction was completed. UTC unless the value carries an offset.

completed_at[gte]
string<date-time>

When the transaction was completed. UTC unless the value carries an offset.

completed_at[lt]
string<date-time>

When the transaction was completed. UTC unless the value carries an offset.

completed_at[lte]
string<date-time>

When the transaction was completed. UTC unless the value carries an offset.

employee_id
string[]

The cashier who completed the transaction. Repeat to match any of up to 20 values.

ending_before
string

Return records that precede the record with this ID, in list order.

lane_id
string[]

The lane the transaction was completed on. Repeat to match any of up to 20 values.

limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100
shopper_id
string[]

The identified shopper, for transactions that had one. Accepts a TypeID or a UUID. Repeat to match any of up to 20 values.

starting_after
string

Return records that follow the record with this ID, in list order.

status
enum<string>[]

Lifecycle status of the transaction. Repeat to match any of up to 20 values.

Available options:
completed,
expired,
suspended,
voided
store_id
string[]

The store where the transaction was completed. Repeat to match any of up to 20 values.

type
enum<string>[]

Whether the transaction is a sale, a refund, or a void. Repeat to match any of up to 20 values.

Available options:
refund,
sale,
void

Response

A page of transactions.

data
object[]
required
has_more
boolean
required

Whether more records follow this page.