NoteAPI
API
The API for interacting with the note applied to checkout.
Anchor to standardapiStandardApi
The base API object provided to purchase extension targets.
Anchor to note
note
StatefulRemoteSubscribable<string | undefined>
required
A note left by the customer to the merchant, either in their cart or during checkout.
Was this section helpful?
Anchor to useNoteuse
use
Returns the proposed note applied to the checkout.
Anchor to useNote-returnsReturns
string | undefined
Was this section helpful?
Anchor to checkoutapiCheckoutApi
The API object provided to purchase.checkout extension targets.
Anchor to applyNoteChange
applyNoteChange
(change: ) => Promise<>
required
Performs an update on the note attached to the cart and checkout. If successful, this mutation results in an update to the value retrieved through the note property.
Note
This method will return an error if the cart instruction is false, or the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
Was this section helpful?
Anchor to useApplyNoteChangeuse
use
Returns a function to mutate the note property of the checkout.
(change: ) => Promise<>
Was this section helpful?
