Orders > Orders
Commerce APIOrdersOrders

Orders

Orders symbolize a customer's procurement of goods or services from your shop. Additionally, they function as a shopping cart, holding the customer's chosen items until the purchase is finalized.

Endpoints

EndpointDescriptionJSON API
orderNotesGet order notesGET:order_notes.json
orderNotesCreateCreate order notesPOST:order_notes.json
orderNotesDeleteDelete order notesDELETE:order_notes.json
orderNotesModifyModify order notesPOST:order_notes.json
ordersGet ordersGET:orders.json
ordersAllocateNumberAllocate a number for the orderPOST:orders/allocate_number.json
ordersCalculateCalculate orderPOST:orders/calculate.json
ordersCalculateRefundCalculate refundsPOST:orders/calculate_refund.json
ordersCancelCancel an orderPOST:orders/cancel.json
ordersCancelReservationCancel order items reservationPOST:orders/cancel_reservation.json
ordersCaptureCapture an orderPOST:orders/capture.json
ordersCloseClose an orderPOST:orders/close.json
ordersCreateCreate an orderPOST:orders.json
ordersCreateImportedCreate an imported orderPOST:orders/create_imported.json
ordersDeleteDelete draft ordersDELETE:orders.json
ordersDownloadDownload customer inventory itemPOST:orders/download.json
ordersExportExport ordersPOST:orders/export.json
ordersModifyModify an orderPOST:orders.json
ordersOpenOpen an orderPOST:orders/open.json
ordersOverrideOverride order fieldsPOST:orders/override.json
ordersPageGet orders pageGET:orders/page.json
ordersPayPay for an orderPOST:orders/pay.json
ordersPriceListsEvaluate price lists for a given orderGET:orders/price_lists.json
ordersRefundRefund an orderPOST:orders/refund.json
ordersReserveReserve order itemsPOST:orders/reserve.json
ordersRestockRestock an orderPOST:orders/restock.json
ordersSendInvoiceSend order invoicePOST:orders/send_invoice.json
ordersSendReminderSend abandoned order reminder emailPOST:orders/send_reminder.json

Types

Types
CalculatedRefund
FileURL
ForeignShardedTask
GenericExport
MatchingPriceLists
Note
NoteCreate
NoteModify
OIOrder
Order
OrderCancel
OrderCreate
OrderModify
OrderOverride
OrderPage
OrderPayment
OrderRefund
OrderRestock
OrderType
OrdersPageSortBy