Requires read_orders access scope or read_marketplace_orders access scope.

Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.


A globally-unique ID.

Anchor to CustomerVisit.landingPage
landingPage
Learn more about accessing protected customer data

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

Anchor to CustomerVisit.landingPageHtml
landingPageHtml
Learn more about accessing protected customer data

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

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

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

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 CustomerVisit.referralInfoHtml
referralInfoHtml
Learn more about accessing protected customer data
non-null

Referral information with URLs linked in HTML.

Anchor to CustomerVisit.referrerUrl
referrerUrl
Learn more about accessing protected customer data

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.

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

Describes the source explicitly for first or last session.

Type of marketing tactic.

Anchor to CustomerVisit.utmParameters
utmParameters
Learn more about accessing protected customer data

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


Was this section helpful?
Map

Fields from

CustomerVisit

||-
CustomerVisit Implements
CustomerVisit