Order

Object

actions

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

List of all bids made against the order.

billingAddress

canFinalize

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

channel

Channel the order is associated with

created

currency

currentBid

Latest bid made against the order.

customerNote

discount

discountName

displayGrossPrices

euInvoiceMessaging

events

List of events associated with the order.

externalId

externalSource

fees

fulfillments

List of shipments for the order.

id

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

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

isShippingRequired

Returns True, if order requires shipping.

languageCode

lines

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

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

mpVatIdentificationNumber

number

User-friendly number of an order.

orderSource

originalTotal

Original total amount of the order.

paymentStatus

Internal payment status.

paymentStatusDisplay

User-friendly payment status.

payoutStatus

Order payout status.

payoutsSummary

Summary of all payouts of this order

privateMetadata

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

Order status

statusDisplay

User-friendly order status.

subStatus

subtotal

The sum of line prices not including shipping.

token

total

Total amount of the order.

trackingClientId

translatedDiscountName

updated

user

userEmail

Email address of the customer.

validationStatus

Validation status for the order

vatCode

vatIdentificationNumber

vendorPayout

Latest vendor payout this order is in

vendorPayouts

All vendor payouts that contain this order

volumeDiscount

Volume discount for the order

voucher

weight