Event

Basic

Checkout

Structure

{
  "attributes": "Optional, array type, represents custom attributes of the order",
  "billingAddress": "Optional, object type, represents billing address information",
  "buyerAcceptsEmailMarketing": "Required, boolean type, indicates whether the buyer accepts email marketing",
  "buyerAcceptsSmsMarketing": "Required, boolean type, indicates whether the buyer accepts SMS marketing",
  "currencyCode": "Required, string type, represents the currency code",
  "delivery": {
    "selectedDeliveryOptions": [
      {
        "cost": {
          "amount": "Required, numeric type, represents the delivery cost amount",
          "currencyCode": "Required, string type, represents the currency code of the delivery cost"
        },
        "costAfterDiscounts": {
          "amount": "Required, numeric type, represents the delivery cost amount after discounts",
          "currencyCode": "Required, string type, represents the currency code of the delivery cost after discounts"
        },
        "description": "Optional, string type, represents the description of the delivery option",
        "handle": "Required, string type, represents the unique identifier of the delivery option",
        "title": "Required, string type, represents the title of the delivery option",
        "type": "Required, string type, represents the type of the delivery option (e.g., shipping)"
      }
    ]
  },
  "discountApplications": "Optional, array type, represents applied discount information",
  "discountsAmount": {
    "amount": "Required, numeric type, represents the total discount amount",
    "currencyCode": "Required, string type, represents the currency code of the total discount"
  },
  "email": "Required, string type, represents the buyer's email address",
  "lineItems": [
    {
      "discountAllocations": "Optional, array type, represents discount information allocated to this item",
      "finalLinePrice": {
        "amount": "Required, numeric type, represents the final price of this item",
        "currencyCode": "Required, string type, represents the currency code of the final price of this item"
      },
      "id": "Required, string type, represents the unique identifier of this item",
      "properties": "Optional, array type, represents custom properties of the item",
      "quantity": "Required, numeric type, represents the quantity of this item",
      "sellingPlanAllocation": "Optional, object type, represents selling plan allocation information",
      "title": "Required, string type, represents the name of the item",
      "variant": {
        "id": "Required, string type, represents the unique identifier of the product variant",
        "image": {
          "src": "Required, string type, represents the URL of the product variant image"
        },
        "price": {
          "amount": "Required, numeric type, represents the price of the product variant",
          "currencyCode": "Required, string type, represents the currency code of the product variant price"
        },
        "product": {
          "id": "Required, string type, represents the unique identifier of the product",
          "title": "Required, string type, represents the name of the product",
          "type": "Optional, string type, represents the type of the product",
          "untranslatedTitle": "Required, string type, represents the untranslated name of the product",
          "url": "Required, string type, represents the URL address of the product",
          "vendor": "Required, string type, represents the vendor of the product"
        },
        "sku": "Required, string type, represents the SKU number of the product variant",
        "title": "Optional, string type, represents the title of the product variant",
        "untranslatedTitle": "Optional, string type, represents the untranslated title of the product variant"
      }
    }
  ],
  "localization": {
    "country": {
      "isoCode": "Required, string type, represents the ISO code of the country"
    },
    "language": {
      "isoCode": "Required, string type, represents the ISO code of the language"
    },
    "market": {
      "handle": "Optional, string type, represents the unique handle of the market",
      "id": "Optional, string type, represents the unique identifier of the market"
    }
  },
  "order": {
    "customer": {
      "id": "Required, string type, represents the unique identifier of the customer",
      "isFirstOrder": "Required, boolean type, indicates whether it is the customer’s first order"
    },
    "id": "Required, string type, represents the unique identifier of the order"
  },
  "phone": "Optional, string type, represents the buyer's phone number",
  "shippingAddress": {
    "address1": "Required, string type, represents the first line of the shipping address",
    "address2": "Optional, string type, represents the second line of the shipping address",
    "city": "Required, string type, represents the city name",
    "country": "Required, string type, represents the country name",
    "countryCode": "Required, string type, represents the country code",
    "firstName": "Required, string type, represents the first name",
    "lastName": "Required, string type, represents the last name",
    "phone": "Optional, string type, represents the contact phone number",
    "province": "Required, string type, represents the province or state name",
    "provinceCode": "Required, string type, represents the province or state code",
    "zip": "Required, string type, represents the postal code"
  },
  "shippingLine": {
    "price": {
      "amount": "Required, numeric type, represents the shipping cost amount",
      "currencyCode": "Required, string type, represents the currency code of the shipping cost"
    }
  },
  "smsMarketingPhone": "Optional, string type, represents the phone number used for SMS marketing",
  "subtotalPrice": {
    "amount": "Required, numeric type, represents the subtotal amount",
    "currencyCode": "Required, string type, represents the currency code of the subtotal amount"
  },
  "token": "Required, string type, represents the unique token of the order",
  "totalPrice": {
    "amount": "Required, numeric type, represents the total amount of the order",
    "currencyCode": "Required, string type, represents the currency code of the total amount of the order"
  },
  "totalTax": {
    "amount": "Required, numeric type, represents the total tax amount",
    "currencyCode": "Required, string type, represents the currency code of the total tax"
  },
  "transactions": [
    {
      "amount": {
        "amount": "Required, numeric type, represents the transaction amount",
        "currencyCode": "Required, string type, represents the currency code of the transaction amount"
      },
      "gateway": "Required, string type, represents the payment gateway name",
      "paymentMethod": {
        "name": "Required, string type, represents the payment method name",
        "type": "Required, string type, represents the payment method type"
      }
    }
  ]
}

