Skip to main content
Version: 3.x

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): Image
unitPrice: TaxedMoney!
undiscountedUnitPrice: TaxedMoney!
unitDiscount: Money!
unitDiscountValue: PositiveDecimal!
totalPrice: TaxedMoney!
variant: ProductVariant
translatedProductName: String!
translatedVariantName: String!
allocations: [Allocation!]
quantityToFulfill: Int!
unitDiscountType: DiscountValueTypeEnum
}

Fields

id (ID!)

privateMetadata ([MetadataItem!]!)

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

privateMetafield (String)

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

privateMetafields (Metadata)

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.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metadata ([MetadataItem!]!)

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

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

productName (String!)

variantName (String!)

productSku (String)

productVariantId (String)

isShippingRequired (Boolean!)

quantity (Int!)

quantityFulfilled (Int!)

unitDiscountReason (String)

taxRate (Float!)

digitalContentUrl (DigitalContentUrl)

thumbnail (Image)

Size of the image. If not provided, the original image will be returned.

The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.

Added in Saleor 3.6.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

unitPrice (TaxedMoney!)

Price of the single item in the order line.

undiscountedUnitPrice (TaxedMoney!)

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

unitDiscount (Money!)

The discount applied to the single order line.

unitDiscountValue (PositiveDecimal!)

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

totalPrice (TaxedMoney!)

Price of the order line.

variant (ProductVariant)

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_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.

translatedProductName (String!)

Product name in the customer's language

translatedVariantName (String!)

Variant name in the customer's language

allocations ([Allocation!])

List of allocations across warehouses.

Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.

quantityToFulfill (Int!)

A quantity of items remaining to be fulfilled.

Added in Saleor 3.1.

unitDiscountType (DiscountValueTypeEnum)

Type of the discount: fixed or percent

Interfaces

Node

An object with an ID

ObjectWithMetadata