Skip to main content
GET
List checkout experiences

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Query Parameters

active
enum<string>

true returns only experiences reachable in the store's live checkout tree, false only those that are not. Omit to return both.

Available options:
true,
false

Response

Success

checkoutExperiences
Checkout experience summary · object[]
required

The team's checkout experiences matching the filter. An experience that is not active is fully configured but unreachable — no shopper can currently be served it.

totalCount
integer
required

Number of checkout experiences returned.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

2