---
title: "Orders actions, commands and pipelines"
slug: "orders-actions-commands-and-pipelines"
abstract: ""
---
# Orders actions, commands and pipelines

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

| **Action/Command/Pipeline** | **Description** |
| --- | --- |
| `Orders`<br><br>`GetOrderCommand`<br><br>`GetOrderPipeline` | Retrieves an order.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `CreateOrder`<br><br>`CreateOrderCommand`<br><br>`CreateOrderPipeline`<br><br>Dependent pipelines:<br><br>`ItemOrderedPipeline`<br><br>`OrderPlacedPipeline` | Creates an order. This action is performed by a shopper from a storefront web site.<br><br>Parameter:<br><br><ul><li>`id`: identifier of a cart is passed into the order</li></ul> |
| `HoldOrder `<br><br>`HoldOrderCommand `<br><br>`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.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `UndoOnHoldOrder `<br><br>`UndoOnHoldOrderCommand `<br><br>`UndoOnHoldOrderPipeline` | Undoes the changes made to an order while the order is on hold.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `CancelOnHoldOrder`<br><br>`CancelOnHoldOrderCommand`<br><br>`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.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `CancelOrder`<br><br>`CancelOrderCommand`<br><br>`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.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `ReleaseOrder`<br><br>`ReleaseOnHoldOrderCommand`<br><br>`ReleaseOnHoldOrderPipeline` | Releases an order that is on hold.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |
| `SetOrderStatus`<br><br>`SetOrderStatusCommand`<br><br>`SetOrderStatusPipeline` | Sets the status of an order.<br><br>Parameters:<br><br><ul><li>`orderId`: the identifier of the order</li><li>`status`: the status to be set</li></ul> |

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.

| Action | Description |
| --- | --- |
| `AddLineItem` | Adds a cart line item to an order that is on hold.<br><br>Parameters:<br><br><ul><li>`orderId`: the identifier of the order</li><li>`itemId`: the identifier of the cart line item to add to the order</li><li>`quantity`: quantity of the line item to add</li></ul> |
| `EditLineItem` | Edits a cart line item of an order that is on hold.<br><br>Parameters:<br><br><ul><li>`orderId`: the identifier of the order</li><li>`itemId`: the identifier of the cart line item to edit</li><li>`quantity`: quantity of the line item to edit</li></ul> |
| `DeleteLineItem` | Deletes a cart line item of an order that is on hold.<br><br>Parameters:<br><br><ul><li>`orderId`: the identifier of the order</li><li>`itemId`: the identifier of the cart line item to delete</li></ul> |

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

| **Action/Command/Pipeline** | **Description** |
| --- | --- |
| `SalesActivities` | Retrieves one or all sales activities. If no parameter is passed, all available sales activities are returned.<br><br>Parameter:<br><br><ul><li>`SalesActivityId`: the identifier of the sales activity</li></ul> |
| `GetOrderSalesActivities`<br><br>`GetOrderSalesActivityCommand` | Retrieves sales order activities pertaining to an order.<br><br>Parameter:<br><br><ul><li>`orderId`: the identifier of the order</li></ul> |