useOrder

Returns the order information that's available post-checkout.

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<Target>(); if ('order' in api) { return useSubscription(api.order); } throw new ExtensionHasNoMethodError('order', api.extension.target); }

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
• CheckoutApi
• OrderStatusApi
• CartLineItemApi
• PickupPointListApi
• PickupLocationListApi
• ShippingOptionItemApi
• ExtensionTargets