Order
Represents a seller order.
type Order implements Node, ObjectWithMetadata {
id: ID!
metadata: [MetadataItem!]!
privateMetadata: [MetadataItem!]!
created: DateTime!
updated: DateTime
token: String!
currency: String!
languageCode: String!
trackingClientId: String!
customerNote: String!
displayGrossPrices: Boolean!
externalId: String
externalSource: String
discountName: String
translatedDiscountName: String
shippingMethodName: String
isShippingPriceOverridden: Boolean!
importedAt: DateTime
vatCode: String!
euInvoiceMessaging: String
vatIdentificationNumber: String
mpVatIdentificationNumber: String
userEmail: String
orderSource: OrderOrderSource!
status: OrderStatus!
subStatus: OrderSubStatus
payoutStatus: OrderPayoutStatusEnum
number: String!
statusDisplay: String!
marketplaceOrderNumber: String!
billingAddress: Address
shippingAddress: Address
seller: Seller
marketplaceOrder: NauticalOrder
shippingPrice: TaxedMoney!
total: TaxedMoney!
discountedTotal: TaxedMoney!
originalTotal: TaxedMoney!
subtotal: TaxedMoney!
discount: Money!
voucherDiscount: Money!
sellerCommission: Money
availablePayoutBalance: Money
fulfilledByMarketplace: Boolean!
weight: Weight!
paymentStatus: PaymentChargeStatusEnum!
paymentStatusDisplay: String!
fulfillments: [Fulfillment!]!
lines: [OrderLine!]!
events: [OrderEvent!]!
fees: [OrderFee!]!
invoices: [Invoice!]!
vendorPayouts: [VendorPayout!]!
availableShippingMethods: [ShippingMethod!]!
isPaid: Boolean!
isShippingRequired: Boolean!
isOnlySellerOnNauticalOrder: Boolean!
canFinalize: Boolean!
allowedSubStatuses: [OrderSubStatusEnum!]! @deprecated
financials: FinancialsSnapshot
shippingMethod: ShippingMethod
user: User
voucher: Voucher
payoutsSummary(
payoutStatus: PayoutStatusEnum
): [OrderPayoutSummary!]!
validationStatus: [ValidationStatus!]
}
Fields
Order.id ● ID! non-null scalar
The Globally Unique ID of this object
Order.metadata ● [MetadataItem!]! non-null object
List of public metadata items. Can be accessed without permissions.
Order.privateMetadata ● [MetadataItem!]! non-null object
List of private metadata items. Requires proper staff permissions to access.
Order.created ● DateTime! non-null scalar
Date when order was created
Order.updated ● DateTime scalar
Date when order was last updated
Order.token ● String! non-null scalar
Order token
Order.currency ● String! non-null scalar
Order currency
Order.languageCode ● String! non-null scalar
Order language code
Order.trackingClientId ● String! non-null scalar
Tracking client ID
Order.customerNote ● String! non-null scalar
Customer note for the order
Order.displayGrossPrices ● Boolean! non-null scalar
Whether to display gross prices
Order.externalId ● String scalar
External ID
Order.externalSource ● String scalar
External source
Order.discountName ● String scalar
Discount name
Order.translatedDiscountName ● String scalar
Translated discount name
Order.shippingMethodName ● String scalar
Shipping method name
Order.isShippingPriceOverridden ● Boolean! non-null scalar
Whether shipping price is manually overridden
Order.importedAt ● DateTime scalar
When order was imported
Order.vatCode ● String! non-null scalar
VAT code
Order.euInvoiceMessaging ● String scalar
EU invoice messaging
Order.vatIdentificationNumber ● String scalar
VAT identification number
Order.mpVatIdentificationNumber ● String scalar
Marketplace VAT identification number
Order.userEmail ● String scalar
Email address of the customer.
Order.orderSource ● OrderOrderSource! non-null enum
Source of the order
Order.status ● OrderStatus! non-null enum
Order status
Order.subStatus ● OrderSubStatus enum
Order sub-status
Order.payoutStatus ● OrderPayoutStatusEnum enum
Order payout status
Order.number ● String! non-null scalar
User-friendly order number
Order.statusDisplay ● String! non-null scalar
User-friendly order status display
Order.marketplaceOrderNumber ● String! non-null scalar
Marketplace order number
Order.billingAddress ● Address object
Billing address for this order
Order.shippingAddress ● Address object
Shipping address for this order
Order.seller ● Seller object
Seller this order belongs to
Order.marketplaceOrder ● NauticalOrder object
Marketplace order this seller order belongs to
Order.shippingPrice ● TaxedMoney! non-null object
Total price of shipping
Order.total ● TaxedMoney! non-null object
Total amount of the order
Order.discountedTotal ● TaxedMoney! non-null object
Discounted total amount of the order
Order.originalTotal ● TaxedMoney! non-null object
Original total amount of the order
Order.subtotal ● TaxedMoney! non-null object
Subtotal (sum of line prices without shipping)
Order.discount ● Money! non-null object
Order discount amount
Order.voucherDiscount ● Money! non-null object
Voucher discount for the order
Order.sellerCommission ● Money object
Seller commission for the order
Order.availablePayoutBalance ● Money object
Available payout balance
Order.fulfilledByMarketplace ● Boolean! non-null scalar
Whether order is fulfilled by marketplace
Order.weight ● Weight! non-null object
Order weight
Order.paymentStatus ● PaymentChargeStatusEnum! non-null enum
Payment status
Order.paymentStatusDisplay ● String! non-null scalar
User-friendly payment status
Order.fulfillments ● [Fulfillment!]! non-null object
List of fulfillments for this order
Order.lines ● [OrderLine!]! non-null object
List of order lines
Order.events ● [OrderEvent!]! non-null object
List of events for this order
Order.fees ● [OrderFee!]! non-null object
List of fees for this order
Order.invoices ● [Invoice!]! non-null object
Invoices for this order
Order.vendorPayouts ● [VendorPayout!]! non-null object
Vendor payouts containing this order
Order.availableShippingMethods ● [ShippingMethod!]! non-null object
Available shipping methods for this order
Order.isPaid ● Boolean! non-null scalar
Whether order is fully paid
Order.isShippingRequired ● Boolean! non-null scalar
Whether order requires shipping
Order.isOnlySellerOnNauticalOrder ● Boolean! non-null scalar
Whether this is the only seller on the nautical order
Order.canFinalize ● Boolean! non-null scalar
Whether draft order can be finalized
Order.allowedSubStatuses ● [OrderSubStatusEnum!]! deprecated non-null enum
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.financials ● FinancialsSnapshot object
Financial snapshot for the order taken at order finalization
Order.shippingMethod ● ShippingMethod object
Shipping method for this order
Order.user ● User object
User who placed the order
Order.voucher ● Voucher object
Voucher used for this order
Order.payoutsSummary ● [OrderPayoutSummary!]! non-null object
Summary of all payouts for this order
Order.payoutsSummary.payoutStatus ● PayoutStatusEnum enum
Order.validationStatus ● [ValidationStatus!] list object
Validation status for draft orders
Interfaces
Node interface
An object with a Globally Unique ID
ObjectWithMetadata interface
An object that supports metadata.
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 ● FulfillmentBulkReturn object ● FulfillmentCancel object ● FulfillmentReturn object ● FulfillmentReturnStatusBulkUpdate object ● FulfillmentUpdateTracking object ● InvoiceRefresh object ● InvoiceRequest object ● JournalEntry object ● NauticalDraftOrderComplete object ● NauticalOrder object ● NauticalOrderFulfill 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