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

# Order

The API for interacting with the order, available on the **Order status** page.

## OrderConfirmationApi

The API object provided to `purchase.thank-you` and `customer-account.order-status` extension targets.

* orderConfirmation

  StatefulRemoteSubscribable\<OrderConfirmation>

  required

  Order information that's available post-checkout.

### OrderConfirmation

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

## OrderStatusApi

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

* order

  StatefulRemoteSubscribable\<Order | undefined>

  required

  Order information that's available post-checkout.

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

```ts
export interface Order {
  /**
   * A globally-unique identifier.
   * @example 'gid://shopify/Order/1'
   */
  id: string;
  /**
   * Unique identifier for the order that appears on the order.
   * @example '#1000'
   */
  name: string;
  /**
   * If cancelled, the time at which the order was cancelled.
   */
  cancelledAt?: 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.
   */
  confirmationNumber?: string;
}
```

## use​Order()

Returns the order information that's available on the **Order status** page.

### Returns

* Order | undefined

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

```ts
export interface Order {
  /**
   * A globally-unique identifier.
   * @example 'gid://shopify/Order/1'
   */
  id: string;
  /**
   * Unique identifier for the order that appears on the order.
   * @example '#1000'
   */
  name: string;
  /**
   * If cancelled, the time at which the order was cancelled.
   */
  cancelledAt?: 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.
   */
  confirmationNumber?: string;
}
```

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