Skip to main content
POST
List Batches

Authorizations

X-Api-Key
string
header
required

Enter your API key

Body

application/json
startDate
string<date-time>
default:2025-01-01
required

Start date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
endDate
string<date-time>
default:2025-02-01
required

End date, all date times are in UTC.

Format:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.fff
sortColumn
string | null
default:Id

Sort column, the column being used for sorting. The default is batch Id.

Valid Options:

  • Id
  • Closed
  • Sales
  • Refunds
  • Voids
  • GrossRevenue
  • RefundTotal
  • NetIncome
  • Status
Maximum string length: 100
Pattern: ^[A-Za-z0-9]*$
page
integer<int32> | null
default:1

Page, the of results being requested.

Required range: 1 <= x <= 2147483647
pageSize
integer<int32> | null
default:20

Page size, the number of items being requested for the page.

Required range: 1 <= x <= 1000
sortOrder
string | null
default:DESC

Sort order, the sort columns desired sort direction. The default is DESC.

Examples:

  • ASC
  • DESC
Maximum string length: 20
Pattern: ^[A-Za-z]*$

Response

object | null

OK

batches
object | null