Magidoc

NauticalOrder
Object

Represents a nautical order in the shop.

Fields

#

actions

Non-null

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

allowedSubStatuses

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

availableMarketplaceShippingMethods

Available shipping methods for the order.

availableShippingMethodsBySeller

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

bids

[ Bid !]

List of all bids made against the order.

billingAddress

canFinalize

Non-null

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

created

Non-null

currency

Non-null

currentBid

Latest bid made against the order.

customerNote

Non-null

discount

discountName

displayGrossPrices

Non-null

euInvoiceMessaging

events

List of events associated with the order.

externalId

externalSource

id

ID !
Non-null

The ID of the object

importedAt

Data time when the order was imported from another platform.

invoices

List of order invoices.

isMarketplaceShippingPriceOverridden

Non-null

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

isPaid

Informs if an order is fully paid.

isShippingRequired

Non-null

Returns True, if order requires shipping.

languageCode

Non-null

lines

Non-null

List of nautical order lines.

marketplaceShippingMethod

Shipping method for this order.

marketplaceShippingMethodName

Name of the shipping method for this order.

marketplaceShippingPrice

Non-null

Total price of shipping for this order.

metadata

Non-null

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

mpVatIdentificationNumber

number

User-friendly number of an order.

orderSource

Non-null

paymentStatus

Non-null

Internal payment status.

paymentStatusDisplay

Non-null

User-friendly payment status.

payments

List of payments for the order.

poNumbers

[ String !]

privateMetadata

Non-null

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

refunds

[ Refund !]

List of all the refunds for this marketplace order.

sellerFulfillments

Non-null

List of seller shipments for the order.

sellerUnfulfilled

Non-null

List

shippingAddress

shippingDiscount

shippingMethodName

Non-null

shippingPrice

Total price of shipping.

status

Non-null

Order status

statusDisplay

User-friendly order status.

subOrders

[ Order !]

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

subtotal

The sum of line prices not including shipping.

token

Non-null

total

Total amount of the order.

totalAuthorized

Amount authorized for the order across all payments.

totalBalance

Non-null

The difference between the paid and the order total amount.

totalCaptured

Amount captured for the order across all payments.

totalRefunded

Amount refunded for the order across all payments.

trackingClientId

Non-null

translatedDiscountName

updated

user

userEmail

Email address of the customer.

validationStatus

Validation status for the order

vatIdentificationNumber

volumeDiscount

Volume discount for the nautical order

voucher

weight

Interfaces

#

Also implements Node , ObjectWithMetadata .

Usages

#

References

#

  • Field nauticalOrder from Query
  • Field nauticalQuoteOrderByToken from Query
  • Field nauticalOrderByToken from Query