API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

CustomerVisit object

Version unstable

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2021-07 (Release candidate)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2021-04 (Latest)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2021-01

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2020-10

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2020-07

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2020-04

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2020-01 (Unsupported)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2019-10 (Unsupported)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2019-07 (Unsupported)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Version 2019-04 (Unsupported)

Information about a customer's session on a shop's online store.

Required access

read_orders access scope.

Fields

  • id (ID!)

    Globally unique identifier.

  • landingPage (URL)

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

  • landingPageHtml (HTML)

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

  • marketingEvent (MarketingEvent)

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

  • occurredAt (DateTime!)

    When the customer moment occurred.

  • referralCode (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.

  • referralInfoHtml (FormattedString!)

    Referral information with URLs linked in HTML.

  • referrerUrl (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.

  • source (String!)

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

  • sourceDescription (String)

    Describes the source explicitly for first or last session.

  • sourceType (MarketingTactic)

    Type of marketing tactic.

  • utmParameters (UTMParameters)

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

Types that return CustomerVisit

Implements

Samples