Returns a function to mutate the `note` property of the checkout.
Returns a function to mutate the `note` property of the checkout.
export function useApplyNoteChange< ID extends RenderExtensionPoint = RenderExtensionPoint, >(): (change: NoteChange) => Promise<NoteChangeResult> { const api = useApi<ID>(); if ('applyNoteChange' in api) { return api.applyNoteChange; } throw new ExtensionHasNoMethodError('applyNoteChange', api.extensionPoint); }
NoteRemoveChange | NoteUpdateChange
Removes a note
The type of the `NoteRemoveChange` API.
An Update to a note on the order. for example, the buyer could request detailed packaging instructions in an order note
The type of the `NoteUpdateChange` API.
The new value of the note.
NoteChangeResultSuccess | NoteChangeResultError
The type of the `NoteChangeResultSuccess` API.
The type of the `NoteChangeResultError` API.
A message that explains the error. This message is useful for debugging. It is **not** localized, and therefore should not be presented directly to the buyer.