Skip to main content
View Markdown

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
}

Fields​

id ● ID!​

ID of the event associated with an order.

date ● DateTime​

Date when event happened at in ISO 8601 format.

type ● OrderEventsEnum​

Order event type.

user ● User​

User who performed the action.

app ● App​

App that performed the action. Requires of of the following permissions: MANAGE_APPS, MANAGE_ORDERS, OWNER.

message ● String​

Content of the event.

email ● String​

Email of the customer.

emailType ● OrderEventsEmailsEnum​

Type of an email sent to the customer.

amount ● Float​

Amount of money.

paymentId ● String​

The payment reference from the payment provider.

paymentGateway ● String​

The payment gateway of the payment.

quantity ● Int​

Number of items.

composedId ● String​

Composed ID of the Fulfillment.

orderNumber ● String​

User-friendly number of an order.

invoiceNumber ● String​

Number of an invoice related to the order.

oversoldItems ● [String!]​

List of oversold lines names.

lines ● [OrderEventOrderLineObject!]​

The concerned lines.

fulfilledItems ● [FulfillmentLine!]​

The lines fulfilled.

warehouse ● Warehouse​

The warehouse were items were restocked.

transactionReference ● String​

The transaction reference of captured payment.

shippingCostsIncluded ● Boolean​

Define if shipping costs were included to the refund.

The order which is related to this order.

The order event which is related to this event.

discount ● OrderEventDiscountObject​

The discount applied to the order.

reference ● String​

The reference of payment's transaction.

Interfaces​

Node​

An object with an ID

Member Of​

Order object ● OrderAddNote object ● OrderEvent object ● OrderEventCountableEdge object ● OrderNoteAdd object ● OrderNoteUpdate object