OrderLine

Represents order line of particular order.

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

Show more ↓

Fields

OrderLine.id ● ID! non-null scalar

The ID of the object

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

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

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

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

OrderLine.isLinePriceOverridden ● Boolean! non-null scalar

OrderLine.unitPriceOverriddenNote ● String scalar

OrderLine.note ● String scalar

OrderLine.productName ● String! non-null scalar

OrderLine.variantName ● String! non-null scalar

OrderLine.productSku ● String scalar

OrderLine.isShippingRequired ● Boolean! non-null scalar

OrderLine.quantityFulfilled ● Int! non-null scalar

OrderLine.quantityDeclined ● Int! non-null scalar

OrderLine.digitalContentUrl ● DigitalContentUrl object

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.thumbnail ● Image object

The main thumbnail for the ordered product.

OrderLine.thumbnail.size ● Int scalar

Size of thumbnail.

OrderLine.unitPrice ● TaxedMoney object

Price of the single item in the order line.

OrderLine.totalPrice ● TaxedMoney object

Price of the order line.

OrderLine.discountedTotalPrice ● TaxedMoney object

Total price of the line with any discounts applied

OrderLine.variant ● ProductVariant object

A purchased product variant. Note: this field may be null if the variant has been removed from stock at all.

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.allocations ● [Allocation!] list object

List of allocations across warehouses.

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.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

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