Serializer - Product Tracking
  • Getting started
    • Introduction
    • Enable product tracking
    • Add serial numbers and other data to orders
      • Serialize items from the Admin Order page
      • Serialize items via the app (legacy)
    • Add serial numbers to the Shopify POS cart
    • Track items
    • Share item information with customers
      • Shopify notifications and storefront theme
      • Order printer
    • Track custom item information
    • Development API reference
      • Metafields
      • REST API
      • Order printer's Liquid variables and filters
  • Troubleshooting
    • FAQs
    • Known issues & workarounds
      • Handle external order edits
  • Legal
    • Terms of Service
    • Privacy Policy
    • Sub-processors
Powered by GitBook
On this page
  • Order
  • Item fields
  1. Getting started
  2. Development API reference

Metafields

PreviousDevelopment API referenceNextREST API

Last updated 11 days ago

All metafields saved by the app are stored under the "serializer" namespace. Learn more about Shopify .

The data first saved in the app's database is updated in the Shopify metafields. Metafield edits are not synchronised with the database. Therefore, please do not edit or delete the metafields. Please get in touch with me if you wish to sync the metafields with the app's database.

Please only rely on the metafields documented on this page.

The app may populate other metafields for other purposes, e.g. settings. Please do not rely on such metafields, as the shape of the data may change.

Order

Order metafields are stored in JSON format under the "properties" key. When populated, the following fields are available:

Field name
Type
Description

currentTotalTrackable

Integer

It highlights how many items within the order are currently trackable. Note that more items may be stored than currentTotalTrackable due to order edits outside the app. When this value is lower than the number of items stored, a warning appears in the app.

items

Array of items

See the table below for the information about item fields.

Item fields

Field name
Type
Description

lineItemId

Integer

Shopify's numeric line item ID.

productVariantId

Integer

Shopify's numeric product variant ID.

itemId

String

Globally unique item ID generated by the app. It can be used as a serial number.

serialNumber

String or undefined (not populated)

Manually entered serial number

warrantyDuration

Undefined (not populated), null or JSON object containing the following fields:

  • unit - string. Possible values are "day", "month" or "year".

  • value - integer, the minimum value is 1.

It contains a warranty duration for the item.

customFields

Undefined (not populated for the saved items before the "Custom fields" feature release) or an array of JSON objects containing the following fields:

  • key - string. Max length - 30 characters.

  • value - string. Max length - 200 characters.

It contains a list of all custom field values and keys associated with the item.

metafields