Item

Each entry of order.items[]. Reused by every order email template.

Fields

Field Type Notes
uniqueId guid
id string Product id.
token string
name string
description string
price number Base price.
unitPrice number Final computed unit price (variants, discounts and included taxes applied).
totalPrice number unitPrice × quantity.
quantity number
quantityStep number
minQuantity number Optional.
maxQuantity number Optional.
url string
image string
categories string[] Defaults to [].
metadata object Arbitrary merchant metadata.
dimensions object Optional — { weight, width, height, length }.
stock object Optional — stock information.
taxes string[] Names of applicable taxes.
customFields CustomField[]
taxable boolean
shippable boolean
stackable boolean
duplicatable boolean
hasTaxesIncluded boolean
addedOn datetime
fileGuid guid Optional — digital goods.
downloadLink string Optional — digital goods.
alternatePrices map<string, number>
paymentSchedule object Optional — subscriptions.
availablePlans object[] Subscriptions.
selectedPlanId string Subscriptions.
isRecurring / isRecurringV2 / isRecurringV3 boolean Computed.
recurringShipping boolean Optional.

Was this article helpful?