Authentication

import SdkClientSetup from '/snippets/store-api/sdk-client-setup.mdx' import AuthJwtExample from '/snippets/store-api/auth-jwt-example.mdx' import AuthGuestCart from '/snippets/store-api/auth-guest-cart.mdx'

The SDK supports multiple authentication modes depending on your use case. For a full overview of the API authentication methods, see the Store API Authentication reference.

Publishable Key Only (Guest/Public Access)

Use a publishable API key for public endpoints like browsing products:

// Public endpoints work without user authentication
const products = await client.products.list()

Publishable Key + JWT (Authenticated Customer)

For authenticated customer actions like viewing orders or managing addresses:

// Refresh token when needed
const newTokens = await client.auth.refresh({ token })

Register New Customer

const { token, user } = await client.customers.create({
  email: '[email protected]',
  password: 'password123',
  password_confirmation: 'password123',
  first_name: 'John',
  last_name: 'Doe',
})

Guest Checkout

For guest checkout, use the token returned when creating a cart. The SDK automatically sends it via the x-spree-token header:

const options = { spreeToken: cart.token }

// Update cart with email
await client.carts.update(cart.id, {
  email: '[email protected]',
}, options)

// Complete checkout
await client.carts.complete(cart.id, options)