Metafields
All metafields saved by the app are stored under the "serializer" namespace. Learn more about Shopify metafields.
Product variant
Product variant metafields are stored in JSON format under the "properties" key. When populated, the following fields are available:
trackable
Boolean
It informs whether the product variant is trackable or not. The field is mapped from the "Track items" checkbox in the app.
autoGeneratable
Boolean
It informs whether new items can be automatically generated with unique item IDs and default warranty durations when an order is created.
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 default warranty duration for the product variant items. Note that each item's warrantyDuration can be overridden.
customFields
Undefined (not populated for the saved products before the "Custom fields" feature release) or an array of JSON objects containing the following fields:
key - string.
trackable - boolean.
It contains information on which custom fields are trackable for the respective product variant. The field's key is mapped from the "Key" input field on the "Settings" page within the app. Whereas trackable value is mapped from the "Track <custom field name>" checkbox in the app.
Order
Order metafields are stored in JSON format under the "properties" key. When populated, the following fields are available:
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:
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. The app only enforces uniqueness per line item. Theoretically, different manufacturers could be using the same serial number for different products.
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.
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.
Last updated