---
title: Order
description: The API for interacting with the order confirmation, available on the **Thank You** page.
api_version: 2026-01
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/order
  md: https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/order.md
---

# Order

The API for interacting with the order confirmation, available on the **Thank You** page.

## OrderConfirmationApi

The API object provided to `purchase.thank-you` extension targets.

* **orderConfirmation**

  **SubscribableSignalLike\<OrderConfirmation>**

  **required**

  Order information that's available post-checkout.

### 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
  ```

### OrderConfirmation

* isFirstOrder

  Whether this is the customer's first order.

  ```ts
  boolean
  ```

* number

  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
  ```

* order

  ```ts
  { id: string; }
  ```

## OrderStatusApi

**Note:** This documentation has moved to customer accounts. Refer to \<a href="/docs/api/customer-account-ui-extensions/apis/order">Order API\</a>

Examples

### Examples

* #### Order confirmation

  ##### Preact

  ```jsx
  import '@shopify/ui-extensions/preact';
  import {render} from 'preact';

  export default function extension() {
    render(<Extension />, document.body);
  }

  function Extension() {
    const {id} =
      shopify.orderConfirmation.value.order;

    if (id) {
      return (
        <s-banner>
          Please include your order confirmation ID
          ({id}) in support requests
        </s-banner>
      );
    }

    return null;
  }
  ```

## Related

[Reference - Targets](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

[Reference - Components](https://shopify.dev/docs/api/checkout-ui-extensions/components)

[Reference - Configuration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

[Learn - Tutorials](https://shopify.dev/apps/checkout)