The API for interacting with the order, available on the Order Status Page.
The API object provided to this and other `customer-account.order-status` extension targets.
Information about the order that was placed.
Information about an order that was placed.
If cancelled, the time at which the order was cancelled.
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.
A globally-unique identifier.
Unique identifier for the order that appears on the order.
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.
Returns the order information that's available on the Order Status Page.
Returns the order information that's available post-checkout.
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); }
Information about an order that was placed.
If cancelled, the time at which the order was cancelled.
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.
A globally-unique identifier.
Unique identifier for the order that appears on the order.
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.