Clone Order - Automate.ax

square.cloneOrder creates a new order, in the DRAFT state, by duplicating an existing order.

Example

automations/square-clone-order.automation.ts

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

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

  square.cloneOrder({
    orderId: "ZAISEM52YcpmcWAzERDOyiWS123",
    version: 3,
    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 clone.
`version`	`number`	No	—	An optional order version for concurrency protection. If a version is provided, it must match the latest stored version of the order to clone. If a version is not provided, the API clones the latest version.
`idempotencyKey`	`string \| null`	No	—	A value you specify that uniquely identifies this clone request. If you are unsure whether a particular order was cloned successfully, you can reattempt the call with the same idempotency key without worrying about creating duplicate cloned orders. The originally cloned order is returned. For more information, see Idempotency.

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

Output

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