Update Order - Automate.ax

square.updateOrder updates an open order by adding, replacing, or deleting fields.

Example

automations/square-update-order.automation.ts

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

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

  square.updateOrder({
    orderId: "order_id",
    order: {
      locationId: "location_id",
      lineItems: [
        {
          uid: "cookie_uid",
          name: "COOKIE",
          quantity: "2",
          basePriceMoney: {
            amount: BigInt("200"),
            currency: "USD",
          },
        },
      ],
      version: 1,
    },
    fieldsToClear: ["discounts"],
    idempotencyKey: "UNIQUE_STRING",
  })
})

Inputs

Every input accepts a compatible signal. It requires ORDERS_WRITE.

Field	Type	Required	Default	Description
`orderId`	`string`	Yes	—	The ID of the order to update.
`order`	`Square.Order`	No	—	The sparse order containing only the fields to update and the version to which the update is being applied.
`fieldsToClear`	`string[] \| null`	No	—	The dot notation paths fields to clear. For example, `line_items[uid].note`. For more information, see Deleting fields.
`idempotencyKey`	`string \| null`	No	—	A value you specify that uniquely identifies this update request. If you are unsure whether a particular update was applied to an order successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate updates to the order. The latest order version is returned. For more information, see Idempotency.

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

Output

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