Order
Kind: Object
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id |
ID! |
|
number |
String! |
|
status |
OrderStatus! |
|
orderGroupId |
String |
Shared id when a mixed cart split into an in-stock order + a made-to-order order (empty for ordinary single orders). |
channel |
SalesChannel |
Sales channel this order originated from (WHERE sold). |
isMadeToOrder |
Boolean! |
Booking-advance flow: advance paid at placement, balance before dispatch, invoice on full payment. |
advance |
Money! |
Booking advance charged at placement (0 for normal orders). |
balanceDue |
Money! |
Cash still outstanding (0 once fully paid). |
expectedDispatchDate |
Date |
Promised dispatch estimate for made-to-order builds. |
createdAt |
DateTime! |
|
paymentMethod |
OrderPaymentMethod! |
|
segment |
CustomerSegment! |
|
lines |
[OrderLine!]! |
|
subtotal |
Money! |
|
lineDiscountTotal |
Money! |
|
voucherCode |
String |
|
voucherDiscount |
Money! |
|
shipping |
Money! |
|
assembly |
Money! |
|
protection |
Money! |
GST-inclusive extended-warranty / AMC premiums on this order. |
gst |
GstBreakup! |
|
grandTotal |
Money! |
|
giftCardRedeemed |
Money! |
Amount covered by a gift card (payment, not discount). |
amountDue |
Money! |
Cash payable: grandTotal − giftCardRedeemed. |
interState |
Boolean! |
|
buyerGstin |
String! |
|
poNumber |
String! |
Institutional purchase-order number (quote/draft flows). |
paymentDueAt |
DateTime |
Due date for CREDIT-terms orders. |
etaDays |
Int |
|
deliveryMethod |
OrderDeliveryMethod! |
SHIPPING (doorstep) or PICKUP (click & collect). |
pickupShowroomName |
String! |
Pickup showroom name snapshot (PICKUP orders). |
pickupShowroom |
Showroom |
Pickup showroom, when it still exists. |
deliveryDate |
Date |
Scheduled delivery date, when a slot was booked. |
deliverySlotLabel |
String! |
Slot label snapshot, e.g. ‘Morning 09:00-13:00’. |
codPaidAt |
DateTime |
|
customerNote |
String! |
|
shippingAddress |
Address |
|
billingAddress |
Address |
|
fulfillments |
[Fulfillment!]! |
|
events |
[OrderEvent!]! |
|
payments |
[Payment!]! |
|
invoice |
Invoice |
|
creditNotes |
[CreditNote!]! |
|
issues |
[OrderIssue!]! |
Damage/defect claims reported on this order. |
rating |
OrderRating |
The customer’s delivery/experience rating, if given. |