List Order Custom Attribute Definitions - Automate.ax

square.listOrderCustomAttributeDefinitions lists the order-related custom attribute definitions that belong to a Square seller account.

Example

automations/square-list-order-custom-attribute-definitions.automation.ts

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

export default automation(
  "List Square Order Custom Attribute Definitions",
  () => {
    onDashboardRun({ title: "List Square Order Custom Attribute Definitions" })

    square.listOrderCustomAttributeDefinitions({
      visibilityFilter: "ALL",
      cursor: "cursor",
      limit: 1,
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`visibilityFilter`	`Square.VisibilityFilter \| null`	No	—	Requests that all of the custom attributes be returned, or only those that are read-only or read-write.
`cursor`	`string \| null`	No	—	The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.
`limit`	`number \| null`	No	20	The maximum number of results to return in a single paged response. This limit is advisory. The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100. The default value is 20. For more information, see Pagination.

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

Output

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