Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Type

Description

boolean

A true or false value or use numbers 0 and 1.

Example: “true”

color

The hexadecimal code for a color including leading # char.

Example: “#fff123”

date

A date in ISO 8601 format without a presumed time zone.

Example: “2021-02-02”

date_time

A date and time in ISO 8601 format without a presumed time zone.

Example: “2021-01-01T12:30:00”

dimension

A number value and a unit. Unit is by default the unit at the Perfion Feature, but can be set via an attribute @ShopifyUnit or the value can be a json string like { "unit": "cm", "value": 25.0 }

Valid unit values: in, ft, yd, mm, cm, m.

Example: 25.0 or { "unit": "cm", "value": 25.0 }

money

A numeric value and a unit for the currency code that matches the store's currency. Unit is by default the unit at the Perfion Feature, but can be set via an attribute @ShopifyUnit or the value can be a json string like { "amount": "5.99", "currency_code": "CAD" }

Valid unit values: currency code in the shop.

Example: 5.99 or { "amount": "5.99", "currency_code": "CAD" }

json

A JSON-formatted string. The json is translatable.

Example: “[{ "k": "v1" }, { "k": "v2" }]”

multi_line_text_field

 

A multi-line text field. The multi_line_text_field is translatable.

Example: “Item list:

Table

Chair”

number_decimal

A number with decimal places in the range of +/-9999999999999.999999999.

Example: “10.4”

number_integer

A whole number in the range of +/-9,007,199,254,740,991.

Example: “10”

rating

A rating measured on a specified scale. This is a JSON-formatted string.

Example: { "value": "3.5", "scale_min": "1.0", "scale_max": "5.0" }

rich_text_field

A rich text field supporting headings, lists, links, bold, and italics as json string. Learn more about rich text formatting. The Title is translatable.

single_line_text_field

 

A single-line text field. The single_line_text_field is translatable.

Example: “Some text”

url

A URL with one of the allowed schemes: https, http, mailto, sms, tel. The url is translatable.

Example: “Start and grow your e-commerce business - 3-Day Free Trial

volume

A number value and a unit. Unit is by default the unit at the Perfion Feature, but can be set via an attribute @ShopifyUnit or the value can be a json string like { "unit": "cm", "value": 25.0 }

Valid unit values: ml, cl, l, m3 (cubic meters), us_fl_oz, us_pt, us_qt, us_gal, imp_fl_oz, imp_pt, imp_qt, imp_gal.

Example: 25.0 or { "unit": "ml", "value": 20.0 }

weight

A number value and a unit. Unit is by default the unit at the Perfion Feature, but can be set via an attribute @ShopifyUnit or the value can be a json string like { "unit": "cm", "value": 25.0 }

Valid unit values: oz, lb, g, kg

Example: 25.0 or { "unit": "ml", "value": 20.0 }

...

Type

Description

page_reference

A reference to a page on the online store. This is a special Shopify URL.

Example: “gid://shopify/OnlineStorePage/1”

product_reference

A reference to a product on the online store. This is a special Shopify URL.

Example: “gid://shopify/Product/1”

variant_reference

A reference to a product variant on the online store. This is a special Shopify URL.

Example: “gid://shopify/ProductVariant/1”

file_reference

A reference to a file on the online store. The file_reference can be mapped as a Field or a Attachment(Url) on Products and Variants.

Field: Use the Shopify Gid e.g. Example: “gid://shopify/MediaImage/123”a Url where Shopify candownload the file. The Url need to have the file name in the last part of the Url like https://filedownload.com/pdf-files/filename.pdf?page=2. The file_reference as field is translatable.

Attachment(Url): Use a Perion File feature to upload files stored in Perfion. The file_reference as attachment is not translatable.

...