GuidesAPI ReferenceChangelogDiscussions
Log In

📘

Note

All events include Session Properties, Device Properties, App Properties, and Shopify Properties that are present on the Event Object. For more information, refer to the Common Event Object & Metadata document.

Event Properties, however, are unique to every event and are outlined in this page.

The Checkout Created event fires when the consumer creates a checkout by clicking on the apple pay button (iOS only) or the checkout button.

The event properties unique to this event include:

"event_properties": {
    "source": null,
    "event_id": "2221C411-907B-4EC7-8963-A83B1B9E279A",
    "currency_code": "USD",
    "checkout_type": "webCheckout",
    "checkout_id": "e34695d1332f41abae88bb518c7d283c",
    "checkout_amount": "15.0",
    "checkout_source_type": "cart",
    "checkout_source_id": null,
    "checkout_source_title": null,
    "multi_currency_code": "USD",
    "checkout_total_items": "1",
    "checkout_subtotal": "15.0",
    "checkout_items_list": ["Jeans"],
    "total_discount_amount": "0.0",
    "total_gift_card_amount_applied": "0.0",
    "cart_id": "4431220719679"
  }

event_id String : The unique identifier of the session associated with the event. This event will also exist on the Event object level as well


source String : A value or parameter tracking where the session originated from. The default is "direct"

Note: To view all of the possible sources, reference the Event Sources page


currency_code String : The currency code of the currency associated with the checkout


checkout_type String : The type of payment for checkout (PayPal, Credit Card, Apple Pay, etc.)

Note: To view all of the possible checkout types, reference the Event Sources page


checkout_id String : The Shopify Checkout ID of the checkout event


checkout_amount Float : The total price of the checkout in the user’s respective currency. This will remain the amount due


checkout_source_type String : The source in which a checkout can be initiated

Note: To view all of the possible checkout source types, reference the Event Sources page


checkout_source_id String : The ID of the checkout source. For example, if the checkout source is a PDP, then this will be the ID of that product


checkout_source_title String : The title of the checkout source. For example, if the checkout source is a PDP, then this will be the title of that product


multi_currency_code String : The current currency the user has selected in the app


checkout_total_items Integer : The total number of items in the checkout


checkout_subtotal Float :


checkout_items_list List : The list of product titles in the checkout


total_discount_amount Float : The amount that was taken off the checkout from a discount code


total_gift_card_amount_applied Float : The value from a gift card that was applied to a cart's total.


cart_id String : The Shopify identifier for the current cart state. This identifier changes when a certain cart state expires