Upsert Order Custom Attribute - Automate.ax

square.upsertOrderCustomAttribute creates or updates a custom attribute for an order.

Example

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

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

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

  square.upsertOrderCustomAttribute({
    orderId: "order_id",
    customAttributeKey: "custom_attribute_key",
    customAttribute: {
      key: "table-number",
      value: "42",
      version: 1,
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_WRITE.

Field	Type	Required	Default	Description
`orderId`	`string`	Yes	—	The ID of the target order.
`customAttributeKey`	`string`	Yes	—	The key of the custom attribute to create or update. This key must match the key of an existing custom attribute definition.
`customAttribute`	`Square.CustomAttribute`	Yes	—	The custom attribute to create or update, with the following fields: - `value`. This value must conform to the `schema` specified by the definition. For more information, see Value data types. - `version`. To enable optimistic concurrency control, include this optional field and specify the current version of the custom attribute.
`idempotencyKey`	`string \| null`	No	—	A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

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

Output

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