# OrderStatusApi


This API object is provided to extensions registered for the extension points that appear exclusively on the order status page.

It extends the [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi) and provides access to an order object.


```jsx
import {
  render,
  Banner,
  useOrder,
} from '@shopify/checkout-ui-extensions-react';

render(
  'Checkout::OrderStatus::CustomerInformation::RenderAfter',
  () => <Extension />,
);

function Extension() {
  const order = useOrder();

  if (order) {
    return (
      <Banner>
        Please include your order ID ({order.id})
        in support requests
      </Banner>
    );
  }

  return null;
}

```

```js
import {
  Banner,
  extend,
} from '@shopify/checkout-ui-extensions';

extend(
  'Checkout::OrderStatus::CustomerInformation::RenderAfter',
  (root, {order}) => {
    let bannerShown = false;

    order.subscribe((order) => {
      if (order && !bannerShown) {
        root.appendChild(
          root.createComponent(
            Banner,
            undefined,
            `Please include your order ID (${order.id}) in support requests`,
          ),
        );

        bannerShown = true;
      }
    });
  },
);

```

## Properties

See the [StandardApi examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#examples) for more information on how to use the API.

### OrderStatusApi

### 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;
}
Order information that's available post-checkout.

### Order

Information about an order that was placed.

### id

value: `string`

A globally-unique identifier.

### name

value: `string`

Unique identifier for the order that appears on the order.

### cancelledAt

value: `string`

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

## Related

- [StandardApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi)
- [CheckoutApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/checkoutapi)
- [CartLineDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cartlinedetailsapi)
- [PickupPointsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuppointsapi)
- [PickupLocationsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/pickuplocationsapi)
- [ShippingMethodDetailsApi](https://shopify.dev/docs/api/checkout-ui-extensions/apis/shippingmethoddetailsapi)
- [ExtensionPoints](https://shopify.dev/docs/api/checkout-ui-extensions/apis/extensionpoints)