Skip to content

Exchange a Google sign-in code for a session

POST
/public/stores/{storeRef}/auth/google/exchange
curl --request POST \
--url https://apibase.ecomweb.app/api/v1/public/stores/example/auth/google/exchange \
--header 'Content-Type: application/json' \
--header 'x-storefront-api-key: <x-storefront-api-key>' \
--data '{ "code": "example" }'

Redeems the one-time code from the Google redirect for a session. The code works once and expires after 60 seconds. Use access_token as the customerToken bearer token on shopper routes. Rate limited to 20 requests per minute per store and client IP.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
code
required

One-time code from the Google callback redirect. Single-use and valid for 60 seconds.

string

Example generated

{
"code": "example"
}
Media typeapplication/json
object
identity
required

The signed-in identity.

object
id
required

Identity ID (a UUID). Use it as the shopper’s sign-in ID.

string
email
required

Email address, or null for an anonymous session.

string
nullable
email_verified
required

Whether the shopper has proved they own the email address.

boolean
is_anonymous
required

True for a session issued by the anonymous route, which has no email or password.

boolean
access_token
required

The access token, a signed JWT. Send it as Authorization: Bearer <access_token> (the customerToken scheme).

string
refresh_token
required

The refresh token, 64 hex characters. Single-use: each refresh returns a new one and revokes this one.

string
expires_in
required

Seconds until the access token expires. The store sets this; the default is 15 minutes.

number

Example generated

{
"identity": {
"id": "example",
"email": "example",
"email_verified": true,
"is_anonymous": true
},
"access_token": "example",
"refresh_token": "example",
"expires_in": 1
}

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

Too many requests; wait a little before retrying.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}