Retrieve Order Custom Attribute Definition - Automate.ax

square.retrieveOrderCustomAttributeDefinition retrieves an order-related custom attribute definition from a Square seller account.

Example

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

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

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

    square.retrieveOrderCustomAttributeDefinition({
      key: "key",
      version: 1,
    })
  },
)

Inputs

Every input accepts a compatible signal. It requires ORDERS_READ.

Field	Type	Required	Default	Description
`key`	`string`	Yes	—	The key of the custom attribute definition to retrieve.
`version`	`number \| null`	No	—	To enable optimistic concurrency control, include this optional field and specify the current version of the custom attribute.

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

Output

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