Shogun

This document is a guide for developers. If you do not have access to a developer, please refer to Shogun's list of <a href="https://getshogun.com/help/en/articles/1392229-can-we-hire-someone-at-shogun-to-build-pages-for-us" rel="nofollow noopener noreferrer" target="_blank">recommended partners and services</a>.

Accounts with access to the CMS feature include an external CMS collection named "Shopify Products." This CMS collection pulls various product properties from the store's catalog and makes them available for use in <a href="https://getshogun.com/help/en/articles/1391679-custom-elements-documentation" rel="nofollow noopener noreferrer" target="_blank">Custom Elements</a>.

The following properties are available in this external CMS collection.

Basic details about the <code>product</code> include:

- <code>body_html</code>
- <code>created_at</code>
- <code>handle</code>
- <code>id</code>
- <code>product_type</code>
- <code>published_at</code>
- <code>published_scope</code>
- <code>status</code>
- <code>tags</code>
- <code>template_suffix</code>
- <code>title</code>
- <code>updated_at</code>
- <code>vendor</code>

Values for the main image of the <code>product</code> are available in the <code>image</code> nested object.

- <code>image.alt</code>
- <code>image.height</code>
- <code>image.id</code>
- <code>image.product_id</code>
- <code>image.src</code>
- <code>image.variant_ids</code>
- <code>image.width</code>
   

Values for all of the images that have been uploaded for a <code>product</code> are available in the <code>images</code> nested object.

- <code>images.alt</code>
- <code>images.height</code>
- <code>images.id</code>
- <code>images.position</code>
- <code>images.product_id</code>
- <code>images.src</code>
- <code>images.variant_ids</code>
- <code>images.width</code>
   

The custom <code>metafields</code> of the <code>product</code> are available as a nested object. 

- <code>metafields.key</code>
- <code>metafields.value</code>

<b>Example:</b> <code>{{product.metafields[0].value}}</code> will display the value of the product's first metafield.

<b>Note:</b> In order to display metafield data, Shogun must have permissions at access the metafields in your Shopify account. If you installed Shogun prior to September 27, 2023, you will need to <a href="https://getshogun.com/help/en/articles/8400315-displaying-information-from-shopify-metafields" rel="nofollow noopener noreferrer" target="_blank">update your app permissions</a>. If you installed after September 27, 2023, no further action is needed.

The <code>options</code> of the <code>product</code> are available as a nested object.

- <code>options.id</code>
- <code>options.name</code>
- <code>options.position</code>
- <code>options.product_id</code>
- <code>options.values</code>

The properties of <code>variants</code> for the <code>product</code> are available as a nested object.

<code>variants.fulfillment_service</code>

<code>variants.inventory_management</code>

- <code>variants.barcode</code>
- <code>variants.compare_at_price</code>
- <code>variants.fulfillment_service</code>
- <code>variants.grams</code>
- <code>variants.id</code>
- <code>variants.image_id</code>
- <code>variants.inventory_item_id</code>
- <code>variants.inventory_management</code>
- <code>variants.inventory_policy</code>
- <code>variants.inventory_quantity</code>
- <code>variants.position</code>
- <code>variants.price</code>
- <code>variants.product_id</code>
- <code>variants.requires_shipping</code>
- <code>variants.sku</code>
- <code>variants.taxable</code>
- <code>variants.title</code>
- <code>variants.weight</code>
- <code>variants.weight_unit</code>

___________________________________________________________

<a href="https://getshogun.com/help/en/articles/1391679-custom-elements-documentation" rel="nofollow noopener noreferrer" target="_blank">Custom Elements Documentation</a>

<a href="https://getshogun.com/help/en/articles/7161024-data-collection-properties-for-shopify-collections" rel="nofollow noopener noreferrer" target="_blank">CMS Properties for Shopify Collections</a>

- <a href="https://getshogun.com/help/en/articles/1391679-custom-elements-documentation" rel="nofollow noopener noreferrer" target="_blank">Custom Elements Documentation</a>
- <a href="https://getshogun.com/help/en/articles/7161024-data-collection-properties-for-shopify-collections" rel="nofollow noopener noreferrer" target="_blank">CMS Properties for Shopify Collections</a>

General Product Details

Main Product Image Properties

All Product Images

Product Metafields

Product Options

Product Variants