Skip to main content

Order

Permission required: order:read

type Order {
  accountingDocuments: [AccountingSaleDocument!]
  authenticationToken: String
  billing: Billing
  cancelledAt: ISO8601DateTime
  channel: Channel
  createdAt: ISO8601DateTime
  currency: String
  customerActions: [OrderCustomerAction!]
  deliveryId: String
  documentationLanguage: String
  fiscalDocument: AccountingSaleDocument
  id: ID
  invoiceRequired: Boolean
  lines: [OrderLine!]
  note: String
  number: String
  paidAt: ISO8601DateTime
  paymentMethod: String
  receivedAt: ISO8601DateTime
  repaymentRequests: [RepaymentRequest!]
  saleTransactions: [Transaction!]
  shippings: [Shipping!]
  status: OrderStatus
  totalGrossAmount: Float
  totalNetAmount: Float
  totalPaidAmount: Float
  totalVatAmount: Float
  updatedAt: ISO8601DateTime
}

Fields​

Order.accountingDocuments ● [AccountingSaleDocument!] list object​

All the fiscal documents issued for the order, in order of emission.

Order.authenticationToken ● String scalar​

An order-scoped authentication token (a JWT carrying the order id and an expiry) used to authenticate the customer's access to the order.

Order.billing ● Billing object​

The billing address and fiscal data of the order.

Order.cancelledAt ● ISO8601DateTime scalar​

When the order was cancelled. Null unless the order is cancelled.

Order.channel ● Channel object​

The sales channel the order belongs to.

Order.createdAt ● ISO8601DateTime scalar​

When the order was created on the channel.

Order.currency ● String scalar​

The order currency, as an ISO 4217 code.

Order.customerActions ● [OrderCustomerAction!] list object​

The customer-facing actions available for the order (see the customer* mutations).

Order.deliveryId ● String scalar​

The order identifier as the customer sees it in the e-shop. In almost all cases it coincides with number.

Order.documentationLanguage ● String scalar​

The language of the order's documents, as an uppercase ISO 639-1 code (DE, EN, ES, FR or IT).

Order.fiscalDocument ● AccountingSaleDocument object​

The latest fiscal document issued for the order — effectively the last item of accountingDocuments. For example, if a receipt was issued first and an invoice was requested afterwards, this is the invoice.

Order.id ● ID scalar​

The unique identifier of the record.

Order.invoiceRequired ● Boolean scalar​

Whether an invoice is required for the order. Forced to true when billing.vatNumber is populated.

Order.lines ● [OrderLine!] list object​

The lines of the order.

Order.note ● String scalar​

The note written by the buyer when placing the order. Stored as submitted at import.

Order.number ● String scalar​

The order identifier assigned by the integration (or hub) that submitted the order. In almost all cases it coincides with deliveryId.

When the order was paid.

Order.paymentMethod ● String scalar​

The payment method name.

Order.receivedAt ● ISO8601DateTime scalar​

When OMS received the order.

Order.repaymentRequests ● [RepaymentRequest!] list object​

The repayment requests (returns) associated with the order.

Order.saleTransactions ● [Transaction!] list interface​

The payment transactions linked to the order: the payment records created by OMS itself and the external transactions matched through their referenceCode.

Order.shippings ● [Shipping!] list object​

The shipping destinations of the order.

Order.status ● OrderStatus enum​

The lifecycle status of the order inside OMS. While the order is acquiring, calculations and checks (for example line VAT amounts) are still running: do not rely on computed values until the order leaves that status.

Order.totalGrossAmount ● Float scalar​

The order gross total (net plus VAT), based on the lines. Recomputed from the line prices during acquisition.

Order.totalNetAmount ● Float scalar​

The order net total, based on the lines. Recomputed from the line prices during acquisition.

Order.totalPaidAmount ● Float scalar​

The total amount paid by the customer. The only order total stored exactly as provided at import, never recomputed.

Order.totalVatAmount ● Float scalar​

The order VAT total, based on the lines. Recomputed from the line prices during acquisition.

Order.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

Returned By​

findLastOrder query ● order query ● orderImport mutation

Member Of​

AdyenTransaction object ● HeylightTransaction object ● NexiTransaction object ● OrderConnection object ● OrderEdge object ● PaymentBasicTransaction object ● PaymentExternalTransaction object ● PaypalTransaction object ● RepaymentRequest object ● ScalaPayTransaction object ● ShopifyTransaction object ● StripeTransaction object ● Transaction interface