This API object is provided to extensions registered for the extension points 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.
import {
render,
Banner,
useOrder,
} from '@shopify/checkout-ui-extensions-react';
render(
'Checkout::OrderStatus::CustomerInformation::RenderAfter',
() => ,
);
function Extension() {
const order = useOrder();
if (order) {
return (
Please include your order ID ({order.id})
in support requests
);
}
return null;
}
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;
}
});
},
);
See the [StandardApi examples](/docs/api/checkout-ui-extensions/apis/standardapi#examples) for more information on how to use the API.
Order information that's available post-checkout.
Information about an order that was placed.
A globally-unique identifier.
Unique identifier for the order that appears on the order.
If cancelled, the time at which the order was cancelled.