OrderEvent

Represents an order event in the order history.

type OrderEvent implements Node {
  id: ID!
  date: DateTime!
  type: OrderEventsEnum
  user: User
  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
}

Show more ↓

Fields

OrderEvent.id ● ID! non-null scalar

The Globally Unique ID of this object

OrderEvent.date ● DateTime! non-null scalar

Date when the event occurred

OrderEvent.type ● OrderEventsEnum enum

Type of order event

OrderEvent.user ● User object

User who performed the action.

OrderEvent.message ● String scalar

Event message/content

OrderEvent.email ● String scalar

Customer email (if applicable)

OrderEvent.emailType ● OrderEventsEmailsEnum enum

Type of email sent

OrderEvent.amount ● Float scalar

Amount of money (if applicable)

OrderEvent.paymentId ● String scalar

The payment ID from the payment gateway.

OrderEvent.paymentGateway ● String scalar

The payment gateway of the payment.

OrderEvent.quantity ● Int scalar

Quantity (if applicable)

OrderEvent.composedId ● String scalar

Composed ID of the Fulfillment.

OrderEvent.orderNumber ● String scalar

User-friendly number of an order.

OrderEvent.invoiceNumber ● String scalar

Number of an invoice related to the order.

OrderEvent.oversoldItems ● [String!] list scalar

List of oversold lines names.

OrderEvent.lines ● [OrderEventOrderLineObject!] list object

The concerned lines.

OrderEvent.fulfilledItems ● [FulfillmentLine!] list object

The lines fulfilled.

OrderEvent.warehouse ● Warehouse object

The warehouse where items were restocked.

Interfaces

Node interface

An object with a Globally Unique ID

Member Of

Order object ● OrderAddNote object