OBJECT
LineItem
Line items associated with a cart or order.
link GraphQL Schema definition
- type LineItem implements Node {
- # Adjustments applied to the line item
- Adjustment!] : [
- # The advertisement of the item being purchased.
- Advert @deprecated( reason: "Since this can change after the order is created, you should use the copied values" ) :
- # The advert code captured at the time of invoice creation
- String :
- # The advert id captured at the time of invoice creation
- ID :
- # The advert legacyId captured at the time of invoice creation
- Int :
- # The advert title captured at the time of invoice creation
- String :
- # Brand name for the line item
- String :
- # Commission amount Denominated in cents.
- Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # Commission amount In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String ( :
- # Total commission tax amount for the line item Denominated in cents.
- Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # Total commission tax amount for the line item In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String ( :
- # Commission percentage used to calculate the commission amount
- String :
- # Commission tax rate set in invoice
- Float :
- # The discount applied to the item. Negative value. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The discount applied to the item. Negative value. In string with currency
- # symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- ExternalID!]! : [
- ID! :
- Image :
- Inventory :
- Invoice :
- # Total cost per item. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # Total cost per item. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- Int! :
- # Merchant fee tax rate set in invoice
- Float :
- # Metadata key/values
- Metadatum!]! : [
- # The postage total on the item(s). Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The postage total on the item(s). In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- # Postage tax rate
- Float :
- # The pricing model of the line item
- PricingModelEnum! :
- Int! :
- Int :
- # Quantity that has been dispatched that is available for refund.
- Int! :
- # Deprecated: As of Feb 2021 in favour of shipments field (collection of all
- # associated shipments). Returns the most recent shipment associated with this
- # line item
- Shipment :
- Shipment!] : [
- # Status of the line item. It is suggested to use statusFull
- LineItemStatusEnum! :
- # A fuller featured status that includes shipping statuses
- LineItemStatusFullEnum! :
- # The item subtotal, excluding discounts and postage. Tax is included for tax
- # inclusive marketplaces. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The item subtotal, excluding discounts and postage. Tax is included for tax
- # inclusive marketplaces. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- # Line item tax rate
- Float :
- # The tax on the item. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # The tax on the item. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- # Total cost of the items, which includes subtotals and cost of shipping if
- # applicable. Denominated in cents.
- Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025.
" ) :
- # Total cost of the items, which includes subtotals and cost of shipping if
- # applicable. In string with currency symbol.
- #
- # Arguments
- # currency: Currency in which to display money fields. Defaults
- # to the currency of the marketplace's home country.
- String): String! ( :
- # The product variant that is being purchased.
- Variant @deprecated( reason: "Since this can change after the order is created, you should use the copied values" ) :
- # The variant barcode captured at the time of invoice creation
- String :
- # The variant id captured at the time of invoice creation
- ID :
- # The variant legacyId captured at the time of invoice creation
- Int :
- # The variant description captured at the time of invoice creation
- String :
- # The variant sku captured at the time of invoice creation
- String :
- # The wholesale price of the line item
- Decimal :
- }
link Require by
- InvoiceInvoice items associated with an order.
- InvoiceAmendmentLineItemLine items associated with an invoice amendment.
- LineItemConnectionThe connection type for LineItem.
- LineItemEdgeAn edge in a connection.
- RefundRequestLineItemLine item on a refund request
- ShippedItemQuantity and LineItem which has been shipped as part of a parent Shipment.