For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tracking schema glossary

Full reference for the fields and objects available in the Littledata Event Editor.

Use this glossary to look up the fields and objects available in the Event Editor.

Each section renders from the live OpenAPI specification.

That keeps this reference in sync with the event pipeline.

Properties

Top-level event properties. The fields available depend on the event type.

The properties object

Attributes

Top-level event properties. The fields available depend on the event type. This object lists every property that can appear under properties across all supported events.

create_checkout_urlstring · uriOptional

URL that recreates the items in this event as a new cart and checkout when opened

Example: https://example.com
idstringOptional

ID of the underlying Shopify resource for this event

Example: 5821934567
notestringOptional

Customer note attached to the cart

Example: Leave at front door
abandoned_checkout_urlstring · uriOptional

Shopify URL to resume an abandoned checkout (valid for 3 months)

Example: https://example.com
cart_idstringOptional

Shopify cart ID (cart token) this checkout or order originated from

Example: 5821934567
emailstring · emailOptional

Customer email associated with the checkout

Example: alice@example.com
landing_sitestringOptional

The landing site URL that led to the checkout

Example: https://example.com/products/blue-tshirt
payment_gatewaystringOptional

Payment gateway used at checkout, e.g. shopify_payments

Example: shopify_payments
phonestringOptional

Customer phone number associated with the checkout

Example: +1-555-0123
tokenstringOptional

Shopify checkout token identifying this checkout session

Example: 5821934567
first_namestringOptional

Customer first name

Example: Alice
last_namestringOptional

Customer last name

Example: Smith
presentment_currencystringOptional

Currency the customer is shown prices in, e.g. EUR

Example: EUR
statestringOptional

Customer account state (enabled/disabled/invited/declined)

Example: subscribed
tax_exemptnumber · floatOptional

Whether the customer is tax exempt

Example: 19.99
tax_exemptionsnumber · floatOptional

Shopify tax exemption codes applied to the customer (array)

Example: 19.99
verified_emailbooleanOptional

Whether the customer has verified their email

Example: true
location_idstringOptional

Shopify location ID where the order was processed, mainly set for POS orders

Example: 5821934567
namestringOptional

Fulfillment name, order name plus fulfillment number, e.g. #1001.1

Example: Blue T-shirt / Medium
order_idstringOptional

Shopify order ID this fulfillment or refund belongs to

Example: 5821934567
order_namestringOptional

