Note

The API for interacting with the note applied to checkout.

OrderStatusApi

The API object provided to this and other `customer-account.order-status` extension targets.

Docs_OrderStatus_NoteApi

note

A note left by the customer to the merchant, either in their cart or during checkout.

useNote

Returns the proposed `note` applied to the checkout.

UseNoteGeneratedType

Returns the proposed `note` applied to the checkout.

Returns: string | undefined

export function useNote< Target extends RenderOrderStatusExtensionTarget = RenderOrderStatusExtensionTarget, >(): string | undefined { const api = useApi<Target>(); const extensionTarget = api.extension.target; if (!('note' in api)) { throw new ExtensionHasNoFieldError('note', extensionTarget); } return useSubscription(api.note); }