Skip to main content
Anchor to CustomerMoment

CustomerMoment

interface

Requires read_orders access scope or read_marketplace_orders access scope.

Represents a session preceding an order, often used for building a timeline of events leading to an order.

Anchor to FieldsFields

Anchor to occurredAtoccurredAt
•DateTime!
non-null

The date and time when the customer's session occurred.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to CustomerVisitCustomerVisit
•OBJECT

A customer's session on the online store. Tracks how the Customer arrived at the store, including the landing page, referral source, and any associated marketing campaigns.

The visit captures attribution data such as UTMParameters, referral codes, and the MarketingEvent that drove the session. This information helps merchants understand which marketing efforts successfully bring customers to their store.

Was this section helpful?