Order

Represents an order in the shop.

type Order implements Node, ObjectWithMetadata {
  id: ID!
  externalId: String
  externalSource: String
  orderSource: OrderOrderSource!
  seller: Seller
  created: DateTime!
  updated: DateTime
  status: OrderStatus!
  subStatus: OrderSubStatus
  user: User
  languageCode: String!
  trackingClientId: String!
  billingAddress: Address
  shippingAddress: Address
  vatCode: String!
  euInvoiceMessaging: String
  vatIdentificationNumber: String
  mpVatIdentificationNumber: String
  currency: String!
  shippingMethod: ShippingMethod
  shippingMethodName: String
  shippingPrice: TaxedMoney
  isShippingPriceOverridden: Boolean!
  fulfilledByMarketplace: Boolean!
  token: String!
  voucher: Voucher
  discount: Money
  discountName: String
  translatedDiscountName: String
  displayGrossPrices: Boolean!
  customerNote: String!
  weight: Weight
  importedAt: DateTime
  privateMetadata: [MetadataItem!]!
  metadata: [MetadataItem!]!
  fulfillments: [Fulfillment!]!
  fees: [OrderFee!]
  lines: [OrderLine!]!
  allowedSubStatuses: [OrderSubStatusEnum!] @deprecated
  availableShippingMethods: [ShippingMethod!]
  invoices: [Invoice!]
  number: String
  marketplaceOrderNumber: String
  isPaid: Boolean
  paymentStatus: PaymentChargeStatusEnum!
  paymentStatusDisplay: String!
  total: TaxedMoney
  discountedTotal: TaxedMoney
  originalTotal: TaxedMoney
  subtotal: TaxedMoney
  statusDisplay: String
  canFinalize: Boolean!
  events: [OrderEvent!]
  userEmail: String
  isShippingRequired: Boolean!
  payoutStatus: OrderPayoutStatusEnum
  payoutsSummary(
    payoutStatus: PayoutStatusEnum
  ): [OrderPayoutSummary!]!
  availablePayoutBalance: Money
  sellerCommission: Money
  validationStatus: [ValidationStatus!]
  isOnlySellerOnNauticalOrder: Boolean
  marketplaceOrder: NauticalOrder
  vendorPayouts: [VendorPayout!]
  voucherDiscount: Money
  financials: FinancialsSnapshot
}

Show more ↓

Fields

Order.id ● ID! non-null scalar

The ID of the object

Order.externalId ● String scalar

Order.externalSource ● String scalar

Order.orderSource ● OrderOrderSource! non-null enum

Order.seller ● Seller object

Seller this order belongs to

Order.created ● DateTime! non-null scalar

Order.updated ● DateTime scalar

Order.status ● OrderStatus! non-null enum

Order status

Order.subStatus ● OrderSubStatus enum

Order.user ● User object

Order.languageCode ● String! non-null scalar

Order.trackingClientId ● String! non-null scalar

Order.billingAddress ● Address object

Order.shippingAddress ● Address object

Order.vatCode ● String! non-null scalar

Order.euInvoiceMessaging ● String scalar

Order.vatIdentificationNumber ● String scalar

Order.mpVatIdentificationNumber ● String scalar

Order.currency ● String! non-null scalar

Order.shippingMethod ● ShippingMethod object

Order.shippingMethodName ● String scalar

Order.shippingPrice ● TaxedMoney object

Total price of shipping.

Order.isShippingPriceOverridden ● Boolean! non-null scalar

Indicates that the shipping price is set manually by user rather than taken from a related shipping method.

Order.fulfilledByMarketplace ● Boolean! non-null scalar

Indicates that the order is being fulfilled by the marketplace and the seller is not responsible for shipping.

Order.token ● String! non-null scalar

Order.voucher ● Voucher object

Order.discount ● Money object

Order.discountName ● String scalar

Order.translatedDiscountName ● String scalar

Order.displayGrossPrices ● Boolean! non-null scalar

Order.customerNote ● String! non-null scalar

