Skip to main content
Anchor to CustomerVisit

CustomerVisit

object

Requires read_orders access scope or read_marketplace_orders access scope.

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.

Anchor to FieldsFields

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to landingPagelandingPage
•URL

URL of the first page the customer landed on for the session.

Anchor to landingPageHtmllandingPageHtml
•HTML

Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.

Anchor to marketingEventmarketingEvent
•MarketingEvent

Represent actions taken by an app, on behalf of a merchant, to market Shopify resources such as products, collections, and discounts.

Anchor to occurredAtoccurredAt
•DateTime!
non-null

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

Anchor to referralCodereferralCode
•String

Marketing referral code from the link that the customer clicked to visit the store. Supports the following URL attributes: ref, source, or r. For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.

Anchor to referralInfoHtmlreferralInfoHtml
•FormattedString!
non-null

Referral information with URLs linked in HTML.

Anchor to referrerUrlreferrerUrl
•URL

Webpage where the customer clicked a link that sent them to the online store. For example, https://randomblog.com/page1 or android-app://com.google.android.gm.

Anchor to sourcesource
•String!
non-null

Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.

Anchor to sourceDescriptionsourceDescription
•String

Describes the source explicitly for first or last session.

Anchor to sourceTypesourceType
•MarketingTactic

Type of marketing tactic.

Anchor to utmParametersutmParameters
•UTMParameters

A set of UTM parameters gathered from the URL parameters of the referrer.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?