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

# OrderAPI

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

  StatefulRemoteSubscribable\<OrderConfirmation>

  required

  Order information that's available post-checkout.

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

```ts
export interface OrderConfirmation {
  order: {
    /**
     * The globally-uniqueID of the OrderConfirmation. This will be the ID of the Order once successfully created.
     */
    id: string;
  };
  /**
   * 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.
   */
  number?: string;

  /**
   * Whether this is the customer's first order.
   */
  isFirstOrder: boolean;
}
```

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