Search Terminal Checkouts - Automate.ax

square.searchTerminalCheckouts returns a filtered list of Terminal checkout requests created by the application making the request.

Example

automations/square-search-terminal-checkouts.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Search Square Terminal Checkouts", () => {
  onDashboardRun({ title: "Search Square Terminal Checkouts" })

  square.searchTerminalCheckouts({
    query: {
      filter: {
        status: "COMPLETED",
      },
    },
    limit: 2,
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYMENTS_READ.

Field	Type	Required	Default	Description
`query`	`Square.TerminalCheckoutQuery`	No	—	Queries Terminal checkouts based on given conditions and the sort order. Leaving these unset returns all checkouts with the default sort order.
`cursor`	`string`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. See Pagination for more information.
`limit`	`number`	No	—	Limits the number of results returned for a single request.

Use the official SearchTerminalCheckouts reference for provider field semantics and limits.

Output

Returns the official Square.SearchTerminalCheckoutsResponse response as a codec-safe object. Square integer money amounts remain bigint values.