Objects

`customer`

Customer variables represent a user's Shopify account information. These variables are refreshed when a customer signs in/out.

Property	Type	Example	Availability
`customer.id`	String	6669141901500	When user is logged in
`customer.firstName`	String	John	When user is logged in

`cart`

Cart variables allow you to access the contents of a customer's current cart. These variables are refreshed in real-time.

Standard Cart Contents

Property	Type	Example	Availability
`cart.items`	Array<Items>	`[ { "quantity", "productId", "variantId", "sellingPlanId", "attributes"}]`	If items are in the cart
`cart.subtotal`	Float	20.45 (Sum of cart items less any applied discounts)	Always
`cart.currency`	String	USD	Always

Cart Items

Property	Type	Example	Availability
`cart.items.quantity`	Integer	1	If items are in the cart
`cart.items.productId`	String	7629735690428	If items are in the cart
`cart.items.variantId`	String	43577520193749	If items are in the cart
`cart.items.sellingPlanId`	String	1039518903	If selling plans are in cart
`cart.items.atttributes`	Array	`[ { "key": "value" } ]`	If attributes are in the cart

`device`

Device variables are distinct to the user's device. If a user gets a new device, or deletes & reinstalls the app, they will receive a new device_id.

Property	Type	Example	Availability
`device.id`	String	D40B48A7-0889-4E76-8946-5EA5EBDD29FF	Always
`device.locale`	String	en_US	Always
`device.windowHeight`	Float	600	Always

`product`

Product variables are distinct to the product that's currently in view on the product detail page (PDP). These variables are refreshed when a user visits a new PDP.

Standard Product Properties

Property	Type	Example	Availability
`product.id`	String	7629735690428	Always
`product.availableForSale`	Boolean	true \| false	Always
`product.compareAtPrice`	Float	20.99	If used
`product.description`	String	Vintage cotton shirt	If used
`product.handle`	String	vintage-shirt	Always
`product.images`	Array	`[ "<https://example.com/image.jpg>" ]`	Always
`product.options`	Array<ProductOption>	`[ { "name": "Color", "values": [ "Black", "Blue" ] } ]`	Always
`product.price`	Float	15.99	Always
`product.tags`	Array	`["Vintage", "Cotton", "New"]`	If used
`product.title`	String	Vintage Tapcart	Always
`product.url`	String	`<https://www.tapcartcustomblocks.com/products/vintage-shirt`>	Always
`product.vendor`	String	Tapcart	If used
`product.selectedVariant`	String	6875079049404
`product.variants`	Array<ProductVariant>	`"variants": [ { "selectedOptions", "id", "price", "title", "isAvailable, "compareAtPrice", "image", "sku" } ]`	Always

Product Option Properties

Property	Type	Example	Availability
`product.ProductOption.name`	String	Color	Always
`product.ProductOption.values`	Array	`['Black', 'Blue']`	Always

Product Variant Properties

Property	Type	Example	Availability
`product.ProductVariant.id`	String	43577520193749	Always
`product.ProductVariant.title`	String	Blue	Always
`product.ProductVariant.image`	String	`<https://example.com/image.jpg`>	Always
`product.ProductVariant.isAvailable`	Boolean	true \| false	Always
`product.ProductVariant.price`	Float	10.99	Always
`product.ProductVariant.compareAtPrice`	Float	20.99	If used
`product.ProductVariant.selectedOptions`	Array<SelectedOption>	`[ { "name": "Color", "value": "Black" } ],`	Always
`product.ProductVariant.sku`	String	12938412	Always

Product Variant Selected Options Properties

Property	Type	Example	Availability
`product.SelectedOption.name`	String	Color	Always
`product.SelectedOption.value`	String	Black	Always

Metafields

Before using a product metafield variable your block, you'll first need to enable metafields for your Tapcart app, and include any specific metafields that your app should have access to.

When referencing a metafield variable in your block, make sure to specify the specific namespace & key you want to retrieve.

Property	Type	Example	Availability
`product.metafields.namespace.key`	Object	`{ "my-namespace": { "my-key": "my-value" } }`	Optional

Full Payload Example

{
  "customer": {
    "id": "779544431",
    "firstName": "John"
  },
  "device": {
    "id": "25679b7e-2348-44da-94ef-e218f6be4586",
    "locale": "en"
  },
  "cart": {
    "items": [
      {
        "quantity": 1,
        "productId": "7629735690428",
        "variantId": "43577520193749",
        "sellingPlanId": "1039518903",
        "attributes": [
          {
            "key": "value"
          }
        ]
      }
    ],
    "appliedDiscounts": ["TEST10"],
    "subtotal": 0,
    "currency": "USD"
  },
  "product": {
    "id": "6875079049404",
    "description": "<p>Vintage cotton Tapcart shirt</p>",
    "options": [
      {
        "name": "Color",
        "values": [
          "Black",
          "Blue"
        ]
      }
    ],
    "handle": "vintage-shirt",
    "tags": [
      "Vintage",
      "Cotton",
      "New"
    ],
    "availableForSale": true,
    "title": "Vintage Tapcart Shirt",
    "price": 55,
    "metafields": {
      "myNamespace1": {
        "myKey1": "myValue1"
      },
      "myNamespace2": {
        "myKey2": "myValue2"
      }
    },
    "compareAtPrice": 100,
    "vendor": "Tapcart",
    "images": [
      "https://assets-global.website-files.com/616f0a7a027baaf59a43390b/616f0a7a027baab7e743396e_full.svg"
    ],
    "selectedVariant": {
      "id": "6875079049404"
    },
    "variants": [
      {
        "selectedOptions": [
          {
            "name": "Color",
            "value": "Black"
          }
        ],
        "id": "40122114900156",
        "price": 55,
        "title": "Vintage Tapcart Shirt",
        "isAvailable": true,
        "compareAtPrice": 100,
        "image": "https://assets-global.website-files.com/616f0a7a027baaf59a43390b/616f0a7a027baab7e743396e_full.svg",
        "sku": "12938412"
      }
    ]
  }
}