# Order

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.

### Docs_OrderStatus_OrderApi

### order

value: `StatefulRemoteSubscribable<Order | undefined>`

  - Order: 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;
}
Information about the order that was placed.

### Order

Information about an order that was placed.

### cancelledAt

value: `string`

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

### confirmationNumber

value: `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.

### id

value: `string`

A globally-unique identifier.

### name

value: `string`

Unique identifier for the order that appears on the order.

### processedAt

value: `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.

## useOrder

Returns the order information that's available on the Order Status Page.

### UseOrderGeneratedType

Returns the order information that's available post-checkout.

#### Returns: Order | undefined
export function useOrder<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): Order | undefined {
  const api = useApi<Target>();

  if ('order' in api) {
    return useSubscription(api.order);
  }

  throw new ExtensionHasNoMethodError('order', (api as any).extension.target);
}


### Order

Information about an order that was placed.

### cancelledAt

value: `string`

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

### confirmationNumber

value: `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.

### id

value: `string`

A globally-unique identifier.

### name

value: `string`

Unique identifier for the order that appears on the order.

### processedAt

value: `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.