Skip to content

Commit 85422a2

Browse files
author
markzegarelli
authored
Merge pull request #1537 from segmentio/littledata-docs-update
Littledata docs update
2 parents 5d7dbae + 2ae492b commit 85422a2

File tree

1 file changed

+52
-46
lines changed
  • src/connections/sources/catalog/libraries/website/shopify-littledata

1 file changed

+52
-46
lines changed

‎src/connections/sources/catalog/libraries/website/shopify-littledata/index.md

Lines changed: 52 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Littledata is available as an independent [Shopify App](https://apps.shopify.com
1414

1515
2. The app also sets up server-side webhook forwarding to ensure 100% accuracy of important Customer and Order data.
1616

17+
This source has a full [tracking plan and event schema](https://docs.google.com/spreadsheets/d/1JOlgpXpQ7ctktES6B_RyKn0_KxanxGF6) in Google Sheets, which is ready to [upload into Protocols](/docs/protocols/apis-and-extensions/#google-sheets-tracking-plan-uploader).
18+
1719
Here's an architecture diagram that shows how the Littledata app mediates data flow between Shopify and Segment.
1820

1921
![](images/littledata_arch.png)
@@ -53,7 +55,7 @@ Below is a table of events that **Shopify by Littledata** sends to Segment throu
5355
| Thank you Page Viewed | A user has viewed the thank you page after completing an order\* |
5456

5557
> note ""
56-
> \* This is less reliable than the de-duplicated `Order Completed` event sent from the Littledata servers, but you can use it in device-mode destinations to trigger a conversion. The `payment_method` and `shipping_method` properties are not available with this event.
58+
> *This is less reliable than the de-duplicated `Order Completed` event sent from the Littledata servers, but you can use it in device-mode destinations to trigger a conversion. The `payment_method` and `shipping_method` properties are not available with this event.
5759
5860
## Cloud-mode events
5961

@@ -94,22 +96,26 @@ For every event where there is an identifiable Shopify customer (from both the d
9496

9597
The following traits are included with an Identify call:
9698

97-
| Property Name | Description | Property Type |
98-
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
99-
| `address` | The customer's primary address | String |
100-
| `createdAt` | The date customer record was created | Date |
101-
| `customerLifetimeValue` | The total spend of customer on the Shopify store | Double |
102-
| `description` | The customer notes | String |
103-
| `email` | The customer's email address | String |
104-
| `firstName` | The customer's first name | String |
105-
| `lastName` | The customer's email | String |
106-
| `marketingOptIn` | The `marketing_opt_in` field from [Shopify customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer?api[version]=2020-04) | String |
107-
| `phone` | The customer's phone number | String |
108-
| `purchaseCount` | The number of orders by this customer | Integer |
109-
| `state` | Whether the customer account is enabled or disabled | String |
110-
| `tags` | The custom tags [applied to the customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer?api[version]=2020-04) | String |
111-
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | Double |
112-
| `verified_email` (v2) | Whether the customer has verified their email | Boolean |
99+
| Property Name | Description | Property Type |
100+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------- |
101+
| `createdAt` | The date customer record was created | Date |
102+
| `customerLifetimeValue` | The total spend of customer on the Shopify store | Double |
103+
| `default_address.street` | The customer's default street address | String |
104+
| `default_address.city` | The customer's city address | String |
105+
| `default_address.postalCode` | The customer's ZIP / post code | String |
106+
| `default_address.state` | The customer's state address | String |
107+
| `default_adress.country` | The customer's country | String |
108+
| `description` | The customer notes | String |
109+
| `email` | The customer's email address | String |
110+
| `firstName` | The customer's first name | String |
111+
| `lastName` | The customer's last name | String |
112+
| `marketingOptIn` | The `marketing_opt_in` field from [Shopify customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer) | String |
113+
| `phone` | The customer's phone number | String |
114+
| `purchaseCount` | The number of orders by this customer | Integer |
115+
| `state` | Whether the customer account is `enabled` (user has opted in) or `disabled` | String |
116+
| `tags` | The custom tags [applied to the customer](https://shopify.dev/docs/admin-api/rest/reference/customers/customer) | String |
117+
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | Double |
118+
| `verified_email` (v2) | Whether the customer has verified their email | Boolean |
113119

114120
## Support for Google Analytics destination
115121

@@ -141,36 +147,36 @@ Additional events available through Littledata's [ReCharge connection](https://w
141147

142148
The list below outlines the properties included in the events listed above.
143149

144-
| Property | Description | Property Type |
145-
| -------------------------------------- | ------------------------------------------------------------------------ | ------------- |
146-
| `affiliation` | The affiliation of the order | String |
147-
| `cart_id` | The ID of the Shopify cart | String |
148-
| `checkoutId` | The ID of the checkout session | String |
149-
| `context.uip` | The user's IP address | String |
150-
| `context['Google Analytics'].clientId` | The user's Google Analytics Client ID | String |
151-
| `context['Google Analytics'].geoid` | The user's location | String |
152-
| `coupon` | Comma-separated string of discount coupons used, if applicable | String |
153-
| `currency` | The currency of the order | String |
154-
| `discount` | The discounted amount | Float |
155-
| `email` | Shopify email address, or email submitted on a storefront form | String |
156-
| `order_id` | The ID of the order | String |
157-
| `payment_method` | The payment method chosen for checkout | String |
158-
| `presentment_currency` | The user's local currency | String |
159-
| `presentment_total` | The order total in local currency | String |
160-
| `products` | A list of all the product at that step of the funnel | Array |
161-
| `revenue` | Product revenue (excluding discounts, shipping and tax) * | Float |
162-
| `sent_from` | A unique property to identify events sent by Littledata | String |
163-
| `shipping_method` | The shipping method chosen for checkout | String |
164-
| `shipping` | The shipping cost | Float |
165-
| `step` | The checkout step | Integer |
166-
| `subscription_revenue` | The revenue associated with a [Subscription Event](#subscription-events) | Float |
167-
| `subtotal` | Order total after discounts but before taxes and shipping | Float |
168-
| `tax` | The amount of tax on the order | Float |
169-
| `total` | The total value of the order | Float |
170-
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | String |
150+
| Property | Description | Property Type |
151+
| -------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------- |
152+
| `affiliation` | A comma-seperated list of order tags. Untagged orders use `Shopify` | String |
153+
| `cart_id` | The ID of the Shopify cart | String |
154+
| `checkoutId` | The ID of the checkout session | String |
155+
| `context.uip` | The user's IP address | String |
156+
| `context['Google Analytics'].clientId` | The user's Google Analytics Client ID | String |
157+
| `context['Google Analytics'].geoid` | The user's location | String |
158+
| `coupon` | Comma-separated string of discount coupons used, if applicable | String |
159+
| `currency` | The currency of the order | String |
160+
| `discount` | The discounted amount | Float |
161+
| `email` | Shopify email address, or email submitted on a storefront form | String |
162+
| `order_id` | The ID of the order | String |
163+
| `payment_method` | The payment method chosen for checkout | String |
164+
| `presentment_currency` | The user's local currency | String |
165+
| `presentment_total` | The order total in local currency | String |
166+
| `products` | A list of all the product at that step of the funnel | Array |
167+
| `revenue` | Product revenue (excluding discounts, shipping and tax) \* | Float |
168+
| `sent_from` | A unique property to identify events sent by Littledata | String |
169+
| `shipping_method` | The shipping method chosen for checkout | String |
170+
| `shipping` | The shipping cost | Float |
171+
| `step` | The checkout [step number](https://blog.littledata.io/help/posts/shopify-checkout-funnel-updates/) | Integer |
172+
| `subscription_revenue` | The revenue associated with a [Subscription Event](#subscription-events) | Float |
173+
| `subtotal` | Order total after discounts but before taxes and shipping | Float |
174+
| `tax` | The amount of tax on the order | Float |
175+
| `total` | The total value of the order | Float |
176+
| `userId` | Chosen user identifier, defaulting to Shopify Customer ID | String |
171177

172178
> note ""
173-
> \* `revenue` is available only with the Order Completed event, and only if the store opts in via the Littledata application. Revenue is a reserved property in many Segment destinations. Opting in will override the `total` property sent to Google Analytics.
179+
> *`revenue` is available only with the Order Completed event, and only if the store opts in via the Littledata application. Revenue is a reserved property in many Segment destinations. Opting in will override the `total` property sent to Google Analytics.
174180
175181
## Product properties
176182

@@ -204,7 +210,7 @@ You can edit the LittledataLayer object in your Shopify theme to manually change
204210

205211
### cookiesToTrack
206212

207-
You can send any cookie set on a landing page (for example, a session identifier or marketing campaign name) to Segment with an Identify call. A common use is to pass Iterable `campaignId` and `templateId` through to the [Order Completed event](https://support.iterable.com/hc/en-us/articles/204795719-Sending-Data-from-Segment-to-Iterable-#order-completed).
213+
You can send any cookie set on a landing page (for example, a session identifier or marketing campaign name) to Segment with an Identify call. A common use is to set the array as `['iterableEmailCampaignId', 'iterableTemplateId']` to pass Iterable `campaignId` and `templateId` through to the [Order Completed event](https://support.iterable.com/hc/en-us/articles/204795719-Sending-Data-from-Segment-to-Iterable-#order-completed).
208214

209215
### CDNForAnalyticsJS
210216

0 commit comments

Comments
 (0)