Orders
An Order represents a business transaction between two parties. It typically consists of a collection of Line Items, a Payment Method, Tax and Shipping information, etc. The OrderCloud platform defines various "actions" that can be performed against Orders, such as Submit, Approve, Ship, etc. These actions transform the state of the order and often trigger external events such as financial transactions.
Orders.List
Get a list of orders.
v1/orders/{direction}
Orders.Create
Create a new order.
v1/orders/{direction}
Orders.Get
Get a single order.
v1/orders/{direction}/{orderID}
Orders.Save
Create or update an order.
v1/orders/{direction}/{orderID}
Orders.Delete
Delete an order.
v1/orders/{direction}/{orderID}
Orders.Patch
Partially update an order.
v1/orders/{direction}/{orderID}
Orders.ApplyPromotions
Auto-apply promotions to an order.
v1/orders/{direction}/{orderID}/applypromotions
Orders.ListApprovals
Get a list of order approvals.
v1/orders/{direction}/{orderID}/approvals
Orders.Approve
Approve an order.
v1/orders/{direction}/{orderID}/approve
Orders.SetBillingAddress
Set a billing address.
v1/orders/{direction}/{orderID}/billto
Orders.PatchBillingAddress
Partially update an order billing address.
v1/orders/{direction}/{orderID}/billto
Orders.Cancel
Cancel an order.
v1/orders/{direction}/{orderID}/cancel
Orders.Complete
Complete an order.
v1/orders/{direction}/{orderID}/complete
Orders.Decline
Decline an order.
v1/orders/{direction}/{orderID}/decline
Orders.ListEligibleApprovers
Get a list of order eligible approvers.
v1/orders/{direction}/{orderID}/eligibleapprovers
Orders.ListEligiblePromotions
List eligible promotions.
v1/orders/{direction}/{orderID}/eligiblepromotions
Orders.Forward
Forward an order.
v1/orders/{direction}/{orderID}/forward
Orders.PatchFromUser
Update order FromUser.
v1/orders/{direction}/{orderID}/fromuser
Orders.ListPromotions
Get a list of order promotions.
v1/orders/{direction}/{orderID}/promotions
Orders.AddPromotion
Add a promotion to an order.
v1/orders/{direction}/{orderID}/promotions/{promoCode}
Orders.RemovePromotion
Remove a promotion from an order.
v1/orders/{direction}/{orderID}/promotions/{promoCode}
Orders.RefreshPromotions
Refresh promotions on an order.
v1/orders/{direction}/{orderID}/refreshpromotions
Orders.Ship
Create a new shipment containing all items on an order.
v1/orders/{direction}/{orderID}/ship
Orders.ListShipments
List shipments for an order.
v1/orders/{direction}/{orderID}/shipments
Orders.SetShippingAddress
Set a shipping address.
v1/orders/{direction}/{orderID}/shipto
Orders.PatchShippingAddress
Partially update an order shipping address.
v1/orders/{direction}/{orderID}/shipto
Orders.Split
Split an order.
v1/orders/{direction}/{orderID}/split
Orders.Submit
Submit an order.
v1/orders/{direction}/{orderID}/submit
Orders.Validate
Validate an order in its current state.
v1/orders/{direction}/{orderID}/validate