CommerceUpdate

This operation is used to update an existing commerce entity, update a related commerce entity of an existing commerce entity, or create, delete or update related commerce entities and relationships.

Restrictions

If the parent search criteria or the search criteria of a related commerce entity select anything other than a single commerce entity, the system will throw an exception. The system will also throw an exception if the SearchCriteria type is not supported. Also, only one top-level commerce entity can be updated at a time.

Response

Running a CommerceUpdateOperation request creates a CommerceUpdateOperationResponse.

CommerceUpdate<> Generic Class

The CommerceUpdate<> generic class constructs a CommerceUpdateOperation operation or request to send to Microsoft Multi-Channel Commerce Foundation.

Example

The following example updates the quantity of a LineItem related to a Basket.

// The example first constructs a CommerceUpdate<> object. The first parameter 
// to the generic class indetifies the commerce entity type. Notice how the 
// parent of the LineItem is used in the update operation (i.e. the Basket). 
// This is consistent across all operations.
// 
// The second parameter is the type of search that is used to find the Basket 
// commerce entity. In the example above, a ModelSearch is used which expresses 
// the query through the Model.
Var updateBasket = new CommerceUpdate<CommerceEntity>("Basket");

// Provide the search criteria to identify the basket
updateBasket.SearchCriteria.Model.Properties.Add("Name","Default");
updateBasket.SearchCriteria.Model.Id = base.UserId;
updateBasket.SearchCriteria.Model.Properties.Add("BasketType", 0);

// Create an UpdateRelatedItem<> providing it the LineItem type. Set 
// the search criteria information to locate the LineItem and add the object to 
// the related items list of the operation.
var lineItemToUpdate = new CommerceUpdateRelatedItem<CommerceEntity>(
    "LineItems"
    "LineItem");

lineItemToUpdate.SearchCriteria.Model.Id = lineitemId;
lineItemToUpdate.Model.Quantity = 2;

updateBasket.RelatedOperations.Add(lineItemToUpdate);

// ProcessRequest(updateBasket.ToRequest()) sends the UpdateOperation to Commerce Foundation 
// which returns a Response. Operation responses are always returned in the same 
// order as the operation requests. Since there is a single operation for the 
// request, the operation response is located in index 0 of the 
// response.OperationResponses.
CommerceResponse response = 
    OperationService.ProcessRequest(base.GetCurrentRequestContext(), 
                                   updateBasket.ToRequest());

CommerceUpdateOperationResponse updateResponse =
    response.OperationResponses[0] as CommerceUpdateOperationResponse;

Assert.Equals(updateResponse.Count, 1);

See Also

Other Resources

Developing with the Multi-Channel Commerce Foundation

Commerce Foundation Operations