OrderEvent Object
History log of the order.
type OrderEvent implements Node {
id: ID!
date: DateTime
type: OrderEventsEnum
user: User
app: App
message: String
email: String
emailType: OrderEventsEmailsEnum
amount: Float
paymentId: String
paymentGateway: String
quantity: Int
composedId: String
orderNumber: String
invoiceNumber: String
oversoldItems: [String!]
lines: [OrderEventOrderLineObject!]
fulfilledItems: [FulfillmentLine!]
warehouse: Warehouse
transactionReference: String
shippingCostsIncluded: Boolean
relatedOrder: Order
related: OrderEvent
discount: OrderEventDiscountObject
reference: String
}Interfaces
Fields
id
id · ID!
ID of the event associated with an order.
date
date · DateTime
Date when event happened at in ISO 8601 format.
type
type · OrderEventsEnum
Order event type.
user
user · User
User who performed the action.
app
app · App
App that performed the action. Requires of of the following permissions: MANAGE_APPS, MANAGE_ORDERS, OWNER.
message
message · String
Content of the event.
email · String
Email of the customer.
emailType
emailType · OrderEventsEmailsEnum
Type of an email sent to the customer.
amount
amount · Float
Amount of money.
paymentId
paymentId · String
The payment reference from the payment provider.
paymentGateway
paymentGateway · String
The payment gateway of the payment.
quantity
quantity · Int
Number of items.
composedId
composedId · String
Composed ID of the Fulfillment.
orderNumber
orderNumber · String
User-friendly number of an order.
invoiceNumber
invoiceNumber · String
Number of an invoice related to the order.
oversoldItems
oversoldItems · [String!]
List of oversold lines names.
lines
lines · [OrderEventOrderLineObject!]
The concerned lines.
fulfilledItems
fulfilledItems · [FulfillmentLine!]
The lines fulfilled.
warehouse
warehouse · Warehouse
The warehouse were items were restocked.
transactionReference
transactionReference · String
The transaction reference of captured payment.
shippingCostsIncluded
shippingCostsIncluded · Boolean
Define if shipping costs were included to the refund.
relatedOrder
relatedOrder · Order
The order which is related to this order.
related
related · OrderEvent
The order event which is related to this event.
discount
discount · OrderEventDiscountObject
The discount applied to the order.
reference
reference · String
The reference of payment’s transaction.
Used by
- Order (objects)
- OrderAddNote (objects)
- OrderEventCountableEdge (objects)
- OrderNoteAdd (objects)
- OrderNoteUpdate (objects)
Schema: Saleor 3.23.43. Download SDL.