List Order Custom Attributes - Automate.ax

square.listOrderCustomAttributes lists the custom attributes associated with an order.

Example

automations/square-list-order-custom-attributes.automation.ts

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

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

  square.listOrderCustomAttributes({
    orderId: "order_id",
    visibilityFilter: "ALL",
    cursor: "cursor",
    limit: 1,
    withDefinitions: true,
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`orderId`	`string`	Yes	—	The ID of the target order.
`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.
`withDefinitions`	`boolean \| null`	No	`false`	Indicates whether to return the custom attribute definition in the `definition` field of each custom attribute. Set this parameter to `true` to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is `false`.

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

Output

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