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

# OrderAPI

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

  StatefulRemoteSubscribable\<Order | undefined>

  required

  Information about the order that was placed.

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

```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;
  /**
   * 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.
   */
  processedAt?: 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
  ```

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

```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;
  /**
   * 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.
   */
  processedAt?: 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;
}
```