OrderLine

Represents order line of particular order.

type OrderLine implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  note: String
  unitPriceOverriddenNote: String
  externalId: String
  externalSource: String
  externalInventoryId: String
  isLinePriceOverridden: Boolean!
  productName: String!
  variantName: String!
  productSku: String
  isShippingRequired: Boolean!
  quantity: Int!
  quantityFulfilled: Int!
  quantityDeclined: Int!
  currency: String!
  unitPriceNetAmount: Decimal!
  unitPriceGrossAmount: Decimal!
  totalPriceNetAmount: Decimal!
  totalPriceGrossAmount: Decimal!
  sourceToDomiciledRate: Decimal
  domiciledToTransactionRate: Decimal
  vatCode: String!
  quantityOrdered: Int!
  unfulfilledQuantityRefunded: Int!
  fulfilledQuantityRefunded: Int!
  unitPrice: TaxedMoney!
  totalPrice: TaxedMoney!
  discountedTotalPrice: TaxedMoney!
  order: Order!
  nauticalOrderLine: NauticalOrderLine!
  variant: ProductVariant
  allocations: [Allocation!]!
  translatedProductName: String!
  translatedVariantName: String!
  thumbnail(
    size: Int
  ): Image
  digitalContentUrl: DigitalContentUrl
}

Show more ↓

Fields

OrderLine.id ● ID! non-null scalar

The Globally Unique ID of this object

OrderLine.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

OrderLine.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires proper staff permissions to access.

OrderLine.note ● String scalar

Note for this line item.

OrderLine.unitPriceOverriddenNote ● String scalar

Note explaining the price override.

OrderLine.externalId ● String scalar

OrderLine.externalSource ● String scalar

OrderLine.externalInventoryId ● String scalar

OrderLine.isLinePriceOverridden ● Boolean! non-null scalar

OrderLine.productName ● String! non-null scalar

OrderLine.variantName ● String! non-null scalar

OrderLine.productSku ● String scalar

OrderLine.isShippingRequired ● Boolean! non-null scalar

OrderLine.quantity ● Int! non-null scalar

OrderLine.quantityFulfilled ● Int! non-null scalar

OrderLine.quantityDeclined ● Int! non-null scalar

OrderLine.currency ● String! non-null scalar

OrderLine.unitPriceNetAmount ● Decimal! non-null scalar

OrderLine.unitPriceGrossAmount ● Decimal! non-null scalar

OrderLine.totalPriceNetAmount ● Decimal! non-null scalar

OrderLine.totalPriceGrossAmount ● Decimal! non-null scalar

OrderLine.sourceToDomiciledRate ● Decimal scalar

Rate (multiplier) that is used for conversion source to domiciled prices.

OrderLine.domiciledToTransactionRate ● Decimal scalar

Rate (multiplier) that is used for conversion domiciled to transaction prices.

OrderLine.vatCode ● String! non-null scalar

OrderLine.quantityOrdered ● Int! non-null scalar

The number of items ordered on this order line.

OrderLine.unfulfilledQuantityRefunded ● Int! non-null scalar

The number of unfulfilled items refunded on this order line.

OrderLine.fulfilledQuantityRefunded ● Int! non-null scalar

The number of fulfilled items refunded on this order line.

OrderLine.unitPrice ● TaxedMoney! non-null object

Price of the single item in the order line.

OrderLine.totalPrice ● TaxedMoney! non-null object

Price of the order line.

OrderLine.discountedTotalPrice ● TaxedMoney! non-null object

Total price of the line with any discounts applied.

OrderLine.order ● Order! non-null object

The seller order for this line.

OrderLine.nauticalOrderLine ● NauticalOrderLine! non-null object

The nautical order line for this seller order line.

OrderLine.variant ● ProductVariant object

A purchased product variant.

OrderLine.allocations ● [Allocation!]! non-null object

List of allocations across warehouses.

OrderLine.translatedProductName ● String! non-null scalar

Product name in the customer's language.

OrderLine.translatedVariantName ● String! non-null scalar

Variant name in the customer's language.

OrderLine.thumbnail ● Image object

The main thumbnail for the ordered product.

OrderLine.thumbnail.size ● Int scalar

OrderLine.digitalContentUrl ● DigitalContentUrl object

Digital content URL for this order line (if digital product).

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Member Of

CustomerEvent object ● DraftOrderLineDelete object ● DraftOrderLinePriceOverride object ● DraftOrderLinesCreate object ● DraftOrderLineUpdate object ● FulfillmentLine object ● JournalEntry object ● NauticalOrder object ● NauticalOrderLine object ● Order object ● OrderEventOrderLineObject object ● OrderLineAddNote object

Implemented By

RefundScope union