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!
undiscountedTotalPrice: TaxedMoney!
variant: ProductVariant
translatedProductName: String!
translatedVariantName: String!
allocations: [Allocation!]
saleId: ID
quantityToFulfill: Int!
unitDiscountType: DiscountValueTypeEnum
taxClass: TaxClass
taxClassName: String
taxClassMetadata: [MetadataItem!]!
taxClassPrivateMetadata: [MetadataItem!]!
voucherCode: String
}
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
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
OrderLine.privateMetafield.key
●String!
non-null scalar
OrderLine.privateMetafields
● Metadata
scalar
Private metadata. Requires staff permissions to access. Use
Added in Saleor 3.5keys
to control which fields you want to include. The default is to include everything.
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
OrderLine.metafield
● String
scalar
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.5
OrderLine.metafield.key
●String!
non-null scalar
OrderLine.metafields
● Metadata
scalar
Public metadata. Use
Added in Saleor 3.5keys
to control which fields you want to include. The default is to include everything.
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
scalarDesired 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.undiscountedTotalPrice
● TaxedMoney!
non-null object
Price of the order line without discounts.
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.saleId
● ID
scalar
Denormalized sale ID, set when order line is created for a product variant that is on sale.
Added in Saleor 3.14
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
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
OrderLine.voucherCode
● String
scalar
Voucher code that was used for this order line.
Added in Saleor 3.14
Interfaces
Node
interface
An object with an ID
ObjectWithMetadata
interface
Member of
CustomerEvent
object ● FulfillmentLine
object ● Order
object ● OrderEventOrderLineObject
object ● OrderGrantedRefundLine
object ● OrderLineDelete
object ● OrderLineDiscountRemove
object ● OrderLineDiscountUpdate
object ● OrderLinesCreate
object ● OrderLineUpdate
object
Implemented by
TaxSourceLine
union