NauticalOrder

Represents a nautical (marketplace) order.

type NauticalOrder implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  created: DateTime!
  updated: DateTime
  currency: String!
  languageCode: String!
  trackingClientId: String!
  customerNote: String!
  displayGrossPrices: Boolean!
  isMarketplaceShippingPriceOverridden: Boolean!
  poNumbers: [String!]
  checkoutToken: String
  externalId: String
  externalSource: String
  importedAt: DateTime
  discountName: String
  translatedDiscountName: String
  euInvoiceMessaging: String
  vatIdentificationNumber: String
  mpVatIdentificationNumber: String
  token: String!
  userEmail: String
  orderSource: NauticalOrderOrderSource!
  status: NauticalOrderStatus!
  subStatus: NauticalOrderSubStatus
  number: String!
  statusDisplay: String!
  billingAddress: Address
  shippingAddress: Address
  user: User
  shippingPrice: TaxedMoney!
  total: TaxedMoney!
  subtotal: TaxedMoney!
  discount: Money!
  shippingDiscount: Money!
  marketplaceShippingPrice: TaxedMoney!
  shippingMethodName: String!
  marketplaceShippingMethodName: String
  marketplaceShippingMethod: ShippingMethod
  weight: Weight!
  payments: [Payment!]!
  paymentStatus: PaymentChargeStatusEnum!
  paymentStatusDisplay: String!
  totalAuthorized: Money!
  totalCaptured: Money!
  totalRefunded: Money!
  totalBalance(
    positive: Boolean = false
  ): Money!
  actions: [OrderAction!]!
  lines: [NauticalOrderLine!]!
  events: [NauticalOrderEvent!]!
  subOrders: [Order!]
  sellerOrders: [Order!]
  sellerFulfillments: [Fulfillment!]!
  invoices: [Invoice!]!
  refunds: [Refund!]!
  voucher: Voucher
  isPaid: Boolean!
  isPartlyPaid: Boolean!
  isShippingRequired: Boolean!
  canFinalize: Boolean!
  availableMarketplaceShippingMethods: [ShippingMethod!]!
  availableShippingMethodsBySeller: [MultiSellerShippingMethod!]!
  sellerUnfulfilled: [OrderLine!]!
  validationStatus: [ValidationStatus!]
  allowedSubStatuses: [OrderSubStatusEnum!]! @deprecated
}

Show more ↓

Fields

NauticalOrder.id ● ID! non-null scalar

The Globally Unique ID of this object

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

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

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

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

NauticalOrder.created ● DateTime! non-null scalar

Date when order was created

NauticalOrder.updated ● DateTime scalar

Date when order was last updated

NauticalOrder.currency ● String! non-null scalar

Order currency

NauticalOrder.languageCode ● String! non-null scalar

Order language code

NauticalOrder.trackingClientId ● String! non-null scalar

Tracking client ID

NauticalOrder.customerNote ● String! non-null scalar

Customer note for the order

NauticalOrder.displayGrossPrices ● Boolean! non-null scalar

Whether to display gross prices

NauticalOrder.isMarketplaceShippingPriceOverridden ● Boolean! non-null scalar

Whether marketplace shipping price is overridden

NauticalOrder.poNumbers ● [String!] list scalar

Purchase order numbers

NauticalOrder.checkoutToken ● String scalar

Token of the checkout instance that this order was created from.

NauticalOrder.externalId ● String scalar

External ID for integrations

NauticalOrder.externalSource ● String scalar

External source of the order

NauticalOrder.importedAt ● DateTime scalar

When the order was imported

NauticalOrder.discountName ● String scalar

Discount name

NauticalOrder.translatedDiscountName ● String scalar

Translated discount name

NauticalOrder.euInvoiceMessaging ● String scalar

EU invoice messaging

NauticalOrder.vatIdentificationNumber ● String scalar

VAT identification number

NauticalOrder.mpVatIdentificationNumber ● String scalar

Marketplace VAT identification number

NauticalOrder.token ● String! non-null scalar

Order token

NauticalOrder.userEmail ● String scalar

Email address of the customer.

NauticalOrder.orderSource ● NauticalOrderOrderSource! non-null enum

Source of the order

NauticalOrder.status ● NauticalOrderStatus! non-null enum

Order status

NauticalOrder.subStatus ● NauticalOrderSubStatus enum

Order sub-status

NauticalOrder.number ● String! non-null scalar

User-friendly order number

NauticalOrder.statusDisplay ● String! non-null scalar

User-friendly order status display

NauticalOrder.billingAddress ● Address object

Billing address for this order

NauticalOrder.shippingAddress ● Address object

Shipping address for this order

NauticalOrder.user ● User object

User who placed this order

NauticalOrder.shippingPrice ● TaxedMoney! non-null object

Total price of shipping

NauticalOrder.total ● TaxedMoney! non-null object

Total amount of the order (discounted)

NauticalOrder.subtotal ● TaxedMoney! non-null object

