Retrieve Order Custom Attribute - Automate.ax

square.retrieveOrderCustomAttribute retrieves a custom attribute associated with an order.

Example

automations/square-retrieve-order-custom-attribute.automation.ts

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

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

  square.retrieveOrderCustomAttribute({
    orderId: "order_id",
    customAttributeKey: "custom_attribute_key",
    version: 1,
    withDefinition: 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.
`customAttributeKey`	`string`	Yes	—	The key of the custom attribute to retrieve. This key must match the key of an existing custom attribute definition.
`version`	`number \| null`	No	—	To enable optimistic concurrency control, include this optional field and specify the current version of the custom attribute.
`withDefinition`	`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 RetrieveOrderCustomAttribute reference for provider field semantics and limits.

Output

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