Skip to main content

OrderPartialClass

Properties

NameTypeDescriptionNotes
idStringOrder ID that will be used to search[default to null]
customerOrderPartialClass_customer[default to null]
total_amountBigDecimalTotal order amount charged to the customer[optional] [default to null]
items_total_amountBigDecimalTotal item amount without delivery fee and discounts applied[default to null]
charged_delivery_feeStringDelivery fee charged if order type is delivery[default to null]
delivery_paid_by_cashBooleanIndicates delivery fee was paid via cash[default to null]
promo_discountBigDecimalPromotional discount applied on amount paid[default to null]
promo_baseObjectIndicates where the promotional discount has been applied[default to null]
customer_notesStringCustomer notes[default to null]
meal_planBooleanIndicates if the order is part of a meal plan[default to null]
meal_plan_discountStringIndicates discount applied to a meal plan[optional] [default to null]
meal_plan_delivery_discountStringIndicates max delivery discount for meal plans[optional] [default to null]
meal_plan_quoted_delivery_feeStringIndicates total delivery fee quoted for a meal plan[optional] [default to null]
meal_plan_indexStringIndicates order placement as part of a meal plan i.e. placement/total[optional] [default to null]
order_typeStringOrder type[default to null]
order_dateStringISO8601 compliant order date string[default to null]
order_timeStringOrder time filter in HH
format
[default to null]
delivery_addressStringOrder delivery address, empty if order type is pickup or curbside pickup[default to null]
delivery_statusStringOrder delivery status[optional] [default to null]
delivery_tracking_linkStringOrder delivery tracking link[optional] [default to null]
statusStringOrder status, expired means the cart was abandoned[optional] [default to null]
order_detailsListOrder Details[default to null]
store_detailsOrderPartialClass_store_details[default to null]
change_timestampObjectStatus update timestamps[default to null]
transaction_numberStringTransaction number, this serves as pickup's order number[default to null]
payment_methodStringPayment method used[optional] [default to null]
refunded_amountBigDecimalRefunded amount, can be partial or full[default to null]
pickup_detailsOrderPartialClass_pickup_details[default to null]
tracking_pageStringTracking page for this particular order[default to null]
promoOrderPartialClass_promo[default to null]
store_notesStringStore notes[default to null]

[Back to Model list] [Back to API list] [Back to README]