Subtotal (sum of line prices, not including shipping)

NauticalOrder.discount ● Money! non-null object

Order discount amount

NauticalOrder.shippingDiscount ● Money! non-null object

Shipping discount amount

NauticalOrder.marketplaceShippingPrice ● TaxedMoney! non-null object

Marketplace shipping price

NauticalOrder.shippingMethodName ● String! non-null scalar

Shipping method name

NauticalOrder.marketplaceShippingMethodName ● String scalar

Marketplace shipping method name

NauticalOrder.marketplaceShippingMethod ● ShippingMethod object

Marketplace shipping method

NauticalOrder.weight ● Weight! non-null object

Order weight

NauticalOrder.payments ● [Payment!]! non-null object

List of payments for this order

NauticalOrder.paymentStatus ● PaymentChargeStatusEnum! non-null enum

Payment status

NauticalOrder.paymentStatusDisplay ● String! non-null scalar

User-friendly payment status

NauticalOrder.totalAuthorized ● Money! non-null object

Amount authorized for the order across all payments

NauticalOrder.totalCaptured ● Money! non-null object

Amount captured for the order across all payments

NauticalOrder.totalRefunded ● Money! non-null object

Amount refunded for the order across all payments

NauticalOrder.totalBalance ● Money! non-null object

The difference between the paid and the order total amount

NauticalOrder.totalBalance.positive ● Boolean scalar

NauticalOrder.actions ● [OrderAction!]! non-null enum

List of actions that can be performed on this order

NauticalOrder.lines ● [NauticalOrderLine!]! non-null object

List of nautical order lines

NauticalOrder.events ● [NauticalOrderEvent!]! non-null object

List of events for this order

NauticalOrder.subOrders ● [Order!] list object

List of seller orders in this marketplace order

NauticalOrder.sellerOrders ● [Order!] list object

List of seller orders (alias for subOrders)

NauticalOrder.sellerFulfillments ● [Fulfillment!]! non-null object

List of seller fulfillments for the order

NauticalOrder.invoices ● [Invoice!]! non-null object

Invoices for this order

NauticalOrder.refunds ● [Refund!]! non-null object

Refunds for this order

NauticalOrder.voucher ● Voucher object

Voucher applied to this order

NauticalOrder.isPaid ● Boolean! non-null scalar

Whether order is fully paid

NauticalOrder.isPartlyPaid ● Boolean! non-null scalar

Whether order is partly paid

NauticalOrder.isShippingRequired ● Boolean! non-null scalar

Whether order requires shipping

NauticalOrder.canFinalize ● Boolean! non-null scalar

Whether draft order can be finalized

NauticalOrder.availableMarketplaceShippingMethods ● [ShippingMethod!]! non-null object

Available shipping methods for marketplace-fulfilled lines.

NauticalOrder.availableShippingMethodsBySeller ● [MultiSellerShippingMethod!]! non-null object

Available shipping methods for each seller in this order. Note: this field designed for 'nauticalOrder(:id)' query.

NauticalOrder.sellerUnfulfilled ● [OrderLine!]! non-null object

List of unfulfilled order lines from all sellers.

NauticalOrder.validationStatus ● [ValidationStatus!] list object

Validation status for the order (draft orders only).

NauticalOrder.allowedSubStatuses ● [OrderSubStatusEnum!]! deprecated non-null 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.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

nauticalOrder query ● nauticalOrderByToken query

Member Of

CheckoutComplete object ● CustomerEvent object ● Fulfillment object ● InvoiceRefresh object ● InvoiceRequest object ● JournalEntry object ● NauticalDraftOrderComplete object ● NauticalDraftOrderCreate object ● NauticalDraftOrderDelete object ● NauticalDraftOrderLineDelete object ● NauticalDraftOrderLinePriceOverride object ● NauticalDraftOrderLinesCreate object ● NauticalDraftOrderLineUpdate object ● NauticalDraftOrderSetTransactionCurrency object ● NauticalDraftOrderUpdate object ● NauticalOrderAddNote object ● NauticalOrderBulkAssignCustomer object ● NauticalOrderCancel object ● NauticalOrderCapture object ● NauticalOrderCountableEdge object ● NauticalOrderFulfill object ● NauticalOrderLineBulkCancel object ● NauticalOrderLinesCsvUpload object ● NauticalOrderMarkAsPaid object ● NauticalOrderPaymentCreate object ● NauticalOrderRefreshTaxes object ● NauticalOrderUpdate object ● NauticalOrderUpdateApplyVoucherCode object ● NauticalOrderUpdateDeleteDiscount object ● NauticalOrderUpdateMarketplaceShipping object ● NauticalOrderUpdateShipping object ● NauticalOrderVoid object ● NauticalPaymentLinkSendToCustomer object ● NauticalQuoteOrderSendToCustomer object ● Order object ● OrderDeclineFulfillment object ● Refund object

Implemented By

RefundScope union