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.

Docs_Standard_CheckoutTokenApi

checkoutToken
A stable id that represents the current checkout. Matches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).
```
StatefulRemoteSubscribable<CheckoutToken | undefined>
```

export interface Docs_Standard_CheckoutTokenApi
  extends Pick<StandardApi, 'checkoutToken'> {}

CheckoutToken

string

Was this section helpful?

Anchor to useCheckoutToken
useCheckoutToken()

Returns a stable id that represents the current checkout.

Anchor to useCheckoutToken-returnsReturns

| undefined

UseCheckoutTokenGeneratedType

A stable id that represents the current checkout. Matches the `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).

CheckoutToken | undefined

CheckoutToken | undefined

export function useCheckoutToken<
  Target extends RenderExtensionTarget = RenderExtensionTarget,
>(): CheckoutToken | undefined {
  return useSubscription(useApi<Target>().checkoutToken);
}