Skip to main content
POST
Record an allowlisted Storefront analytics event

Authorizations

X-Cart-Token
string
header
required

Purpose-limited capability returned for a guest cart.

Headers

Idempotency-Key
string
required

Caller-stable key reused only for retries of this exact request.

Required string length: 16 - 128
Pattern: ^[A-Za-z0-9._:-]{16,128}$

Path Parameters

locationId
string
required
Required string length: 1 - 128

Body

application/json
cartId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
eventType
enum<string>
required
Available options:
SCAN,
CART_VIEW,
CHECKOUT_VIEW
metadata
object | null

Response

Event accepted.

status
enum<string>
required
Available options:
accepted