Skip to main content

OrderLine

Represents order line of particular order.

type OrderLine implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  productName: String!
  variantName: String!
  productSku: String
  productVariantId: String
  isShippingRequired: Boolean!
  quantity: Int!
  quantityFulfilled: Int!
  unitDiscountReason: String
  taxRate: Float!
  digitalContentUrl: DigitalContentUrl
  thumbnail(size: Int, format: ThumbnailFormatEnum = ORIGINAL): Image
  unitPrice: TaxedMoney!
  undiscountedUnitPrice: TaxedMoney!
  unitDiscount: Money!
  unitDiscountValue: PositiveDecimal!
  totalPrice: TaxedMoney!
  variant: ProductVariant
  translatedProductName: String!
  translatedVariantName: String!
  allocations: [Allocation!]
  quantityToFulfill: Int!
  unitDiscountType: DiscountValueTypeEnum
  taxClass: TaxClass
  taxClassName: String
  taxClassMetadata: [MetadataItem!]!
  taxClassPrivateMetadata: [MetadataItem!]!
}

Fields​

OrderLine.id ● ID! non-null scalar​

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

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

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.

OrderLine.privateMetafield ● String scalar​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.
OrderLine.privateMetafield.key ● String! non-null scalar​

OrderLine.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.
OrderLine.privateMetafields.keys ● [String!] list scalar​

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

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

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.

OrderLine.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.
OrderLine.metafield.key ● String! non-null scalar​

OrderLine.metafields ● Metadata scalar​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.5
This API is currently in Feature Preview and can be subject to changes at later point.
OrderLine.metafields.keys ● [String!] list scalar​

OrderLine.productName ● String! non-null scalar​

OrderLine.variantName ● String! non-null scalar​

OrderLine.productSku ● String scalar​

OrderLine.productVariantId ● String scalar​

OrderLine.isShippingRequired ● Boolean! non-null scalar​

OrderLine.quantity ● Int! non-null scalar​

OrderLine.quantityFulfilled ● Int! non-null scalar​

OrderLine.unitDiscountReason ● String scalar​

OrderLine.taxRate ● Float! non-null scalar​

OrderLine.digitalContentUrl ● DigitalContentUrl object​

OrderLine.thumbnail ● Image object​

OrderLine.thumbnail.size ● Int scalar​

Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).

OrderLine.thumbnail.format ● ThumbnailFormatEnum enum​

The format of the image. When not provided, format of the original image will be used.

Added in Saleor 3.6

OrderLine.unitPrice ● TaxedMoney! non-null object​

Price of the single item in the order line.

OrderLine.undiscountedUnitPrice ● TaxedMoney! non-null object​

Price of the single item in the order line without applied an order line discount.

OrderLine.unitDiscount ● Money! non-null object​

The discount applied to the single order line.

OrderLine.unitDiscountValue ● PositiveDecimal! non-null scalar​

Value of the discount. Can store fixed value or percent value

OrderLine.totalPrice ● TaxedMoney! non-null object​

Price of the order line.

OrderLine.variant ● ProductVariant object​

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

Requires one of the following permissions to include the unpublished items: MANAGE_ORDERSMANAGE_DISCOUNTSMANAGE_PRODUCTS

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.

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

OrderLine.quantityToFulfill ● Int! non-null scalar​

A quantity of items remaining to be fulfilled.

Added in Saleor 3.1

OrderLine.unitDiscountType ● DiscountValueTypeEnum enum​

Type of the discount: fixed or percent

OrderLine.taxClass ● TaxClass object​

Denormalized tax class of the product in this order line.

Added in Saleor 3.9
Requires one of the following permissions: AUTHENTICATED_STAFF_USERAUTHENTICATED_APP

OrderLine.taxClassName ● String scalar​

Denormalized name of the tax class.

Added in Saleor 3.9

OrderLine.taxClassMetadata ● [MetadataItem!]! non-null object​

Denormalized public metadata of the tax class.

Added in Saleor 3.9

OrderLine.taxClassPrivateMetadata ● [MetadataItem!]! non-null object​

Denormalized private metadata of the tax class. Requires staff permissions to access.

Added in Saleor 3.9

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

CustomerEvent object ● FulfillmentLine object ● Order object ● OrderEventOrderLineObject object ● OrderLineDelete object ● OrderLineDiscountRemove object ● OrderLineDiscountUpdate object ● OrderLinesCreate object ● OrderLineUpdate object

Implemented by​

TaxSourceLine union

Was this page helpful?