Orders actions, commands and pipelines
The following table describes the actions, commands and pipelines pertaining to the Order entity:
|
Action/Command/Pipeline |
Description |
|
|
Retrieves an order. Parameter:
|
|
Dependent pipelines:
|
Creates an order. This action is performed by a shopper from a storefront web site. Parameter:
|
|
|
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:
|
|
|
Undoes the changes made to an order while the order is on hold. Parameter:
|
|
|
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:
|
|
|
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:
|
|
|
Releases an order that is on hold. Parameter:
|
|
|
Sets the status of an order. Parameters:
|
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 |
|---|---|
|
|
Adds a cart line item to an order that is on hold. Parameters:
|
|
|
Edits a cart line item of an order that is on hold. Parameters:
|
|
|
Deletes a cart line item of an order that is on hold. Parameters:
|
The following table describes the orders actions, commands and pipelines pertaining to the Sales Activity entity:
|
Action/Command/Pipeline |
Description |
|
|
Retrieves one or all sales activities. If no parameter is passed, all available sales activities are returned. Parameter:
|
|
|
Retrieves sales order activities pertaining to an order. Parameter:
|