Magidoc

Order
Object

An Order between a retailer and a supplier. Its a child object of the RetailerOrder, which could contain multiple Orders, when the retailer orders from multiple suppliers at once. Ordering from multiple suppliers at once is not supported in the Portal.

Fields

#

agencyInvoices

Non-null

Invoices between the supplier and the retailer directly (Orderchamp is not involved). Only for portal and app orders.

authorizedAt

When the order was placed with a pay-after-delivery method, this is the date when the order was authorized for payment.

billingAddress

cancellationMessage

cancellationReason

cancelledAt

commissionPercentage

The commission percentage for this order

commissionPrice

The commission for this order without VAT

companyName

Non-null

companyPhone

confirmedAt

createdAt

Non-null

currency

customer

deliveredAt

email

Non-null

estimatedDeliveryAt

firstName

id

ID !
Non-null

ID of the object.

invoices

Non-null

Every invoice sent or received by the user related to this api key (usually the supplier). This contains invoices directly between the supplier and retailer (direct_invoice), invoices between the supplier and Orderchamp (supplier_invoice), and commission invoices from Orderchamp towards the supplier (commission_invoice).

isCancelled

isConfirmed

isFulfilled

isPaid

isTaxShifted

isTest

Non-null

lastName

locationType

note

The note that the retailer added to the order.

number

orderDiscountPercentage

The total percentage of order discounts applied

orderDiscountSubtotalPrice

The total amount of order discounts applied

paidAt

paymentLink

paymentMethod

paymentStatus

The payment status of the order, e.g. "paid", "unpaid", "authorized", "pending", "unpaid"

payments

products

Non-null

productsCount

Non-null

reference

The order refence that the retailer added to the order.

retailerOrder

retailerShippingPrice

The retailer price for shipping excluding VAT

retailerShippingTaxRate

The retailer tax rate for shipping

shipDirectlyToCustomer

shipments

Non-null

shippingAddress

shippingMethod

shippingPrice

The price for shipping excluding VAT

shippingTaxRate

source

The source of the order, e.g. "marketplace", "dropshipping", "portal", etc.

subtotalPrice

The sum of all products excluding VAT

supplierBills

Non-null

Invoices from Orderchamp towards the supplier for commission, when the brand has requested separate commission invoices (otherwise commission is charged on a supplier invoice directly. Also only for marketplace and dropshipping)

supplierInvoices

Non-null

The invoices from the supplier towards Orderchamp for the goods delivered (only for marketplace and dropshipping)

supplierShippingPrice

The supplier price for shipping excluding VAT

taxPrice

The total amount of VAT for this order

totalPrice

The grand total that needs to be paid for this order

totalShippingPrice

The price for shipping including VAT

updatedAt

Non-null

vatNumber

Interfaces

#

Also implements Node .

Usages

#

References

#