1. Sitecore Experience Commerce

Orders actions, commands and pipelines

Version:

The following table describes the actions, commands and pipelines pertaining to the Order entity:

Action/Command/PipelineDescription
Orders

GetOrderCommand

GetOrderPipeline		Retrieves an order.

Parameter:

  • orderId: the identifier of the order
CreateOrder

CreateOrderCommand

CreateOrderPipeline

Dependent pipelines:

ItemOrderedPipeline

OrderPlacedPipeline		Creates an order. This action is performed by a shopper from a storefront web site.

Parameter:

  • id: identifier of a cart is passed into the order
HoldOrder

HoldOrderCommand

HoldOrderPipeline		Places an order into on hold status so that no further processing can occur, for example temporarily while changes are being made to the order. This action is performed by a customer service rep. using the business tools.

Parameter:

  • orderId: the identifier of the order
UndoOnHoldOrder

UndoOnHoldOrderCommand

UndoOnHoldOrderPipeline		Undoes the changes made to an order while the order is on hold.

Parameter:

  • orderId: the identifier of the order
CancelOnHoldOrder

CancelOnHoldOrderCommand

CancelOnHoldOrderPipeline		Cancels the order that is on hold. This is performed by a CSR, for example after having placed the order on hold, then decides to cancel it.

Parameter:

  • orderId: the identifier of the order
CancelOrder

CancelOrderCommand

CancelOrderPipeline		Cancels an order. This action is performed by a shopper from a storefront web site, or by a customer sevice representative using the Commerce business tools. The order must be in pending state, after which the order has been processed and needs to be canceled by an order return.

Parameter:

  • orderId: the identifier of the order
ReleaseOrder

ReleaseOnHoldOrderCommand

ReleaseOnHoldOrderPipeline		Releases an order that is on hold.

Parameter:

  • orderId: the identifier of the order
SetOrderStatus

SetOrderStatusCommand

SetOrderStatusPipeline		Sets the status of an order.

Parameters:

  • orderId: the identifier of the order
  • status: the status to be set

The following table describes the actions performed when an order is put on hold. When an order is put on hold and modified, the Commerce Engine modifies the cart that created the order.

ActionDescription
AddLineItemAdds a cart line item to an order that is on hold.

Parameters:

  • orderId: the identifier of the order
  • itemId: the identifier of the cart line item to add to the order
  • quantity: quantity of the line item to add
EditLineItemEdits a cart line item of an order that is on hold.

Parameters:

  • orderId: the identifier of the order
  • itemId: the identifier of the cart line item to edit
  • quantity: quantity of the line item to edit
DeleteLineItemDeletes a cart line item of an order that is on hold.

Parameters:

  • orderId: the identifier of the order
  • itemId: the identifier of the cart line item to delete

The following table describes the orders actions, commands and pipelines pertaining to the Sales Activity entity:

Action/Command/PipelineDescription
SalesActivitiesRetrieves one or all sales activities. If no parameter is passed, all available sales activities are returned.

Parameter:

  • SalesActivityId: the identifier of the sales activity
GetOrderSalesActivities

GetOrderSalesActivityCommand		Retrieves sales order activities pertaining to an order.

Parameter:

  • orderId: the identifier of the order
If you have suggestions for improving this article, let us know!