Order name (e.g. #1001)

Example: #1001
order_numberstringOptional

Order number as displayed to the customer, e.g. 1001

Example: 1001
order_typestringOptional

Littledata order classification: REGULAR (one-off), FIRST_RECURRING (first subscription order) or RECURRING (subscription renewal)

Example: REGULAR
servicestringOptional

Fulfillment service handling the shipment, e.g. manual or a fulfillment app

Example: manual
shipment_statusstringOptional

Shipment tracking status, e.g. in_transit, out_for_delivery or delivered

Example: in_transit
statusstringOptional

Subscription status, e.g. active, paused or cancelled

Example: active
tracking_companystringOptional

Shipping carrier name, e.g. DHL or UPS

Example: UPS
tracking_numbersstringOptional

Tracking numbers (array)

Example: 1Z999AA10123456784
tracking_urlsstring · uriOptional

Tracking URLs (array)

Example: https://example.com
checkout_idstringOptional

Shopify checkout ID this order or refund originated from

Example: 5821934567
checkout_tokenstringOptional

Shopify checkout token the order originated from

Example: abc123def456
fulfillment_statusstringOptional

Order fulfillment status, e.g. fulfilled, partial or unfulfilled

Example: fulfilled
importbooleanOptional

Whether this is an imported (historical) order

Example: true
order_status_urlstring · uriOptional

Shopify order status page URL

Example: https://example.com
payment_gatewaysstringOptional

Payment gateways used on the order (array), e.g. shopify_payments, gift_card

Example: shopify_payments
tagsstring[]Optional

Order tags

Example: ["new","summer"]
cancel_reasonstringOptional

Shopify cancellation reason: customer, fraud, inventory, declined or other

Example: customer
cancelled_atstring · date-timeOptional

ISO-8601 timestamp of when the order was cancelled

Example: 2025-04-15T10:30:00Z
return_idstringOptional

Shopify return ID linked to this refund, if the refund came from a return

Example: 5821934567
user_idstringOptional

Shopify staff user ID that issued the refund

Example: 5821934567
order_interval_frequencystringOptional

Number of interval units between subscription orders, e.g. 30 (used with order_interval_unit)

Example: 30
order_interval_unitstringOptional

Unit of the subscription billing interval, e.g. day, week or month

Example: day
subscription_idstringOptional

Subscription contract ID from the subscription app

Example: 5821934567
cancel_reason_commentsstringOptional

Free-text comments left by the customer when cancelling

Example: Customer requested cancellation
error_typestringOptional

Subscription charge failure type, e.g. card declined

Example: card_declined

The properties object

{
  "create_checkout_url": "https://example.com",
  "id": "5821934567",
  "note": "Leave at front door",
  "abandoned_checkout_url": "https://example.com",
  "cart_id": "5821934567",
  "email": "alice@example.com",
  "landing_site": "https://example.com/products/blue-tshirt",
  "payment_gateway": "shopify_payments",
  "phone": "+1-555-0123",
  "token": "5821934567",
  "first_name": "Alice",
  "last_name": "Smith",
  "presentment_currency": "EUR",
  "state": "subscribed",
  "tax_exempt": 19.99,
  "tax_exemptions": 19.99,
  "verified_email": true,
  "location_id": "5821934567",
  "name": "Blue T-shirt / Medium",
  "order_id": "5821934567",
  "order_name": "#1001",
  "order_number": "1001",
  "order_type": "REGULAR",
  "service": "manual",
  "shipment_status": "in_transit",
  "status": "active",
  "tracking_company": "UPS",
  "tracking_numbers": "1Z999AA10123456784",
  "tracking_urls": "https://example.com",
  "checkout_id": "5821934567",
  "checkout_token": "abc123def456",
  "fulfillment_status": "fulfilled",
  "import": true,
  "order_status_url": "https://example.com",
  "payment_gateways": "shopify_payments",
  "tags": [
    "new",
    "summer"
  ],
  "cancel_reason": "customer",
  "cancelled_at": "2025-04-15T10:30:00Z",
  "return_id": "5821934567",
  "user_id": "5821934567",
  "order_interval_frequency": "30",
  "order_interval_unit": "day",
  "subscription_id": "5821934567",
  "cancel_reason_comments": "Customer requested cancellation",
  "error_type": "card_declined"
}

Event

Event-level metadata such as timestamp, event name, and identifiers.

The event object

Attributes

Event-level metadata such as timestamp, event name, and identifiers.

app_idstringOptional

ID of the Shopify app that generated this event

Example: 5821934567
is_subscription_appbooleanOptional

Whether the event was generated by a known subscription app, e.g. Recharge or Skio

Example: true
app_namestringOptional

Name of the Shopify app that generated this event

Example: Recharge
source_namestringOptional

Shopify source_name of the event, e.g. web, pos, or an app identifier

Example: web
created_atstring · date-timeOptional

ISO-8601 timestamp of when the event was created

Example: 2025-04-15T10:30:00Z
idstringOptional

Unique identifier for this event

Example: 5821934567
timestampstring · date-timeOptional

ISO-8601 timestamp of when the event was received by Littledata

Example: 2025-04-15T10:30:00Z

The event object

{
  "app_id": "5821934567",
  "is_subscription_app": true,
  "app_name": "Recharge",
  "source_name": "web",
  "created_at": "2025-04-15T10:30:00Z",
  "id": "5821934567",
  "timestamp": "2025-04-15T10:30:00Z"
}

Product

Enriched product object. Represents a product line item in a cart, order, or product event.

The products object

Attributes

Enriched product object (IUTSEnrichedProduct). Represents a product line item in a cart, order, or product event.

body_htmlstringOptional

Product description HTML

Example: <p>Soft cotton tee</p>
categorystringOptional

Shopify standard product taxonomy category

Example: Apparel
collectionsstring[]Optional

Collections the product belongs to

Example: ["Summer","Bestsellers"]
compare_at_price.presentmentnumber · floatOptional

Compare-at price in presentment currency

Example: 19.99
compare_at_price.shopnumber · floatOptional

Compare-at price in shop currency

Example: 19.99
currency.conversion_ratenumberOptional

Conversion rate from shop currency to presentment currency

Example: 1
currency.presentmentstringOptional

Presentment currency code

Example: USD
currency.shopstringOptional

Shop currency code

Example: USD
discounted_price.presentmentnumber · floatOptional

Discounted unit price in presentment currency

Example: 19.99
discounted_price.shopnumber · floatOptional

Discounted unit price in shop currency

Example: 19.99
discounts.amount.presentmentnumber · floatOptional

Discount amount in presentment currency

Example: 19.99
discounts.amount.shopnumber · floatOptional

Discount amount in shop currency

Example: 19.99
discounts.titlestringOptional

Discount title

Example: Summer sale
gift_cardbooleanOptional

Whether the product is a gift card

Example: true
gramsintegerOptional

Product weight in grams

Example: 1
handlestringOptional

Product URL handle (slug), e.g. blue-t-shirt

Example: blue-tshirt
image_urlstring · uriOptional

Product image URL

Example: https://example.com
images.altstringOptional

Image alt text

Example: Blue T-shirt
images.heightintegerOptional

Image height

Example: 1080
images.idstringOptional

Image ID

Example: 5821934567
images.positionintegerOptional

Image position

Example: 1
images.product_idstringOptional

Image product ID

Example: 5821934567
images.srcstring · uriOptional

Image source URL

Example: https://example.com
images.thumb_srcstring · uriOptional

Image thumbnail URL

Example: https://example.com
images.variant_idsstring[]Optional

Variant IDs associated with the image

Example: ["5821934567"]
images.widthintegerOptional

Image width

Example: 1920
line_price.presentmentnumber · floatOptional

Line price (price * quantity) in presentment currency

Example: 19.99
line_price.shopnumber · floatOptional

Line price (price * quantity) in shop currency

Example: 19.99
namestringOptional

Product title + variant title

Example: Blue T-shirt / Medium
options.idstringOptional

Product option ID

Example: 5821934567
options.namestringOptional

Product option name

Example: Size
options.positionintegerOptional

Product option position

Example: 1
options.product_idstringOptional

Product option product ID

Example: 5821934567
options.valuesstring[]Optional

Product option values

Example: ["S","M","L"]
price.presentmentnumber · floatOptional

Unit price in presentment currency

Example: 19.99
price.shopnumber · floatOptional

Unit price in shop currency

Example: 19.99
product_idstringOptional

Shopify product ID

Example: 5821934567
product_identifierstringOptional

Product identifier field (SKU, variant ID or product ID) as configured in the destination settings

Example: SKU-001
product_typestringOptional

Product type set in Shopify admin, e.g. T-shirt

Example: Apparel
product_urlstring · uriOptional

Product URL

Example: https://example.com
profit_margin_appliednumber · floatOptional

Profit margin percentage applied to this product (e.g. 0.40 for 40%)

Example: 0.4
profit_value.presentmentnumber · floatOptional

Profit value in presentment currency: (price - total discounts - tax) × quantity × margin

Example: 19.99
profit_value.shopnumber · floatOptional

Profit value in shop currency: (price - total discounts - tax) × quantity × margin

Example: 19.99
propertiesobjectOptional

Custom line item properties added at the cart (key/value pairs, e.g. engraving text)

Example: {"engraving":"Happy Birthday"}
quantityintegerOptional

Number of units of this variant in the line item

Example: 1
skustringOptional

Variant SKU (stock keeping unit)

Example: SKU-001
tagsstring[]Optional

Product tags

Example: ["new","summer"]
taxablebooleanOptional

Whether the product is taxable

Example: true
titlestringOptional

Product title

Example: Blue T-shirt
total_discounts.presentmentnumber · floatOptional

Line-total discount in presentment currency

Example: 19.99
total_discounts.shopnumber · floatOptional

Line-total discount in shop currency

Example: 19.99
variant_idstringOptional

Shopify variant ID

Example: 5821934567
variant_optionsstring[]Optional

Selected option values for the variant, e.g. Size: M, Colour: Blue

Example: ["Size: M","Colour: Blue"]
variant_requires_shippingbooleanOptional

Whether the variant requires shipping

Example: true
variant_titlestringOptional

Variant title

Example: Medium
vendorstringOptional

Product vendor (brand) set in Shopify

Example: Acme
destination_location_idstringOptional

Shopify inventory location ID the items ship to (only populated on checkout events)

Example: 5821934567
metafieldsobjectOptional

Shopify metafields, keyed by namespace and key

Example: {"custom.material":"cotton"}
origin_location_idstringOptional

Shopify inventory location ID the items ship from (only populated on checkout events)

Example: 5821934567
rankintegerOptional

Position of the line item within the checkout, starting at 1 (only populated on checkout events)

Example: 1
tax.presentmentnumber · floatOptional

Line-total tax bundled into price, in presentment currency

Example: 19.99
tax.shopnumber · floatOptional

Line-total tax bundled into price, in shop currency

Example: 19.99
tax_line.positionintegerOptional

Tax line position (only populated on checkout events)

Example: 1
tax_line.pricenumber · floatOptional

Tax line amount (only populated on checkout events)

Example: 19.99
tax_line.ratenumber · floatOptional

Tax line rate as a decimal, e.g. 0.2 for 20% (only populated on checkout events)

Example: 0.2
tax_line.titlestringOptional

Tax line title, e.g. VAT (only populated on checkout events)

Example: VAT
unit_price_measurement.measured_typestringOptional

Unit price measurement type, e.g. VOLUME or WEIGHT (only populated on checkout events)

Example: VOLUME
unit_price_measurement.quantity_unitstringOptional

Unit of the quantity being sold, e.g. ml (only populated on checkout events)

Example: ml
unit_price_measurement.quantity_valuenumberOptional

Quantity value being sold, e.g. 500 (only populated on checkout events)

Example: 500
unit_price_measurement.reference_unitstringOptional

Reference unit for the unit price, e.g. l (only populated on checkout events)

Example: l
unit_price_measurement.reference_valuenumberOptional

Reference value for the unit price, e.g. 1 (only populated on checkout events)

Example: 1

The products object

{
  "body_html": "<p>Soft cotton tee</p>",
  "category": "Apparel",
  "collections": [
    "Summer",
    "Bestsellers"
  ],
  "compare_at_price.presentment": 19.99,
  "compare_at_price.shop": 19.99,
  "currency.conversion_rate": 1,
  "currency.presentment": "USD",
  "currency.shop": "USD",
  "discounted_price.presentment": 19.99,
  "discounted_price.shop": 19.99,
  "discounts.amount.presentment": 19.99,
  "discounts.amount.shop": 19.99,
  "discounts.title": "Summer sale",
  "gift_card": true,
  "grams": 1,
  "handle": "blue-tshirt",
  "image_url": "https://example.com",
  "images.alt": "Blue T-shirt",
  "images.height": 1080,
  "images.id": "5821934567",
  "images.position": 1,
  "images.product_id": "5821934567",
  "images.src": "https://example.com",
  "images.thumb_src": "https://example.com",
  "images.variant_ids": [
    "5821934567"
  ],
  "images.width": 1920,
  "line_price.presentment": 19.99,
  "line_price.shop": 19.99,
  "name": "Blue T-shirt / Medium",
  "options.id": "5821934567",
  "options.name": "Size",
  "options.position": 1,
  "options.product_id": "5821934567",
  "options.values": [
    "S",
    "M",
    "L"
  ],
  "price.presentment": 19.99,
  "price.shop": 19.99,
  "product_id": "5821934567",
  "product_identifier": "SKU-001",
  "product_type": "Apparel",
  "product_url": "https://example.com",
  "profit_margin_applied": 0.4,
  "profit_value.presentment": 19.99,
  "profit_value.shop": 19.99,
  "properties": {
    "engraving": "Happy Birthday"
  },
  "quantity": 1,
  "sku": "SKU-001",
  "tags": [
    "new",
    "summer"
  ],
  "taxable": true,
  "title": "Blue T-shirt",
  "total_discounts.presentment": 19.99,
  "total_discounts.shop": 19.99,
  "variant_id": "5821934567",
  "variant_options": [
    "Size: M",
    "Colour: Blue"
  ],
  "variant_requires_shipping": true,
  "variant_title": "Medium",
  "vendor": "Acme",
  "destination_location_id": "5821934567",
  "metafields": {
    "custom.material": "cotton"
  },
  "origin_location_id": "5821934567",
  "rank": 1,
  "tax.presentment": 19.99,
  "tax.shop": 19.99,
  "tax_line.position": 1,
  "tax_line.price": 19.99,
  "tax_line.rate": 0.2,
  "tax_line.title": "VAT",
  "unit_price_measurement.measured_type": "VOLUME",
  "unit_price_measurement.quantity_unit": "ml",
  "unit_price_measurement.quantity_value": 500,
  "unit_price_measurement.reference_unit": "l",
  "unit_price_measurement.reference_value": 1
}

Cart context

Cart-level context associated with the event.

The cart_context object

Attributes

Products in the cart at the time of the event. Present on add to cart and remove from cart events alongside the individual product being added or removed.

body_htmlstringOptional

Product description HTML

Example: <p>Soft cotton tee</p>
categorystringOptional

Shopify standard product taxonomy category

Example: Apparel
collectionsstring[]Optional

Collections the product belongs to

Example: ["Summer","Bestsellers"]
compare_at_price.presentmentnumber · floatOptional

Compare-at price in presentment currency

Example: 19.99
compare_at_price.shopnumber · floatOptional

Compare-at price in shop currency

Example: 19.99
currency.conversion_ratenumberOptional

Conversion rate from shop currency to presentment currency

Example: 1
currency.presentmentstringOptional

Presentment currency code

Example: USD
currency.shopstringOptional

Shop currency code

Example: USD
discounted_price.presentmentnumber · floatOptional

Discounted unit price in presentment currency

Example: 19.99
discounted_price.shopnumber · floatOptional

Discounted unit price in shop currency

Example: 19.99
discounts.amount.presentmentnumber · floatOptional

Discount amount in presentment currency

Example: 19.99
discounts.amount.shopnumber · floatOptional

Discount amount in shop currency

Example: 19.99
discounts.titlestringOptional

Discount title

Example: Summer sale
gift_cardbooleanOptional

Whether the product is a gift card

Example: true
gramsintegerOptional

Product weight in grams

Example: 1
handlestringOptional

Product URL handle (slug), e.g. blue-t-shirt

Example: blue-tshirt
image_urlstring · uriOptional

Product image URL

Example: https://example.com
images.altstringOptional

Image alt text

Example: Blue T-shirt
images.heightintegerOptional

Image height

Example: 1080
images.idstringOptional

Image ID

Example: 5821934567
images.positionintegerOptional

Image position

Example: 1
images.product_idstringOptional

Image product ID

Example: 5821934567
images.srcstring · uriOptional

Image source URL

Example: https://example.com
images.thumb_srcstring · uriOptional

Image thumbnail URL

Example: https://example.com
images.variant_idsstring[]Optional

Variant IDs associated with the image

Example: ["5821934567"]
images.widthintegerOptional

Image width

Example: 1920
line_price.presentmentnumber · floatOptional

Line price (price * quantity) in presentment currency

Example: 19.99
line_price.shopnumber · floatOptional

Line price (price * quantity) in shop currency

Example: 19.99
namestringOptional

Product title + variant title

Example: Blue T-shirt / Medium
options.idstringOptional

Product option ID

Example: 5821934567
options.namestringOptional

Product option name

Example: Size
options.positionintegerOptional

Product option position

Example: 1
options.product_idstringOptional

Product option product ID

Example: 5821934567
options.valuesstring[]Optional

Product option values

Example: ["S","M","L"]
price.presentmentnumber · floatOptional

Unit price in presentment currency

Example: 19.99
price.shopnumber · floatOptional

Unit price in shop currency

Example: 19.99
product_idstringOptional

Shopify product ID

Example: 5821934567
product_identifierstringOptional

Product identifier field (SKU, variant ID or product ID) as configured in the destination settings

Example: SKU-001
product_typestringOptional

Product type set in Shopify admin, e.g. T-shirt

Example: Apparel
product_urlstring · uriOptional

Product URL

Example: https://example.com
profit_margin_appliednumber · floatOptional

Profit margin percentage applied to this product (e.g. 0.40 for 40%)

Example: 0.4
profit_value.presentmentnumber · floatOptional

Profit value in presentment currency: (price - total discounts - tax) × quantity × margin

Example: 19.99
profit_value.shopnumber · floatOptional

Profit value in shop currency: (price - total discounts - tax) × quantity × margin

Example: 19.99
propertiesobjectOptional

Custom line item properties added at the cart (key/value pairs, e.g. engraving text)

Example: {"engraving":"Happy Birthday"}
quantityintegerOptional

Number of units of this variant in the line item

Example: 1
skustringOptional

Variant SKU (stock keeping unit)

Example: SKU-001
tagsstring[]Optional

Product tags

Example: ["new","summer"]
taxablebooleanOptional

Whether the product is taxable

Example: true
titlestringOptional

Product title

Example: Blue T-shirt
total_discounts.presentmentnumber · floatOptional

Line-total discount in presentment currency

Example: 19.99
total_discounts.shopnumber · floatOptional

Line-total discount in shop currency

Example: 19.99
variant_idstringOptional

Shopify variant ID

Example: 5821934567
variant_optionsstring[]Optional

Selected option values for the variant, e.g. Size: M, Colour: Blue

Example: ["Size: M","Colour: Blue"]
variant_requires_shippingbooleanOptional

Whether the variant requires shipping

Example: true
variant_titlestringOptional

Variant title

Example: Medium
vendorstringOptional

Product vendor (brand) set in Shopify

Example: Acme

The cart_context object

{
  "body_html": "<p>Soft cotton tee</p>",
  "category": "Apparel",
  "collections": [
    "Summer",
    "Bestsellers"
  ],
  "compare_at_price.presentment": 19.99,
  "compare_at_price.shop": 19.99,
  "currency.conversion_rate": 1,
  "currency.presentment": "USD",
  "currency.shop": "USD",
  "discounted_price.presentment": 19.99,
  "discounted_price.shop": 19.99,
  "discounts.amount.presentment": 19.99,
  "discounts.amount.shop": 19.99,
  "discounts.title": "Summer sale",
  "gift_card": true,
  "grams": 1,
  "handle": "blue-tshirt",
  "image_url": "https://example.com",
  "images.alt": "Blue T-shirt",
  "images.height": 1080,
  "images.id": "5821934567",
  "images.position": 1,
  "images.product_id": "5821934567",
  "images.src": "https://example.com",
  "images.thumb_src": "https://example.com",
  "images.variant_ids": [
    "5821934567"
  ],
  "images.width": 1920,
  "line_price.presentment": 19.99,
  "line_price.shop": 19.99,
  "name": "Blue T-shirt / Medium",
  "options.id": "5821934567",
  "options.name": "Size",
  "options.position": 1,
  "options.product_id": "5821934567",
  "options.values": [
    "S",
    "M",
    "L"
  ],
  "price.presentment": 19.99,
  "price.shop": 19.99,
  "product_id": "5821934567",
  "product_identifier": "SKU-001",
  "product_type": "Apparel",
  "product_url": "https://example.com",
  "profit_margin_applied": 0.4,
  "profit_value.presentment": 19.99,
  "profit_value.shop": 19.99,
  "properties": {
    "engraving": "Happy Birthday"
  },
  "quantity": 1,
  "sku": "SKU-001",
  "tags": [
    "new",
    "summer"
  ],
  "taxable": true,
  "title": "Blue T-shirt",
  "total_discounts.presentment": 19.99,
  "total_discounts.shop": 19.99,
  "variant_id": "5821934567",
  "variant_options": [
    "Size: M",
    "Colour: Blue"
  ],
  "variant_requires_shipping": true,
  "variant_title": "Medium",
  "vendor": "Acme"
}

Customer

Customer object representing the shopper associated with the event.

The customer object

Attributes

Customer object representing the shopper associated with the event.

address.address1stringOptional

Customer Address line 1

Example: 123 Main St
address.address2stringOptional

Customer Address line 2

Example: Apt 4
address.citystringOptional

Customer Address City

Example: New York
address.countrystringOptional

Customer Address Country

Example: US
address.country_codestringOptional

Customer address country as a two-letter ISO code, e.g. US

Example: US
address.provincestringOptional

Customer Address Province

Example: NY
address.province_codestringOptional

Customer address province/state code, e.g. CA

Example: NY
address.zipstringOptional

Customer Address ZIP

Example: 10001
created_atstring · date-timeOptional

ISO-8601 timestamp of when the customer account was created

Example: 2025-04-15T10:30:00Z
emailstring · emailOptional

Customer Email

Example: alice@example.com
email_marketing_consent.consent_updated_atstring · date-timeOptional

ISO-8601 timestamp of when the customer last changed their email marketing consent

Example: 2025-04-15T10:30:00Z
email_marketing_consent.opt_in_levelstringOptional

Shopify email marketing opt-in level: SINGLE_OPT_IN, CONFIRMED_OPT_IN or UNKNOWN

Example: single_opt_in
email_marketing_consent.statestringOptional

Email marketing consent state, e.g. SUBSCRIBED, NOT_SUBSCRIBED or UNSUBSCRIBED

Example: subscribed
first_namestringOptional

Customer First name

Example: Alice
idstringOptional

Shopify customer ID

Example: 5821934567
last_namestringOptional

Customer Last name

Example: Smith
notestringOptional

Customer Note

Example: Leave at front door
orders_countintegerOptional

Customer's total number of orders

Example: 1
phonestringOptional

Customer phone number in E.164 format, e.g. +16135551111

Example: +1-555-0123
sms_marketing_consent.consent_updated_atstring · date-timeOptional

ISO-8601 timestamp of when the customer last changed their SMS marketing consent

Example: 2025-04-15T10:30:00Z
sms_marketing_consent.opt_in_levelstringOptional

Shopify SMS marketing opt-in level: SINGLE_OPT_IN, CONFIRMED_OPT_IN or UNKNOWN

Example: single_opt_in
sms_marketing_consent.statestringOptional

SMS marketing consent state, e.g. SUBSCRIBED, NOT_SUBSCRIBED or UNSUBSCRIBED

Example: subscribed
tagsstring[]Optional

Customer tags set in Shopify

Example: ["new","summer"]
total_spentnumber · floatOptional

Customer's total amount spent in your shop

Example: 19.99
updated_atstring · date-timeOptional

ISO-8601 timestamp of when the customer record was last updated

Example: 2025-04-15T10:30:00Z
verified_emailbooleanOptional

Whether the customer has verified their email address

Example: true

The customer object

{
  "address.address1": "123 Main St",
  "address.address2": "Apt 4",
  "address.city": "New York",
  "address.country": "US",
  "address.country_code": "US",
  "address.province": "NY",
  "address.province_code": "NY",
  "address.zip": "10001",
  "created_at": "2025-04-15T10:30:00Z",
  "email": "alice@example.com",
  "email_marketing_consent.consent_updated_at": "2025-04-15T10:30:00Z",
  "email_marketing_consent.opt_in_level": "single_opt_in",
  "email_marketing_consent.state": "subscribed",
  "first_name": "Alice",
  "id": "5821934567",
  "last_name": "Smith",
  "note": "Leave at front door",
  "orders_count": 1,
  "phone": "+1-555-0123",
  "sms_marketing_consent.consent_updated_at": "2025-04-15T10:30:00Z",
  "sms_marketing_consent.opt_in_level": "single_opt_in",
  "sms_marketing_consent.state": "subscribed",
  "tags": [
    "new",
    "summer"
  ],
  "total_spent": 19.99,
  "updated_at": "2025-04-15T10:30:00Z",
  "verified_email": true
}

Address

Address object. Used for customer default addresses, billing addresses, shipping addresses, and fulfillment origin and destination addresses.

The address object

Attributes

Address object. Used for customer default addresses and fulfillment origin/destination addresses.

address1stringOptional

Address line 1

Example: 123 Main St
address2stringOptional

Address line 2

Example: Apt 4
citystringOptional

City

Example: New York
companystringOptional

Company

Example: Acme Inc
countrystringOptional

Country

Example: US
first_namestringOptional

First name

Example: Alice
full_namestringOptional

Full name

Example: Alice Smith
last_namestringOptional

Last name

Example: Smith
phonestringOptional

Phone

Example: +1-555-0123
postal_codestringOptional

Postal/ZIP code

Example: 10001
provincestringOptional

Province/State

Example: NY
province_codestringOptional

Province/State code

Example: NY

The address object

{
  "address1": "123 Main St",
  "address2": "Apt 4",
  "city": "New York",
  "company": "Acme Inc",
  "country": "US",
  "first_name": "Alice",
  "full_name": "Alice Smith",
  "last_name": "Smith",
  "phone": "+1-555-0123",
  "postal_code": "10001",
  "province": "NY",
  "province_code": "NY"
}

Shipping address

Shipping address for the order.

The shipping_address object

Attributes

Shipping address on checkout and order events.

address1stringOptional

Address line 1

Example: 123 Main St
address2stringOptional

Address line 2

Example: Apt 4
citystringOptional

City

Example: New York
companystringOptional

Company

Example: Acme Inc
countrystringOptional

Country

Example: US
first_namestringOptional

First name

Example: Alice
full_namestringOptional

Full name

Example: Alice Smith
last_namestringOptional

Last name

Example: Smith
phonestringOptional

Phone

Example: +1-555-0123
postal_codestringOptional

Postal/ZIP code

Example: 10001
provincestringOptional

Province/State

Example: NY
province_codestringOptional

Province/State code

Example: NY

The shipping_address object

{
  "address1": "123 Main St",
  "address2": "Apt 4",
  "city": "New York",
  "company": "Acme Inc",
  "country": "US",
  "first_name": "Alice",
  "full_name": "Alice Smith",
  "last_name": "Smith",
  "phone": "+1-555-0123",
  "postal_code": "10001",
  "province": "NY",
  "province_code": "NY"
}

Billing address

Billing address for the order.

The billing_address object

Attributes

Billing address on checkout and order events.

address1stringOptional

Address line 1

Example: 123 Main St
address2stringOptional

Address line 2

Example: Apt 4
citystringOptional

City

Example: New York
companystringOptional

Company

Example: Acme Inc
countrystringOptional

Country

Example: US
first_namestringOptional

First name

Example: Alice
full_namestringOptional

Full name

Example: Alice Smith
last_namestringOptional

Last name

Example: Smith
phonestringOptional

Phone

Example: +1-555-0123
postal_codestringOptional

Postal/ZIP code

Example: 10001
provincestringOptional

Province/State

Example: NY
province_codestringOptional

Province/State code

Example: NY

The billing_address object

{
  "address1": "123 Main St",
  "address2": "Apt 4",
  "city": "New York",
  "company": "Acme Inc",
  "country": "US",
  "first_name": "Alice",
  "full_name": "Alice Smith",
  "last_name": "Smith",
  "phone": "+1-555-0123",
  "postal_code": "10001",
  "province": "NY",
  "province_code": "NY"
}

Money

Monetary totals broken down by shop and presentment currency.

The money object

Attributes

Monetary totals broken down by shop and presentment currency.

currency.presentmentstringOptional

Currency the customer was shown at checkout (presentment currency), e.g. EUR

Example: USD
currency.shopstringOptional

Shop's base currency code, e.g. USD

Example: USD
discounts.presentmentnumber · floatOptional

Total discounts applied in the Presentment currency

Example: 19.99
discounts.shopnumber · floatOptional

Total discounts applied in the Shop currency

Example: 19.99
profit_margin_appliednumber · floatOptional

Weighted-average profit margin applied across line items, as a decimal (e.g. 0.40 for 40%).

Example: 0.4
profit_total.presentmentnumber · floatOptional

Profit-optimised total: sum of per-item profit values in the Presentment currency

Example: 19.99
profit_total.shopnumber · floatOptional

Profit-optimised total: sum of per-item profit values in the Shop currency

Example: 19.99
shipping.presentmentnumber · floatOptional

Total shipping cost in the Presentment currency

Example: 19.99
shipping.shopnumber · floatOptional

Total shipping cost in the Shop currency

Example: 19.99
subtotal.presentmentnumber · floatOptional

Total price of the items before tax and shipping, but with discounts applied in the Presentment currency

Example: 19.99
subtotal.shopnumber · floatOptional

Total price of the items before tax and shipping, but with discounts applied in the Shop currency

Example: 19.99
tax.presentmentnumber · floatOptional

Total tax paid in the Presentment currency

Example: 19.99
tax.shopnumber · floatOptional

Total tax paid in the Shop currency

Example: 19.99
total.presentmentnumber · floatOptional

Total price (subtotal + tax + shipping) in the Presentment currency

Example: 19.99
total.shopnumber · floatOptional

Total price (subtotal + tax + shipping) in the Shop currency

Example: 19.99
total_items.presentmentnumber · floatOptional

Total price of the items before tax, shipping and discounts in the Presentment currency

Example: 19.99
total_items.shopnumber · floatOptional

Total price of the items before tax, shipping and discounts in the Shop currency

Example: 19.99

The money object

{
  "currency.presentment": "USD",
  "currency.shop": "USD",
  "discounts.presentment": 19.99,
  "discounts.shop": 19.99,
  "profit_margin_applied": 0.4,
  "profit_total.presentment": 19.99,
  "profit_total.shop": 19.99,
  "shipping.presentment": 19.99,
  "shipping.shop": 19.99,
  "subtotal.presentment": 19.99,
  "subtotal.shop": 19.99,
  "tax.presentment": 19.99,
  "tax.shop": 19.99,
  "total.presentment": 19.99,
  "total.shop": 19.99,
  "total_items.presentment": 19.99,
  "total_items.shop": 19.99
}

Shop

Shop-level metadata about the Shopify store.

The shop object

Attributes

Shop-level metadata about the Shopify store.

countrystringOptional

Shop's origin country code

Example: US
currencystringOptional

Shop's base currency code, e.g. USD

Example: USD
domainstring · uriOptional

Shop's public domain

Example: https://example.com
shopify_domainstringOptional

Shop's myshopify.com domain, e.g. store.myshopify.com

Example: example.myshopify.com
titlestringOptional

Shop name as set in Shopify admin

Example: Blue T-shirt

The shop object

{
  "country": "US",
  "currency": "USD",
  "domain": "https://example.com",
  "shopify_domain": "example.myshopify.com",
  "title": "Blue T-shirt"
}

Market

Shopify Markets information for cross-border selling.

The market object

Attributes

Shopify Markets information for cross-border selling.

handlestringOptional

Shopify Market handle

Example: blue-tshirt
idstringOptional

Shopify Market ID

Example: 5821934567

The market object

{
  "handle": "blue-tshirt",
  "id": "5821934567"
}

Context

Event context including device, browser, page, campaign, and session metadata.

The context object

Attributes

Event context including device, browser, page, campaign, and session metadata.

campaign.utm_campaignstringOptional

UTM campaign name

Example: spring_sale
campaign.utm_contentstringOptional

UTM content

Example: ad_variant_a
campaign.utm_idstringOptional

UTM campaign ID

Example: 5821934567
campaign.utm_mediumstringOptional

UTM medium

Example: cpc
campaign.utm_sourcestringOptional

UTM source

Example: google
campaign.utm_termstringOptional

UTM term

Example: blue tshirt
client_hints.architecturestringOptional

Client Hints: CPU architecture

Example: x86
client_hints.bitnessstringOptional

Client Hints: CPU bitness

Example: 64
client_hints.device_typestringOptional

Client Hints: device type

Example: mobile
client_hints.mobilebooleanOptional

Client Hints: is mobile device

Example: true
client_hints.modelstringOptional

Client Hints: device model

Example: iPhone15,2
client_hints.platformstringOptional

Client Hints: platform (e.g. Windows, macOS)

Example: macOS
client_hints.platform_versionstringOptional

Client Hints: platform version

Example: 14.0.1
client_hints.vendorstringOptional

Client Hints: browser vendor

Example: Acme
client_hints.wow_64booleanOptional

Client Hints: whether the browser runs under Windows 32-on-64 (WoW64) emulation

Example: true
countrystringOptional

Client country as a two-letter ISO code, e.g. US

Example: US
ipv4stringOptional

Client IPv4 address

Example: 192.0.2.42
ipv6stringOptional

Client IPv6 address

Example: 2001:db8::1
languagestringOptional

Client language ISO code

Example: en
littledata_idstringOptional

Littledata's persistent client ID for this visitor

Example: 5821934567
localestringOptional

Client locale

Example: en-US
page.pathstringOptional

Page path

Example: /products/blue-tshirt
page.referrerstring · uriOptional

Page referrer URL

Example: https://example.com
page.searchstringOptional

Page search/query string

Example: ?utm_source=google
page.titlestringOptional

Page title

Example: Blue T-shirt
page.urlstring · uriOptional

Page URL

Example: https://example.com
screen.densitystringOptional

Screen pixel density

Example: 2
screen.heightstringOptional

Screen height

Example: 1080
screen.widthstringOptional

Screen width

Example: 1920
shopify_ystringOptional

Shopify _shopify_y cookie, Shopify's anonymous visitor ID

Example: 5821934567
timezonestringOptional

Client timezone in IANA tzdata format, e.g. Europe/London

Example: America/New_York
user_agentstringOptional

Client User-Agent string

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
consent.analyticsbooleanOptional

Whether the visitor granted consent for analytics tracking

Example: true
consent.marketingbooleanOptional

Whether the visitor granted consent for marketing

Example: true
consent.preferencesbooleanOptional

Whether the visitor granted consent for preferences/personalisation

Example: true
consent.sale_of_datastringOptional

Whether the visitor allowed the sale or sharing of their data (US state privacy laws)

Example: denied

The context object

{
  "campaign.utm_campaign": "spring_sale",
  "campaign.utm_content": "ad_variant_a",
  "campaign.utm_id": "5821934567",
  "campaign.utm_medium": "cpc",
  "campaign.utm_source": "google",
  "campaign.utm_term": "blue tshirt",
  "client_hints.architecture": "x86",
  "client_hints.bitness": "64",
  "client_hints.device_type": "mobile",
  "client_hints.mobile": true,
  "client_hints.model": "iPhone15,2",
  "client_hints.platform": "macOS",
  "client_hints.platform_version": "14.0.1",
  "client_hints.vendor": "Acme",
  "client_hints.wow_64": true,
  "country": "US",
  "ipv4": "192.0.2.42",
  "ipv6": "2001:db8::1",
  "language": "en",
  "littledata_id": "5821934567",
  "locale": "en-US",
  "page.path": "/products/blue-tshirt",
  "page.referrer": "https://example.com",
  "page.search": "?utm_source=google",
  "page.title": "Blue T-shirt",
  "page.url": "https://example.com",
  "screen.density": "2",
  "screen.height": "1080",
  "screen.width": "1920",
  "shopify_y": "5821934567",
  "timezone": "America/New_York",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
  "consent.analytics": true,
  "consent.marketing": true,
  "consent.preferences": true,
  "consent.sale_of_data": "denied"
}

Client IDs

Client identifiers from analytics destinations such as GA4 and Meta.

The client_id object

Attributes

Client identifiers from analytics destinations (GA4, Meta, etc.).

attentive.attentive_idstringOptional

Attentive _attentive_id cookie, Attentive's visitor ID

Example: 5821934567
facebook.fbcstringOptional

Meta _fbc cookie holding the Facebook click ID (fbclid), used for Meta CAPI event matching

Example: fb.1.1554763741205.AbCdEfGhIjKlMnOp
facebook.fbpstringOptional

Meta _fbp cookie, Meta's anonymous browser ID used for Meta CAPI event matching

Example: fb.1.1554763741205.234567890
google_ads.gbraidstringOptional

Google Ads gbraid click ID, the privacy-safe click identifier for iOS app campaigns

Example: 0AAAAA...
google_ads.gclidstringOptional

Google Ads gclid click ID, used for ad click attribution and offline conversion matching

Example: Cj0KCQjw...
google_ads.wbraidstringOptional

Google Ads wbraid click ID, the privacy-safe click identifier for iOS web campaigns

Example: 0AAAAB...
google_analytics4.client_idstringOptional

Google Analytics 4 client ID, from the _ga cookie

Example: GA1.2.123456789.1234567890
google_analytics4.session_countstringOptional

GA4 session count for this client, from the ga cookie

Example: 3
google_analytics4.session_idstringOptional

GA4 session ID from the ga cookie, used to stitch server-side events into the session

Example: 1234567890
klaviyo.exchange_idstringOptional

Klaviyo _kx cookie (exchange ID) identifying the Klaviyo profile

Example: 5821934567
microsoft.msclkidstringOptional

Microsoft Advertising msclkid click ID, used for UET conversion matching

Example: abcdef1234567890abcdef1234567890
pinterest.epikstringOptional

Pinterest _epik cookie holding the Pinterest click ID, used for Pinterest API matching

Example: dj0yJnU9...
segment.anonymous_idstringOptional

Segment anonymousId, from the ajs_anonymous_id cookie

Example: 5821934567
tiktok.ttclidstringOptional

TikTok ttclid click ID, used for TikTok Events API matching

Example: E.C.P.AbCdEfGhIj
tiktok.ttpstringOptional

TikTok _ttp cookie, TikTok's browser ID used for TikTok Events API matching

Example: 01HXXXX

The client_id object

{
  "attentive.attentive_id": "5821934567",
  "facebook.fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOp",
  "facebook.fbp": "fb.1.1554763741205.234567890",
  "google_ads.gbraid": "0AAAAA...",
  "google_ads.gclid": "Cj0KCQjw...",
  "google_ads.wbraid": "0AAAAB...",
  "google_analytics4.client_id": "GA1.2.123456789.1234567890",
  "google_analytics4.session_count": "3",
  "google_analytics4.session_id": "1234567890",
  "klaviyo.exchange_id": "5821934567",
  "microsoft.msclkid": "abcdef1234567890abcdef1234567890",
  "pinterest.epik": "dj0yJnU9...",
  "segment.anonymous_id": "5821934567",
  "tiktok.ttclid": "E.C.P.AbCdEfGhIj",
  "tiktok.ttp": "01HXXXX"
}

Discount codes

Discount code applied to the order.

The discount_codes object

Attributes

Discount code applied to the order.

amountnumber · floatOptional

Discount amount

Example: 19.99
codestringOptional

Discount code

Example: SUMMER10
typestringOptional

Discount type: percentage, fixed_amount or shipping

Example: shopify

The discount_codes object

{
  "amount": 19.99,
  "code": "SUMMER10",
  "type": "shopify"
}

Note attributes

Custom note attribute (key/value pair) attached to the order.

The note_attributes object

Attributes

Custom note attribute (key/value pair) attached to the order.

__ld_attrstringOptional

Internal Littledata note attribute holding the visitor's session and attribution data as JSON

Example: {"ga_session_id":"1234567890"}
namestringOptional

Name of the order note attribute (Shopify cart attribute)

Example: Blue T-shirt / Medium
valuenumber · floatOptional

Value of the order note attribute

Example: 19.99

The note_attributes object

{
  "__ld_attr": "{\"ga_session_id\":\"1234567890\"}",
  "name": "Blue T-shirt / Medium",
  "value": 19.99
}

Shipping lines

Shipping line item on the order.

The shipping_lines object

Attributes

Shipping line item on the order.

codestringOptional

Shipping rate code, e.g. STANDARD

Example: SUMMER10
pricenumber · floatOptional

Shipping line price

Example: 19.99
titlestringOptional

Shipping rate name shown to the customer, e.g. Standard Shipping

Example: Blue T-shirt

The shipping_lines object

{
  "code": "SUMMER10",
  "price": 19.99,
  "title": "Blue T-shirt"
}

Last updated

Was this helpful?