Metafield Reference

Full reference for the metafields applied by Submarine to various Shopify objects, for access in Liquid templates and the Shopify Storefront API to support advanced subscription, presale and crowdfunding capabilities.

Overview

As described in the front end integration overview, Submarine augments products and variants with metadata that allow front-end developers to display information to customers and drive behaviour via Liquid or the Storefront API.

A single metafield is attached per experience type in the submarine namespace — for example, product.metafields.submarine.presales contains all product-level information relating to presale campaigns, and product.metafields.submarine.crowdfunding contains all product-level information relating to crowdfunding campaigns.

Presale metafields

Presales product metafields

Information about all presale campaigns a product has been part of, including historical campaigns, is available in a single product.metafields.submarine.presales metafield as a JSON object array.

Each campaign object has the following properties:

Here’s an example JSON value for a product’s presale metafield for a product that has been part of two presale campaigns, one active and one completed:

Presales variant metafields

Variants that have been part of a presale campaign have a variant.metafields.submarine.presales metafield attached that exposes information relevant to that variant within each campaign.

While this metafield is also a JSON value, unlike the product metafield it’s a JSON object that maps Submarine campaign IDs to the variant-specific properties for that campaign.

The properties are:

Here’s an example JSON value for a variant’s presale metafield, assuming it was part of both of the campaigns defined in the product example above:

[
  {
    "019dd22c-7afe-1bfa-3102-d556bddee86a": {
      "limit": 20,
      "reserved": 1
    }
  },
  {
    "01894318-272e-e07c-8779-79e01e72e5e8": {
      "limit": null,
      "reserved": 1
    }
  }
]

Crowdfunding metafields

Crowdfunding product metafields

Information about all crowdfund campaigns a product has been part of, including historical campaigns, is available in a single product.metafields.submarine.crowdfunds metafield as a JSON object array.

Each campaign object has the following properties:

Here’s an example JSON value for a product’s crowdfund metafield for a product that has been part of an Ended: Successful campaign that has not yet allocated inventory (fulfilments are still on Hold):

Crowdfunding variant metafields

Variants that have been part of a crowdfunding campaign have a variant.metafields.submarine.crowdfund metafield attached that exposes information relevant to that variant within each campaign.

While this metafield is also a JSON value, unlike the product metafield it’s a JSON object that maps Submarine campaign IDs to the variant-specific properties for that campaign.

The properties are:

Here’s an example JSON value for a variant’s crowdfund metafield, assuming it was part of both of the campaigns defined in the product example above:

[
  {
    "01884ca2-ed92-faab-e7b9-c66cdc409d78": {
      "reserved": 20
    }
  }
]

Subscription metafields

Subscription variant metafields

Variants that are available for subscription via one or more subscription plan (or that have been available as such in the past) have a variant.metafields.submarine.subscription_plans metafield attached.

This metafield is defined as a Metaobject list that references zero to many Subscription Plan metaobjects.

Here’s an example value for a variant’s subscription plans metafield:

[
  "gid://shopify/Metaobject/51324780862"
]

Both Liquid templates and the Shopify Storefront API support expanding this list of object references to the underlying object definitions — see the Subscription Plan metaobject definition for details on the data exposed there.