Skip to main content

Choose a version:

Checkout Token
API

The API for interacting with the token of a checkout.

Anchor to standardapiStandardApi

The base API object provided to purchase, and customer-account.order-status extension targets.

Anchor to checkoutToken checkoutToken StatefulRemoteSubscribable< | undefined> required: A stable id that represents the current checkout.

Matches the token field in the WebPixel checkout payload and the checkout_token field in the Admin REST API Order resource.

Was this section helpful?

Anchor to useCheckoutToken
useCheckoutToken()

Returns a stable id that represents the current checkout.

Anchor to useCheckoutToken-returnsReturns

| undefined

Was this section helpful?

Anchor to relatedRelated

ReferenceTargets

ReferenceComponents

ReferenceConfiguration