Order.weight ● Weight object

Order.importedAt ● DateTime scalar

Data time when the order was imported from another platform.

Order.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items.Requires proper staff permissions to access.

Order.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Order.fulfillments ● [Fulfillment!]! non-null object

List of shipments for the order.

Order.fees ● [OrderFee!] list object

Order.lines ● [OrderLine!]! non-null object

List of order lines.

Order.allowedSubStatuses ● [OrderSubStatusEnum!] deprecated list enum

DEPRECATED

This will be removed on September 9, 2025.

List of sub-statuses that can be changed to based on current state of the order

Order.availableShippingMethods ● [ShippingMethod!] list object

Shipping methods that can be used with this order.

Order.invoices ● [Invoice!] list object

List of order invoices.

Order.number ● String scalar

User-friendly number of an order.

Order.marketplaceOrderNumber ● String scalar

User-friendly number of the marketplace order this order belongs to.

Order.isPaid ● Boolean scalar

Informs if an order is fully paid.

Order.paymentStatus ● PaymentChargeStatusEnum! non-null enum

Internal payment status.

Order.paymentStatusDisplay ● String! non-null scalar

User-friendly payment status.

Order.total ● TaxedMoney object

Total amount of the order.

Order.discountedTotal ● TaxedMoney object

Total of the order including any discounts.

Order.originalTotal ● TaxedMoney object

Original total amount of the order.

Order.subtotal ● TaxedMoney object

The sum of line prices not including shipping.

Order.statusDisplay ● String scalar

User-friendly order status.

Order.canFinalize ● Boolean! non-null scalar

Informs whether a draft order can be finalized (turned into a regular order).

Order.events ● [OrderEvent!] list object

List of events associated with the order.

Order.userEmail ● String scalar

Email address of the customer.

Order.isShippingRequired ● Boolean! non-null scalar

Returns True, if order requires shipping.

Order.payoutStatus ● OrderPayoutStatusEnum enum

Order payout status.

Order.payoutsSummary ● [OrderPayoutSummary!]! non-null object

Summary of all payouts of this order

Order.payoutsSummary.payoutStatus ● PayoutStatusEnum enum

Order payout status.

Order.availablePayoutBalance ● Money object

Remaining available balance to be paid out.

Order.sellerCommission ● Money object

Seller commission for the order

Order.validationStatus ● [ValidationStatus!] list object

Validation status for the order

Order.isOnlySellerOnNauticalOrder ● Boolean scalar

Determines if seller is the only seller on the related nautical order. Note: if nautical order doesn't exist - will return None.

Order.marketplaceOrder ● NauticalOrder object

Marketplace order that this seller order belongs to.

Order.vendorPayouts ● [VendorPayout!] list object

All vendor payouts that contain this order

Order.voucherDiscount ● Money object

Voucher discount for the order

Order.financials ● FinancialsSnapshot object

Financial snapshot for the order taken at the time of order finalization.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

order query ● orderByToken query

Member Of

CustomerEvent object ● DraftOrderComplete object ● DraftOrderCreate object ● DraftOrderDelete object ● DraftOrderLineDelete object ● DraftOrderLinePriceOverride object ● DraftOrderLinesCreate object ● DraftOrderLineUpdate object ● DraftOrderSetTransactionCurrency object ● DraftOrderUpdate object ● Fulfillment object ● FulfillmentCancel object ● FulfillmentReturn object ● FulfillmentReturnStatusBulkUpdate object ● FulfillmentUpdateTracking object ● InvoiceRefresh object ● InvoiceRequest object ● JournalEntry object ● NauticalDraftOrderComplete object ● NauticalOrder object ● OrderAddNote object ● OrderCancel object ● OrderCountableEdge object ● OrderDeclineFulfillment object ● OrderFee object ● OrderFulfill object ● OrderLine object ● OrderLinesCsvUpload object ● OrderMarkAsDelivered object ● OrderUpdate object ● OrderUpdateShipping object

Implemented By

RefundScope union