Example

{
  "attributes": [],
  "billingAddress": {},
  "buyerAcceptsEmailMarketing": true,
  "buyerAcceptsSmsMarketing": true,
  "currencyCode": "USD",
  "delivery": {
    "selectedDeliveryOptions": [
      {
        "cost": {
          "amount": 20,
          "currencyCode": "USD"
        },
        "costAfterDiscounts": {
          "amount": 20,
          "currencyCode": "USD"
        },
        "description": null,
        "handle": "63c748d13df6f6cdfc41defac6a6ccd0-bd1d02a02f027e28e1c10e83333d65e0",
        "title": "20",
        "type": "shipping"
      }
    ]
  },
  "discountApplications": [],
  "discountsAmount": {
    "amount": 0,
    "currencyCode": "USD"
  },
  "email": "[e-mail]",
  "lineItems": [
    {
      "discountAllocations": [],
      "finalLinePrice": {
        "amount": 4.3,
        "currencyCode": "USD"
      },
      "id": "43661439271125",
      "properties": [],
      "quantity": 1,
      "sellingPlanAllocation": null,
      "title": "ABBOTTS BAKERY SOURDOUGH RYE 760G",
      "variant": {
        "id": "43661439271125",
        "image": {
          "src": "https://cdn.shopify.com/s/files/1/0643/2614/0117/products/AbbottsBakery-SourdoughGrains_Seeds_760g_64x64.webp?v=1664345120"
        },
        "price": {
          "amount": 4.3,
          "currencyCode": "USD"
        },
        "product": {
          "id": "7878527156437",
          "title": "ABBOTTS BAKERY SOURDOUGH RYE 760G",
          "type": "",
          "untranslatedTitle": "ABBOTTS BAKERY SOURDOUGH RYE 760G",
          "url": "/products/abbotts-bakery-sourdough-rye-760g",
          "vendor": "Test-Dmap"
        },
        "sku": "G-03",
        "title": null,
        "untranslatedTitle": ""
      }
    }
  ],
  "localization": {
    "country": {
      "isoCode": "US"
    },
    "language": {
      "isoCode": "en-HK"
    },
    "market": {
      "handle": null,
      "id": null
    }
  },
  "order": {
    "customer": {
      "id": "7298740945109",
      "isFirstOrder": false
    },
    "id": "6045569745109"
  },
  "phone": null,
  "shippingAddress": {
    "address1": "1111 Franklin Avenue",
    "address2": null,
    "city": "Garden City",
    "country": "US",
    "countryCode": "US",
    "firstName": "zhang",
    "lastName": "jie",
    "phone": null,
    "province": "NY",
    "provinceCode": "NY",
    "zip": "11530"
  },
  "shippingLine": {
    "price": {
      "amount": 20,
      "currencyCode": "USD"
    }
  },
  "smsMarketingPhone": null,
  "subtotalPrice": {
    "amount": 4.3,
    "currencyCode": "USD"
  },
  "token": "63c748d13df6f6cdfc41defac6a6ccd0",
  "totalPrice": {
    "amount": 24.3,
    "currencyCode": "USD"
  },
  "totalTax": {
    "amount": 0,
    "currencyCode": "USD"
  },
  "transactions": [
    {
      "amount": {
        "amount": 24.3,
        "currencyCode": "USD"
      },
      "gateway": "bogus",
      "paymentMethod": {
        "name": "BOGUS",
        "type": "creditCard"
      }
    }
  ]
}

Document

Structure

{
  "characterSet": "Required, string type, represents the character encoding of the document",
  "location": {
    "hash": "Optional, string type, represents the fragment identifier in the URL (content after #)",
    "host": "Required, string type, represents the hostname and port number of the URL",
    "hostname": "Required, string type, represents the hostname of the URL",
    "href": "Required, string type, represents the full URL address",
    "origin": "Required, string type, represents the origin of the URL (protocol + host + port)",
    "pathname": "Required, string type, represents the path part of the URL",
    "port": "Optional, string type, represents the port number of the URL",
    "protocol": "Required, string type, represents the protocol part of the URL",
    "search": "Optional, string type, represents the query parameter part of the URL"
  },
  "referrer": "Required, string type, represents the referrer URL of the current page",
  "title": "Required, string type, represents the title of the document"
}

