INPUT_OBJECT

LineItemInput

Line items associated with a cart or order.

link GraphQL Schema definition

  • input LineItemInput {
  • # ID of the variant to become a line item.
  • variantId: ID!
  • # ID of the inventory for this line item/variant.The variant associated with this
  • # inventory must match `variantId`
  • inventoryId: ID
  • # Quantity of this item to be associated with the given order.
  • quantity: Int!
  • # Deprecated as of March 2022, please use the cost input. Total cost of the item,
  • # which includes subtotals but excludes shipping (postage). Denominated in cents.
  • # Please ensure that the amount entered is equal to the Line Item Unit Price x
  • # Quantity
  • totalCents: Int
  • # Deprecated as of March 2022, please use the postage input. Total cost of
  • # shipping the item. Denominated in cents.
  • postageCents: Int
  • # IDs used by external systems to fetch LineItems
  • externalIds: [KeyValueInput!]
  • # Metadata key/value pairs {external_shipment_id: "SHIP111"}
  • metadata: [KeyValueInput!]
  • # Total cost of shipping the item.
  • postage: MoneyInputField
  • # Total cost of the item, which includes subtotals but excludes shipping
  • # (postage). Please ensure that the amount entered is equal to the Line Item Unit
  • # Price x Quantity
  • cost: MoneyInputField
  • # Adjustments to be applied to the line item.
  • adjustments: [AdjustmentInput!]
  • # Delivery type.
  • deliveryType: DeliveryTypeEnum
  • }