---
title: Order
description: The API for interacting with the order, available on the Order Status Page.
api_version: 2026-01
api_name: customer-account-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/order
  md: https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/order.md
---

# Order

The API for interacting with the order, available on the Order Status Page.

## OrderStatusApi

The API object provided to this and other `customer-account.order-status` extension targets.

* **order**

  **SubscribableSignalLike\<Order | undefined>**

  **required**

  Information about the order that was placed.

### SubscribableSignalLike

Represents a read-only value managed on the main thread that an extension can subscribe to. Example: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker. This interface is compatible with \[Preact's ReadonlySignal]\(https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709). Some fields are deprecated but still supported for backwards compatibility. In version 2025-10, \[\`StatefulRemoteSubscribable\`]\(https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with \`ReadonlySignalLike\`. Checkout will remove the old fields some time in the future.

* current

  ```ts
  T
  ```

* destroy

  ```ts
  () => Promise<void>
  ```

* subscribe

  Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.

  ```ts
  (fn: (value: T) => void) => () => void
  ```

* value

  The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.

  ```ts
  T
  ```

### Order

Information about an order that was placed.

* cancelledAt

  If cancelled, the time at which the order was cancelled.

  ```ts
  string
  ```

* confirmationNumber

  A randomly generated alpha-numeric identifier for the order. For orders created in 2024 and onwards, the number will always be present. For orders created before that date, the number might not be present.

  ```ts
  string
  ```

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* name

  Unique identifier for the order that appears on the order.

  ```ts
  string
  ```

* processedAt

  The date and time when the order was processed. Processing happens after the checkout has completed, and indicates that the order is available in the admin.

  ```ts
  string
  ```