Skip to main content

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
}
Expand ▼

Fields

`OrderEvent.id` ● `ID!` non-null scalar miscellaneous

ID of the event associated with an order.

`OrderEvent.date` ● `DateTime` scalar miscellaneous

Date when event happened at in ISO 8601 format.

`OrderEvent.type` ● `OrderEventsEnum` enum orders

Order event type.

`OrderEvent.user` ● `User` object users

User who performed the action.

`OrderEvent.app` ● `App` object apps

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

`OrderEvent.message` ● `String` scalar miscellaneous

Content of the event.

`OrderEvent.email` ● `String` scalar miscellaneous

Email of the customer.

`OrderEvent.emailType` ● `OrderEventsEmailsEnum` enum orders

Type of an email sent to the customer.

`OrderEvent.amount` ● `Float` scalar miscellaneous

Amount of money.

`OrderEvent.paymentId` ● `String` scalar miscellaneous

The payment reference from the payment provider.

`OrderEvent.paymentGateway` ● `String` scalar miscellaneous

The payment gateway of the payment.

`OrderEvent.quantity` ● `Int` scalar miscellaneous

Number of items.

`OrderEvent.composedId` ● `String` scalar miscellaneous

Composed ID of the Fulfillment.

`OrderEvent.orderNumber` ● `String` scalar miscellaneous

User-friendly number of an order.

`OrderEvent.invoiceNumber` ● `String` scalar miscellaneous

Number of an invoice related to the order.

`OrderEvent.oversoldItems` ● `[String!]` list scalar miscellaneous

List of oversold lines names.

`OrderEvent.lines` ● `[OrderEventOrderLineObject!]` list object orders

The concerned lines.

`OrderEvent.fulfilledItems` ● `[FulfillmentLine!]` list object orders

The lines fulfilled.

`OrderEvent.warehouse` ● `Warehouse` object products

The warehouse were items were restocked.

`OrderEvent.transactionReference` ● `String` scalar miscellaneous

The transaction reference of captured payment.

`OrderEvent.shippingCostsIncluded` ● `Boolean` scalar miscellaneous

Define if shipping costs were included to the refund.

`OrderEvent.relatedOrder` ● `Order` object orders

The order which is related to this order.

`OrderEvent.related` ● `OrderEvent` object orders

The order event which is related to this event.

`OrderEvent.discount` ● `OrderEventDiscountObject` object orders

The discount applied to the order.

`OrderEvent.reference` ● `String` scalar miscellaneous

The reference of payment's transaction.

Interfaces

`Node` interface miscellaneous

An object with an ID

Member Of

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

Fields
Interfaces
Member Of