# OrderStatusApi

This API object is provided to extensions registered for the extension targets that appear exclusively on the **Order status** page.

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

### 

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

export default reactExtension(
  'customer-account.order-status.customer-information.render-after',
  () => <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,
  extension,
} from '@shopify/ui-extensions/checkout';

export default extension(
  'customer-account.order-status.customer-information.render-after',
  (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](/docs/api/checkout-ui-extensions/apis/standardapi#examples) for more information on how to use the API.
### OrderStatusApi

### order
Order information that's available post-checkout.
### Order
Information about an order that was placed.
### id
A globally-unique identifier.
### name
Unique identifier for the order that appears on the order.
### cancelledAt
If cancelled, the time at which the order was cancelled.
## Related
- [StandardApi](/docs/api/checkout-ui-extensions/apis/standardapi)
- [CheckoutApi](/docs/api/checkout-ui-extensions/apis/checkoutapi)
- [CartLineItemApi](/docs/api/checkout-ui-extensions/apis/cartlineitemapi)
- [PickupPointListApi](/docs/api/checkout-ui-extensions/apis/pickuppointlistapi)
- [PickupLocationListApi](/docs/api/checkout-ui-extensions/apis/pickuplocationlistapi)
- [ShippingOptionItemApi](/docs/api/checkout-ui-extensions/apis/shippingoptionitemapi)
- [ExtensionTargets](/docs/api/checkout-ui-extensions/apis/extensiontargets)