# Glossary 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 ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Properties":{"type":"object","description":"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.","properties":{"id":{"type":"string","description":"The cart ID"},"cart_id":{"type":"string","description":"The associated cart ID"},"error_type":{"type":"string","description":"The type of charge error"},"name":{"type":"string","description":"Fulfillment name"},"note":{"type":"string","description":"The cart notes"},"subscription_id":{"type":"string","description":"The subscription ID"},"checkout_id":{"type":"string","description":"The associated checkout ID"},"create_checkout_url":{"type":"string","format":"uri","description":"A synthetic URL that will create a checkout with the items in the cart."},"first_name":{"type":"string","description":"Customer first name"},"order_interval_frequency":{"type":"string","description":"Order interval frequency (e.g. 30)"},"token":{"type":"string","description":"The checkout token"},"last_name":{"type":"string","description":"Customer last name"},"order_id":{"type":"string","description":"The Shopify order ID"},"order_interval_unit":{"type":"string","description":"Order interval unit (e.g. day)"},"checkout_token":{"type":"string","description":"The checkout token"},"status":{"type":"string","description":"Subscription status"},"cancel_reason":{"type":"string","description":"Cancellation reason"},"email":{"type":"string","format":"email","description":"Customer email on the order"},"payment_gateway":{"type":"string","description":"The payment gateway used"},"state":{"type":"string","description":"Customer account state (enabled/disabled/invited/declined)"},"cancel_reason_comments":{"type":"string","description":"Cancellation reason comments"},"landing_site":{"type":"string","description":"The landing site URL that led to the checkout"},"phone":{"type":"string","description":"Customer phone on the order"},"payment_gateways":{"type":"string","description":"Payment gateways used (array)"},"service":{"type":"string","description":"Fulfillment service"},"user_id":{"type":"string","description":"The user who issued the refund"},"verified_email":{"type":"boolean","description":"Whether the customer has verified their email"},"abandoned_checkout_url":{"type":"string","format":"uri","description":"Shopify URL to resume an abandoned checkout (valid for 3 months)"},"return_id":{"type":"string","description":"The associated return ID"},"tax_exempt":{"type":"number","format":"float","description":"Whether the customer is tax exempt"},"tracking_company":{"type":"string","description":"Tracking company"},"order_status_url":{"type":"string","format":"uri","description":"Shopify order status page URL"},"shipment_status":{"type":"string","description":"Shipment status"},"tax_exemptions":{"type":"number","format":"float","description":"Tax exemptions (array)"},"order_number":{"type":"string","description":"Order number (display)"},"presentment_currency":{"type":"string","description":"Customer presentment currency"},"order_name":{"type":"string","description":"Order name (e.g. #1001)"},"tracking_numbers":{"type":"string","description":"Tracking numbers (array)"},"order_type":{"type":"string","description":"Order type: REGULAR, FIRST_RECURRING, or RECURRING"},"tracking_urls":{"type":"string","format":"uri","description":"Tracking URLs (array)"},"fulfillment_status":{"type":"string","description":"Fulfillment status of the order"},"location_id":{"type":"string","description":"Location ID where the order was placed"},"import":{"type":"boolean","description":"Whether this is an imported (historical) order"},"tags":{"type":"array","items":{"type":"string"},"description":"Order tags"},"cancelled_at":{"type":"string","format":"date-time","description":"ISO-8601 timestamp of when the order was cancelled"}}}}}} ``` ## Event Event-level metadata such as timestamp, event name, and identifiers. ## The Event object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Event":{"type":"object","description":"Event-level metadata such as timestamp, event name, and identifiers.","properties":{"id":{"type":"string","description":"Unique identifier for this event"},"created_at":{"type":"string","format":"date-time","description":"The ISO-8601 for when this event was created"},"timestamp":{"type":"string","format":"date-time","description":"The ISO-8601 for when this event was received"},"app.id":{"type":"string","description":"The app ID that issued this event"},"app.name":{"type":"string","description":"The app name that issued this event"},"source_name":{"type":"string","description":"The source_name that issued this event"},"is_subscription_app":{"type":"boolean","description":"Whether this app ID is a known subscription app"}}}}}} ``` ## Product Enriched product object. Represents a product line item in a cart, order, or product event. ## The Product object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Product":{"type":"object","description":"Enriched product object (IUTSEnrichedProduct). Represents a product line item in a cart, order, or product event.","properties":{"product_id":{"type":"string","description":"Product ID"},"variant_id":{"type":"string","description":"Product Variant ID"},"title":{"type":"string","description":"Product title"},"name":{"type":"string","description":"Product title + variant title"},"sku":{"type":"string","description":"SKU"},"quantity":{"type":"integer","description":"Quantity"},"price.shop":{"type":"number","format":"float","description":"Price in shop currency"},"price.presentment":{"type":"number","format":"float","description":"Price in presentment currency"},"compare_at_price.shop":{"type":"number","format":"float","description":"Compare-at price in shop currency"},"compare_at_price.presentment":{"type":"number","format":"float","description":"Compare-at price in presentment currency"},"total_discounts.shop":{"type":"number","format":"float","description":"Line-total discount in shop currency"},"total_discounts.presentment":{"type":"number","format":"float","description":"Line-total discount in presentment currency"},"line_price.shop":{"type":"number","format":"float","description":"Line price (price * quantity) in shop currency"},"line_price.presentment":{"type":"number","format":"float","description":"Line price (price * quantity) in presentment currency"},"discounted_price.shop":{"type":"number","format":"float","description":"Discounted unit price in shop currency"},"discounted_price.presentment":{"type":"number","format":"float","description":"Discounted unit price in presentment currency"},"currency.shop":{"type":"string","description":"Shop currency code"},"currency.presentment":{"type":"string","description":"Presentment currency code"},"currency.conversion_rate":{"type":"number","description":"Currency conversion rate"},"product_url":{"type":"string","format":"uri","description":"Product URL"},"product_type":{"type":"string","description":"Product type"},"vendor":{"type":"string","description":"Product vendor"},"variant_title":{"type":"string","description":"Variant title"},"handle":{"type":"string","description":"Product handle"},"tags":{"type":"array","items":{"type":"string"},"description":"Product tags"},"image_url":{"type":"string","format":"uri","description":"Product image URL"},"category":{"type":"string","description":"Product category"},"grams":{"type":"integer","description":"Product weight in grams"},"taxable":{"type":"boolean","description":"Whether the product is taxable"},"gift_card":{"type":"boolean","description":"Whether the product is a gift card"},"add_count":{"type":"integer","description":"Number of times added to cart"}}}}}} ``` ## Customer Customer object representing the shopper associated with the event. ## The Customer object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Customer":{"type":"object","description":"Customer object representing the shopper associated with the event.","properties":{"id":{"type":"string","description":"Customer ID"},"note":{"type":"string","description":"Customer Note"},"email":{"type":"string","format":"email","description":"Customer Email"},"first_name":{"type":"string","description":"Customer First name"},"last_name":{"type":"string","description":"Customer Last name"},"phone":{"type":"string","description":"Customer Phone number"},"address.address1":{"type":"string","description":"Customer Address line 1"},"address.address2":{"type":"string","description":"Customer Address line 2"},"address.city":{"type":"string","description":"Customer Address City"},"address.country":{"type":"string","description":"Customer Address Country"},"address.country_code":{"type":"string","description":"Customer Address Country code"},"address.province":{"type":"string","description":"Customer Address Province"},"address.province_code":{"type":"string","description":"Customer Address Province code"},"address.zip":{"type":"string","description":"Customer Address ZIP"},"orders_count":{"type":"integer","description":"Customer's total number of orders"},"total_spent":{"type":"number","format":"float","description":"Customer's total amount spent in your shop"},"tags":{"type":"array","items":{"type":"string"},"description":"Customer's tags"},"verified_email":{"type":"boolean","description":"Customer's Email verification status"},"sms_marketing_consent.state":{"type":"string","description":"Customer's SMS Marketing Consent state"},"sms_marketing_consent.opt_in_level":{"type":"string","description":"Customer's SMS Marketing Opt-in level"},"sms_marketing_consent.consent_updated_at":{"type":"string","format":"date-time","description":"Customer's SMS Marketing Consent update time"},"email_marketing_consent.state":{"type":"string","description":"Customer's Email Marketing Consent state"},"email_marketing_consent.opt_in_level":{"type":"string","description":"Customer's Email Marketing Opt-in level"},"email_marketing_consent.consent_updated_at":{"type":"string","format":"date-time","description":"Customer's Email Marketing Consent update time"},"created_at":{"type":"string","format":"date-time","description":"Customer's creation time"},"updated_at":{"type":"string","format":"date-time","description":"Customer's last update time"}}}}}} ``` ## Address Address object. Used for customer default addresses, billing addresses, shipping addresses, and fulfillment origin and destination addresses. ## The Address object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Address":{"type":"object","description":"Address object. Used for customer default addresses, billing addresses, shipping addresses, and fulfillment origin/destination addresses.","properties":{"address1":{"type":"string","description":"Address line 1"},"address2":{"type":"string","description":"Address line 2"},"city":{"type":"string","description":"City"},"company":{"type":"string","description":"Company"},"country":{"type":"string","description":"Country"},"first_name":{"type":"string","description":"First name"},"last_name":{"type":"string","description":"Last name"},"full_name":{"type":"string","description":"Full name"},"phone":{"type":"string","description":"Phone"},"province":{"type":"string","description":"Province/State"},"province_code":{"type":"string","description":"Province/State code"},"postal_code":{"type":"string","description":"Postal/ZIP code"}}}}}} ``` ## Money Monetary totals broken down by shop and presentment currency. ## The Money object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Money":{"type":"object","description":"Monetary totals broken down by shop and presentment currency.","properties":{"currency.shop":{"type":"string","description":"Shop currency"},"currency.presentment":{"type":"string","description":"Presentment currency"},"currency.conversion_rate":{"type":"number","description":"Currency conversion rate"},"subtotal.shop":{"type":"number","format":"float","description":"Total price of the items before tax and shipping, but with discounts applied in the Shop currency"},"subtotal.presentment":{"type":"number","format":"float","description":"Total price of the items before tax and shipping, but with discounts applied in the Presentment currency"},"total_items.shop":{"type":"number","format":"float","description":"Total price of the items before tax, shipping and discounts in the Shop currency"},"total_items.presentment":{"type":"number","format":"float","description":"Total price of the items before tax, shipping and discounts in the Presentment currency"},"tax.shop":{"type":"number","format":"float","description":"Total tax paid in the Shop currency"},"tax.presentment":{"type":"number","format":"float","description":"Total tax paid in the Presentment currency"},"shipping.shop":{"type":"number","format":"float","description":"Total shipping cost in the Shop currency"},"shipping.presentment":{"type":"number","format":"float","description":"Total shipping cost in the Presentment currency"},"discounts.shop":{"type":"number","format":"float","description":"Total discounts applied in the Shop currency"},"discounts.presentment":{"type":"number","format":"float","description":"Total discounts applied in the Presentment currency"},"total.shop":{"type":"number","format":"float","description":"Total price (subtotal + tax + shipping) in the Shop currency"},"total.presentment":{"type":"number","format":"float","description":"Total price (subtotal + tax + shipping) in the Presentment currency"}}}}}} ``` ## Shop Shop-level metadata about the Shopify store. ## The Shop object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Shop":{"type":"object","description":"Shop-level metadata about the Shopify store.","properties":{"title":{"type":"string","description":"Shop's official title"},"domain":{"type":"string","format":"uri","description":"Shop's public domain"},"shopify_domain":{"type":"string","description":"Shop's shopify domain"},"currency":{"type":"string","description":"Shop's currency"},"country":{"type":"string","description":"Shop's origin country code"}}}}}} ``` ## Market Shopify Markets information for cross-border selling. ## The Market object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Market":{"type":"object","description":"Shopify Markets information for cross-border selling.","properties":{"id":{"type":"string","description":"Market ID"},"handle":{"type":"string","description":"Market handle"}}}}}} ``` ## Context Event context including device, browser, page, campaign, and session metadata. ## The Context object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"Context":{"type":"object","description":"Event context including device, browser, page, campaign, and session metadata.","properties":{"campaign.utm_id":{"type":"string","description":"UTM campaign ID"},"campaign.utm_source":{"type":"string","description":"UTM source"},"campaign.utm_medium":{"type":"string","description":"UTM medium"},"campaign.utm_campaign":{"type":"string","description":"UTM campaign name"},"campaign.utm_term":{"type":"string","description":"UTM term"},"campaign.utm_content":{"type":"string","description":"UTM content"},"ipv4":{"type":"string","description":"Client IPv4 address"},"ipv6":{"type":"string","description":"Client IPv6 address"},"locale":{"type":"string","description":"Client locale"},"country":{"type":"string","description":"Client country ISO code"},"language":{"type":"string","description":"Client language ISO code"},"page.path":{"type":"string","description":"Page path"},"page.referrer":{"type":"string","format":"uri","description":"Page referrer URL"},"page.search":{"type":"string","description":"Page search/query string"},"page.title":{"type":"string","description":"Page title"},"page.url":{"type":"string","format":"uri","description":"Page URL"},"screen.density":{"type":"string","description":"Screen pixel density"},"screen.height":{"type":"string","description":"Screen height"},"screen.width":{"type":"string","description":"Screen width"},"timezone":{"type":"string","description":"TZdata formatted timezone"},"user_agent":{"type":"string","description":"Client User-Agent string"},"client_hints.mobile":{"type":"boolean","description":"Client Hints: is mobile device"},"client_hints.platform":{"type":"string","description":"Client Hints: platform (e.g. Windows, macOS)"},"client_hints.platform_version":{"type":"string","description":"Client Hints: platform version"},"client_hints.architecture":{"type":"string","description":"Client Hints: CPU architecture"},"client_hints.bitness":{"type":"string","description":"Client Hints: CPU bitness"},"client_hints.model":{"type":"string","description":"Client Hints: device model"},"client_hints.wow64":{"type":"boolean","description":"Client Hints: WoW64 emulation"},"client_hints.device_type":{"type":"string","description":"Client Hints: device type"},"client_hints.vendor":{"type":"string","description":"Client Hints: browser vendor"},"user_consent.marketing":{"type":"boolean","description":"User consent: marketing"},"user_consent.analytics":{"type":"boolean","description":"User consent: analytics"},"user_consent.preferences":{"type":"boolean","description":"User consent: preferences"},"user_consent.sale_of_data":{"type":"string","description":"User consent: sale of data"},"market_id":{"type":"string","description":"Shopify Market identifier"},"littledata_id":{"type":"string","description":"Littledata ID"},"shopify_y":{"type":"string","description":"Shopify Y cookie"}}}}}} ``` ## Client IDs Client identifiers from analytics destinations such as GA4 and Meta. ## The ClientId object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"ClientId":{"type":"object","description":"Client identifiers from analytics destinations (GA4, Meta, etc.).","properties":{"google_analytics4.cid":{"type":"string","description":"Google Analytics Client ID"},"google_analytics4.sid":{"type":"string","description":"Google Analytics Session ID"},"facebook.fbp":{"type":"string","description":"Meta CAPI FBP cookie"},"facebook.fbc":{"type":"string","description":"Meta CAPI FBC cookie"},"tiktok.ttp":{"type":"string","description":"TikTok TTP cookie"},"tiktok.ttclid":{"type":"string","description":"TikTok TTCLID cookie"},"pinterest.epik":{"type":"string","description":"Pinterest EPIK cookie"},"klaviyo.exchange_id":{"type":"string","description":"Klaviyo _kx cookie"},"attentive.attentive_id":{"type":"string","description":"Attentive _attentive_id cookie"},"google_ads.gclid":{"type":"string","description":"Google Ads GCLID cookie"},"google_ads.gbraid":{"type":"string","description":"Google Ads GBRAID cookie"},"google_ads.wbraid":{"type":"string","description":"Google Ads WBRAID cookie"},"microsoft.msclkid":{"type":"string","description":"Bing Ads MSCLKID cookie"},"segment.anonymous_id":{"type":"string","description":"Segment Anonymous ID"}}}}}} ``` ## Discount codes Discount code applied to the order. ## The DiscountCode object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"DiscountCode":{"type":"object","description":"Discount code applied to the order.","properties":{"code":{"type":"string","description":"Discount code"},"amount":{"type":"number","format":"float","description":"Discount amount"},"type":{"type":"string","description":"Discount type"}}}}}} ``` ## Note attributes Custom note attribute (key/value pair) attached to the order. ## The NoteAttribute object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"NoteAttribute":{"type":"object","description":"Custom note attribute (key/value pair) attached to the order.","properties":{"name":{"type":"string","description":"Note attribute name"},"value":{"type":"number","format":"float","description":"Note attribute value"}}}}}} ``` ## Shipping lines Shipping line item on the order. ## The ShippingLine object ```json {"openapi":"3.1.0","info":{"title":"Event Customiser Reference","version":"1.0.0"},"components":{"schemas":{"ShippingLine":{"type":"object","description":"Shipping line item on the order.","properties":{"code":{"type":"string","description":"Shipping line code"},"title":{"type":"string","description":"Shipping line title"},"price":{"type":"number","format":"float","description":"Shipping line price"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.littledata.io/event-editor/glossary.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.