Sitecore OrderCloud Documentation

docs

Portal login

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

List orders

get

v1/orders/{direction}

Orders.Create

Create an order

post

v1/orders/{direction}

Orders.Get

Retrieve an order

get

v1/orders/{direction}/{orderID}

Orders.Save

Create or update an order

put

v1/orders/{direction}/{orderID}

Orders.Delete

Delete an order

delete

v1/orders/{direction}/{orderID}

Orders.Patch

Partially update an order

patch

v1/orders/{direction}/{orderID}

Orders.ApplyPromotions

Auto-apply promotions to an order

post

v1/orders/{direction}/{orderID}/applypromotions

Orders.ListApprovals

List order approvals

get

v1/orders/{direction}/{orderID}/approvals

Orders.Approve

Approve an order

post

v1/orders/{direction}/{orderID}/approve

Orders.SetBillingAddress

Set a billing address

put

v1/orders/{direction}/{orderID}/billto

Orders.PatchBillingAddress

Partially update an order billing address

patch

v1/orders/{direction}/{orderID}/billto

Orders.Cancel

Cancel an order

post

v1/orders/{direction}/{orderID}/cancel

Orders.Complete

Complete an order

post

v1/orders/{direction}/{orderID}/complete

Orders.Decline

Decline an order

post

v1/orders/{direction}/{orderID}/decline

Orders.ListEligibleApprovers

List order eligible approvers

get

v1/orders/{direction}/{orderID}/eligibleapprovers

Orders.ListEligiblePromotions

List eligible promotions for an order

get

v1/orders/{direction}/{orderID}/eligiblepromotions

Orders.Forward

Forward an order

post

v1/orders/{direction}/{orderID}/forward

Orders.PatchFromUser

Partially update an order from user

patch

v1/orders/{direction}/{orderID}/fromuser

Orders.ListPromotions

List order promotions

get

v1/orders/{direction}/{orderID}/promotions

Orders.AddPromotion

Add a promotion to an order

post

v1/orders/{direction}/{orderID}/promotions/{promoCode}

Orders.RemovePromotion

Remove a promotion from an order

delete

v1/orders/{direction}/{orderID}/promotions/{promoCode}

Orders.RefreshPromotions

Refresh promotions on an order

post

v1/orders/{direction}/{orderID}/refreshpromotions

Orders.Ship

Create a new shipment containing all items on an order

post

v1/orders/{direction}/{orderID}/ship

Orders.ListShipments

List shipments for an order

get

v1/orders/{direction}/{orderID}/shipments

Orders.SetShippingAddress

Set a shipping address

put

v1/orders/{direction}/{orderID}/shipto

Orders.PatchShippingAddress

Partially update an order shipping address

patch

v1/orders/{direction}/{orderID}/shipto

Orders.Split

Split an order

post

v1/orders/{direction}/{orderID}/split

Orders.Submit

Submit an order

post

v1/orders/{direction}/{orderID}/submit

Orders.Validate

Validate an order in its current state

post

v1/orders/{direction}/{orderID}/validate

Sitecore Logo

© Copyright 2025, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore