Magidoc

Order
Object

Represents an order in the shop.

Fields

#

actions

Non-null

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

affiliate

affiliateCode

affiliateCommission

Affiliate commission for the order

allowedSubStatuses

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

availablePayoutBalance

Remaining available balance to be paid out.

availableShippingMethods

Shipping methods that can be used with this order.

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

channel

Channel the order is associated with

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

fees

fulfillments

Non-null

List of shipments for the order.

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.

isOnlySellerOnNauticalOrder

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

isPaid

Informs if an order is fully paid.

isShippingPriceOverridden

Non-null

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

isShippingRequired

Non-null

Returns True, if order requires shipping.

languageCode

Non-null

lines

Non-null

List of order lines.

marketplaceOrder

Marketplace order that this seller order belongs to.

marketplaceOrderNumber

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

metadata

Non-null

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

mpVatIdentificationNumber

number

User-friendly number of an order.

orderSource

Non-null

originalTotal

Original total amount of the order.

paymentStatus

Non-null

Internal payment status.

paymentStatusDisplay

Non-null

User-friendly payment status.

payoutStatus

Order payout status.

payoutsSummary

Non-null

Summary of all payouts of this order

privateMetadata

Non-null

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

seller

Seller this order belongs to

sellerCommission

Seller commission for the order

shippingAddress

shippingMethod

shippingMethodName

shippingPrice

Total price of shipping.

status

Non-null

Order status

statusDisplay

User-friendly order status.

subStatus

subtotal

The sum of line prices not including shipping.

token

Non-null

total

Total amount of the order.

trackingClientId

Non-null

translatedDiscountName

updated

user

userEmail

Email address of the customer.

validationStatus

Validation status for the order

vatCode

Non-null

vatIdentificationNumber

vendorPayout

volumeDiscount

Volume discount for the order

voucher

weight

Interfaces

#

Also implements Node , ObjectWithMetadata .

Usages

#

References

#

  • Field orderByToken from Query