Skip to main content

Order

Foreign type of an order.

type Order implements Node {
  id: UUID!
  invoice: Invoice!
  user: User!
  createdAt: DateTime!
  orderStatus: OrderStatus!
  placedAt: DateTime
  rejectionReason: RejectionReason
  invoiceAddress: UserAddress!
  compensatableOrderAmount: Int!
  paymentInformationId: UUID!
  orderItems(
    first: Int
    skip: Int
    orderBy: CommonOrderInput
  ): OrderItemConnection!
  shipments(
    filter: ShipmentFilterInput
    first: Int
    orderBy: ShipmentOrderInput
    skip: Int
  ): ShipmentConnection!
}

Fields​

Order.id ● UUID! non-null scalar​

The ID of the node.

Order.invoice ● Invoice! non-null object​

Invoice of the order.

Order.user ● User! non-null object​

User owning order.

Order.createdAt ● DateTime! non-null scalar​

Timestamp when order was created.

Order.orderStatus ● OrderStatus! non-null enum​

The status of the order.

Order.placedAt ● DateTime scalar​

Timestamp of order placement. None until order is placed.

Order.rejectionReason ● RejectionReason enum​

The rejection reason if status of the order is OrderStatus::Rejected.

Order.invoiceAddress ● UserAddress! non-null object​

Address of invoice.

Order.compensatableOrderAmount ● Int! non-null scalar​

Total compensatable amount of order.

Order.paymentInformationId ● UUID! non-null scalar​

UUID of payment information that the order should be processed with.

Order.orderItems ● OrderItemConnection! non-null object​

Retrieves order items.

Order.orderItems.first ● Int scalar​

Describes that the first N order items should be retrieved.

Order.orderItems.skip ● Int scalar​

Describes how many order items should be skipped at the beginning.

Order.orderItems.orderBy ● CommonOrderInput input​

Specifies the order in which order items are retrieved.

Order.shipments ● ShipmentConnection! non-null object​

Get all associated Shipments

Order.shipments.filter ● ShipmentFilterInput input​

Filtering

Order.shipments.first ● Int scalar​

Number of items to return

Order.shipments.orderBy ● ShipmentOrderInput input​

Ordering

Order.shipments.skip ● Int scalar​

Number of items to skip

Interfaces​

Node interface​

An object with an ID.

Returned By​

createOrder mutation ● order query ● placeOrder mutation

Member Of​

OrderConnection object ● Return object ● Shipment object