# Order The API for interacting with the order, available on the **Order status** page. ## OrderConfirmationApi The API object provided to `purchase.thank-you` and `customer-account.order-status` extension targets. ### OrderConfirmationApi ### orderConfirmation Order information that's available post-checkout. ### OrderConfirmation ### number 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. ### order ## Related - [Targets](/docs/api/checkout-ui-extensions/targets) - [Components](/docs/api/checkout-ui-extensions/components) - [Configuration](/docs/api/checkout-ui-extensions/configuration) - [Tutorials](/apps/checkout) ## OrderStatusApi The API object provided to `customer-account.order-status` extension targets. ### Docs_OrderStatus_OrderApi ### order Order information that's available post-checkout. ### Order Information about an order that was placed. ### cancelledAt If cancelled, the time at which the order was cancelled. ### confirmationNumber 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 A globally-unique identifier. ### name Unique identifier for the order that appears on the order. ## Related - [Targets](/docs/api/checkout-ui-extensions/targets) - [Components](/docs/api/checkout-ui-extensions/components) - [Configuration](/docs/api/checkout-ui-extensions/configuration) - [Tutorials](/apps/checkout) ## 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(); if ('order' in api) { return useSubscription(api.order); } throw new ExtensionHasNoMethodError('order', api.extension.target); } ### Order Information about an order that was placed. ### cancelledAt If cancelled, the time at which the order was cancelled. ### confirmationNumber 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 A globally-unique identifier. ### name Unique identifier for the order that appears on the order. ## Related - [Targets](/docs/api/checkout-ui-extensions/targets) - [Components](/docs/api/checkout-ui-extensions/components) - [Configuration](/docs/api/checkout-ui-extensions/configuration) - [Tutorials](/apps/checkout)