Example

{
  "characterSet": "UTF-8",
  "location": {
    "hash": "",
    "host": "test-xq.myshopify.com",
    "hostname": "test-xq.myshopify.com",
    "href": "https://test-xq.myshopify.com/products/tomato-passata-braised-lamb-shanks-with-mash-and-salsa-verde",
    "origin": "https://test-xq.myshopify.com",
    "pathname": "/products/tomato-passata-braised-lamb-shanks-with-mash-and-salsa-verde",
    "port": "",
    "protocol": "https:",
    "search": ""
  },
  "referrer": "https://test-xq.myshopify.com/collections/other",
  "title": "TOMATO PASSATA BRAISED LAMB SHANKS - WITH MASH AND SALSA VERDE – Test-Dmap"
}

Window

Structure

{
  "innerHeight": "Required, number type, represents the inner height of the window (in pixels)",
  "innerWidth": "Required, number type, represents the inner width of the window (in pixels)",
  "location": {
    "hash": "Optional, string type, represents the fragment identifier in the URL (content after #)",
    "host": "Required, string type, represents the hostname and port number of the URL",
    "hostname": "Required, string type, represents the hostname of the URL",
    "href": "Required, string type, represents the complete URL address",
    "origin": "Required, string type, represents the origin of the URL (protocol + host + port)",
    "pathname": "Required, string type, represents the path part of the URL",
    "port": "Optional, string type, represents the port number of the URL",
    "protocol": "Required, string type, represents the protocol part of the URL",
    "search": "Optional, string type, represents the query parameter part of the URL"
  },
  "origin": "Required, string type, represents the origin information of the page (protocol + host + port)",
  "outerHeight": "Required, number type, represents the height of the entire browser window (including toolbars, etc.)",
  "outerWidth": "Required, number type, represents the width of the entire browser window",
  "pageXOffset": "Required, number type, represents the horizontal scroll offset of the page",
  "pageYOffset": "Required, number type, represents the vertical scroll offset of the page",
  "screen": {
    "height": "Required, number type, represents the height of the screen (in pixels)",
    "width": "Required, number type, represents the width of the screen (in pixels)"
  },
  "screenX": "Required, number type, represents the horizontal position of the window relative to the left side of the screen",
  "screenY": "Required, number type, represents the vertical position of the window relative to the top of the screen",
  "scrollX": "Required, number type, represents the horizontal scroll offset of the page",
  "scrollY": "Required, number type, represents the vertical scroll offset of the page"
}

Example

{
  "innerHeight": 459,
  "innerWidth": 2560,
  "location": {
    "hash": "",
    "host": "test-xq.myshopify.com",
    "hostname": "test-xq.myshopify.com",
    "href": "https://test-xq.myshopify.com/products/tomato-passata-braised-lamb-shanks-with-mash-and-salsa-verde",
    "origin": "https://test-xq.myshopify.com",
    "pathname": "/products/tomato-passata-braised-lamb-shanks-with-mash-and-salsa-verde",
    "port": "",
    "protocol": "https:",
    "search": ""
  },
  "origin": "https://test-xq.myshopify.com",
  "outerHeight": 1392,
  "outerWidth": 2560,
  "pageXOffset": 0,
  "pageYOffset": 0,
  "screen": {
    "height": 1440,
    "width": 2560
  },
  "screenX": 0,
  "screenY": 0,
  "scrollX": 0,
  "scrollY": 0
}

Context

Structure

{
  "document": "Required, object type, represents the document information of the current page",
  "navigator": "Required, object type, represents the browser-related information",
  "window": "Required, object type, represents the information related to the browser window or frame"
}

Example

{
  "document": {},
  "navigator": {},
  "window": {}
}

MailAdress

Structure

{
  "address1": "Required, string type, represents the first line of the address",
  "address2": "Optional, string type, represents the second line of the address (if applicable)",
  "city": "Required, string type, represents the city name",
  "country": "Required, string type, represents the country name",
  "countryCode": "Required, string type, represents the country code",
  "firstName": "Required, string type, represents the first name",
  "lastName": "Required, string type, represents the last name",
  "phone": "Optional, string type, represents the contact phone number (if applicable)",
  "province": "Required, string type, represents the name of the province or state",
  "provinceCode": "Required, string type, represents the code of the province or state",
  "zip": "Required, string type, represents the postal code"
}

Example

{
  "address1": "1111 Franklin Avenue",
  "address2": null,
  "city": "Garden City",
  "country": "US",
  "countryCode": "US",
  "firstName": "zhang",
  "lastName": "jie",
  "phone": null,
  "province": "NY",
  "provinceCode": "NY",
  "zip": "11530"
}