NauticalOrder

Represents a nautical order in the shop.

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

Show more ↓

Fields

NauticalOrder.id ● ID! non-null scalar

The ID of the object

NauticalOrder.externalId ● String scalar

NauticalOrder.externalSource ● String scalar

NauticalOrder.orderSource ● NauticalOrderOrderSource! non-null enum

NauticalOrder.created ● DateTime! non-null scalar

NauticalOrder.updated ● DateTime scalar

NauticalOrder.status ● NauticalOrderStatus! non-null enum

Order status

NauticalOrder.subStatus ● NauticalOrderSubStatus enum

NauticalOrder.user ● User object

NauticalOrder.languageCode ● String! non-null scalar

NauticalOrder.trackingClientId ● String! non-null scalar

NauticalOrder.billingAddress ● Address object

NauticalOrder.shippingAddress ● Address object

NauticalOrder.currency ● String! non-null scalar

NauticalOrder.isMarketplaceShippingPriceOverridden ● Boolean! non-null scalar

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

NauticalOrder.shippingPrice ● TaxedMoney object

Total price of shipping.

NauticalOrder.euInvoiceMessaging ● String scalar

NauticalOrder.vatIdentificationNumber ● String scalar

NauticalOrder.mpVatIdentificationNumber ● String scalar

NauticalOrder.token ● String! non-null scalar

NauticalOrder.checkoutToken ● String scalar

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

NauticalOrder.voucher ● Voucher object

NauticalOrder.shippingDiscount ● Money object

NauticalOrder.discount ● Money object

NauticalOrder.discountName ● String scalar

NauticalOrder.translatedDiscountName ● String scalar

NauticalOrder.displayGrossPrices ● Boolean! non-null scalar

NauticalOrder.customerNote ● String! non-null scalar

NauticalOrder.weight ● Weight object

NauticalOrder.importedAt ● DateTime scalar

Data time when the order was imported from another platform.

NauticalOrder.poNumbers ● [String!] list scalar

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

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

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

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

NauticalOrder.availableMarketplaceShippingMethods ● [ShippingMethod!] list object

Available shipping methods for the order.

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

List of seller shipments for the order.

NauticalOrder.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

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

List

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

List of nautical order lines.

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

List of actions that can be performed in the current state of an order.

NauticalOrder.availableShippingMethodsBySeller ● [MultiSellerShippingMethod!] list object

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

NauticalOrder.invoices ● [Invoice!] list object

List of order invoices.

NauticalOrder.number ● String scalar

User-friendly number of an order.

NauticalOrder.isPaid ● Boolean scalar

Informs if an order is fully paid.

NauticalOrder.paymentStatus ● PaymentChargeStatusEnum! non-null enum

Internal payment status.

NauticalOrder.paymentStatusDisplay ● String! non-null scalar

User-friendly payment status.

NauticalOrder.payments ● [Payment!] list object

List of payments for the order.

NauticalOrder.total ● TaxedMoney object

Total amount of the order.

NauticalOrder.subtotal ● TaxedMoney object

The sum of line prices not including shipping.

NauticalOrder.statusDisplay ● String scalar

User-friendly order status.

NauticalOrder.canFinalize ● Boolean! non-null scalar

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

NauticalOrder.validationStatus ● [ValidationStatus!] list object

Validation status for the order

NauticalOrder.totalAuthorized ● Money object

Amount authorized for the order across all payments.

NauticalOrder.totalCaptured ● Money object

Amount captured for the order across all payments.

NauticalOrder.totalRefunded ● Money object

Amount refunded for the order across all payments.

NauticalOrder.events ● [NauticalOrderEvent!] list object

List of events associated with the order.

NauticalOrder.totalBalance ● Money! non-null object

The difference between the paid and the order total amount.

NauticalOrder.totalBalance.positive ● Boolean scalar

Should the balance be returned positive or negative.

NauticalOrder.userEmail ● String scalar

Email address of the customer.

NauticalOrder.isShippingRequired ● Boolean! non-null scalar

Returns True, if order requires shipping.

NauticalOrder.shippingMethodName ● String! non-null scalar

NauticalOrder.subOrders ● [Order!] list object

List of all the vendor orders connected to this marketplace order.

NauticalOrder.refunds ● [Refund!] list object

List of all the refunds for this marketplace order.

NauticalOrder.marketplaceShippingPrice ● TaxedMoney! non-null object

Total price of shipping for this order.

NauticalOrder.marketplaceShippingMethod ● ShippingMethod object

Shipping method for this order.

NauticalOrder.marketplaceShippingMethodName ● String scalar

Name of the shipping method for this order.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

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 ● Payment object ● Refund object

Implemented By

RefundScope union