Skip to main content

CustomerOrderItem

One line of an order.

type CustomerOrderItem {
acceptAlternativeIfUnavailable: Boolean!
customFields: JSON
discountAmount: Float!
discountAmountMoney: AppMoney
discountPercent: Float!
id: ID!
lineTotal: Float!
lineTotalMoney: AppMoney
productName: String!
quantity: Float!
sku: String
taxAmount: Float!
taxAmountMoney: AppMoney
taxRate: Float!
unitPrice: Float!
unitPriceMoney: AppMoney
uom: String
variantName: String
}

Fields​

CustomerOrderItem.acceptAlternativeIfUnavailable ● Boolean! non-null scalar​

True when the buyer agreed that a substitute chosen by staff may ship if the item becomes unavailable.

CustomerOrderItem.customFields ● JSON scalar​

The organization's own fields on this order line that the buyer may see, keyed by field key.

CustomerOrderItem.discountAmount ● Float! non-null scalar​

The discount on the line. 0 when none applies.

CustomerOrderItem.discountAmountMoney ● AppMoney object​

The line's discount as { amount, currencyCode }. The Storefront API reads money only through these fields.

CustomerOrderItem.discountPercent ● Float! non-null scalar​

The discount on the line, in percent. 0 when none applies.

CustomerOrderItem.id ● ID! non-null scalar​

The unique ID of this record.

CustomerOrderItem.lineTotal ● Float! non-null scalar​

The line total, including tax: the amount after discount plus taxAmount. Contrast the cart bill line's lineTotal, which is net of discount and before tax.

CustomerOrderItem.lineTotalMoney ● AppMoney object​

The line total as { amount, currencyCode }. The Storefront API reads money only through these fields.

CustomerOrderItem.productName ● String! non-null scalar​

The name of the product.

CustomerOrderItem.quantity ● Float! non-null scalar​

The quantity ordered.

CustomerOrderItem.sku ● String scalar​

The SKU of the variant.

CustomerOrderItem.taxAmount ● Float! non-null scalar​

The tax on the line. 0 when tax-exempt.

CustomerOrderItem.taxAmountMoney ● AppMoney object​

The line's tax as { amount, currencyCode }. The Storefront API reads money only through these fields.

CustomerOrderItem.taxRate ● Float! non-null scalar​

The tax rate on the line, in percent. 0 when tax-exempt.

CustomerOrderItem.unitPrice ● Float! non-null scalar​

The list price of one unit, before discount (the discount is separate: see discountAmount). Contrast the cart bill line's unitPrice, which is the discounted price before tax.

CustomerOrderItem.unitPriceMoney ● AppMoney object​

The line's unit price as { amount, currencyCode }. The Storefront API reads money only through these fields.

CustomerOrderItem.uom ● String scalar​

The unit of measure.

CustomerOrderItem.variantName ● String scalar​

The name of the variant, for example a model and colour.

Member Of​

CustomerOrderDetail object