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

# Order

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

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

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* name

  Unique identifier for the order that appears on the order.

  ```ts
  string
  ```

* cancelledAt

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

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

* id

  A globally-unique identifier.

  ```ts
  string
  ```

* name

  Unique identifier for the order that appears on the order.

  ```ts
  string
  ```

* cancelledAt

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

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