Skip to main content
Raw Markdown

Checkout Started - Attribuly SS

Schema

typestringrequired
attributesobjectrequired
Child fields
timestringrequired
valuenumberrequired
value_currencystringrequired
unique_idstringrequired
propertiesobjectrequired
Child fields
Collectionsarray [string]required

Collections

Child fields
string
$currency_codestringrequired
Itemsarray [string]required

Product Name

Child fields
string
Item Countintegerrequired
presentment_currencystringrequired
$valuenumberrequired
Discount Codesarray [string]required
Child fields
string
Total Discountsintegerrequired
$extraobjectrequired
Child fields
full_landing_sitestringrequired
referring_sitestringrequired
checkout_urlstringrequired

Checkout url

responsive_checkout_urlstringrequired
line_itemsarray [object]required
Child fields
keystring
presentment_titlestring
parent_relationshipstring
compare_at_pricenumber

Compare price

line_price_setobject

Line Price

Child fields
shop_moneyobjectrequired
Child fields
amountnumberrequired
presentment_moneyobjectrequired
Child fields
amountnumberrequired
gramsstring
product_idstring

Product Id

line_pricenumber

Line Price

variant_pricenumber

Variant price

variant_idstring

Variant id

vendorstring
quantityinteger

Quantity

pricenumber

Price

skustring

Sku

variant_titlestring

Variant title

presentment_variant_titlestring
titlestring

Product title

productobject
Child fields
body_htmlstringrequired
tagsstringrequired
handlestringrequired
idstringrequired
titlestringrequired
product_typestringrequired
urlstringrequired
vendorstringrequired
imagesarray [object]required
Child fields
srcstring
variantobjectrequired
Child fields
skustringrequired
titlestringrequired
imagesarray [object]required
Child fields
srcstring
idstringrequired
metricobjectrequired
Child fields
dataobjectrequired
Child fields
typestringrequired
attributesobjectrequired
Child fields
namestringrequired
servicestringrequired
profileobjectrequired
Child fields
dataobjectrequired
Child fields
typestringrequired
attributesobjectrequired
Child fields
emailstringrequired
phone_numberstringrequired
first_namestringrequired
last_namestringrequired
locationobjectrequired
Child fields
address1stringrequired
address2stringrequired
citystringrequired
countrystringrequired
regionstringrequired
zipstringrequired
Schema example
JSON
{
  "type": "string",
  "attributes": {
    "time": "string",
    "value": 0,
    "value_currency": "string",
    "unique_id": "string",
    "properties": {
      "Collections": [
        "string"
      ],
      "$currency_code": "string",
      "Items": [
        "string"
      ],
      "Item Count": 0,
      "presentment_currency": "string",
      "$value": 0,
      "Discount Codes": [
        "string"
      ],
      "Total Discounts": 0,
      "$extra": {
        "full_landing_site": "string",
        "referring_site": "string",
        "checkout_url": "string",
        "responsive_checkout_url": "string",
        "line_items": [
          {
            "key": "string",
            "presentment_title": "string",
            "parent_relationship": "string",
            "compare_at_price": 0,
            "line_price_set": {
              "shop_money": {
                "amount": 0
              },
              "presentment_money": {
                "amount": 0
              }
            },
            "grams": "string",
            "product_id": "string",
            "line_price": 0,
            "variant_price": 0,
            "variant_id": "string",
            "vendor": "string",
            "quantity": 0,
            "price": 0,
            "sku": "string",
            "variant_title": "string",
            "presentment_variant_title": "string",
            "title": "string",
            "product": {
              "body_html": "string",
              "tags": "string",
              "handle": "string",
              "id": "string",
              "title": "string",
              "product_type": "string",
              "url": "string",
              "vendor": "string",
              "images": [
                {
                  "src": "string"
                }
              ],
              "variant": {
                "sku": "string",
                "title": "string",
                "images": [
                  {
                    "src": "string"
                  }
                ],
                "id": "string"
              }
            }
          }
        ]
      }
    },
    "metric": {
      "data": {
        "type": "string",
        "attributes": {
          "name": "string",
          "service": "string"
        }
      }
    },
    "profile": {
      "data": {
        "type": "string",
        "attributes": {
          "email": "string",
          "phone_number": "string",
          "first_name": "string",
          "last_name": "string",
          "location": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "country": "string",
            "region": "string",
            "zip": "string"
          }
        }
      }
    }
  }
}