Can't update order line properties

[orangejuice-martin]

Which component is this issue related to?

Umbraco Commerce (Core)

Which Umbraco Commerce version are you using? (Please write the exact version, example: 10.1.0)

13.2.4

Bug summary

I want to update the order line properties but I keep getting an exception that the order line is read only. I can change the quantity however.

I did use a CustomProduct that implements the ISnapshot interface to add a custom product to the basket.

Specifics

Code snippet to update a order line

 _commerceApi.Uow.Execute(uow =>
 {
     var order = _commerceApi.GetCurrentOrder(Store.Id)
                             .AsWritable(uow);
     var orderLine = order.WithOrderLine(basketLineId);
     orderLine.SetQuantity(quantity);
     orderLine.SetProperties(properties,
                             SetBehavior.Replace);

     _commerceApi.SaveOrder(order);

     uow.Complete();
 });

The exception is:

Umbraco.Commerce.Common.Validation.ValidationException: 'Can't set order line property with alias 'CutoutWidth' as the property is read only.'

Steps to reproduce

Used a custom product with a custom product adapter.

public class CustomProductPlate : IProductSnapshot
{

    #region properties

    public int Id { get; }

    public string ProductReference { get; }

    public string Sku { get; }

    public Guid StoreId { get; }

    public IEnumerable<ProductPrice> Prices { get; }

    public IDictionary<string, string> Properties { get; }

    public string Name { get; }

    public string Description { get; }

    public string ImageUrl { get; }

    public Guid? TaxClassId { get; }

    public bool IsGiftCard { get; }

    public string ProductVariantReference { get; }

    public IEnumerable<AttributeCombination> Attributes { get; }

    #endregion

    #region constructor

    public CustomProductPlate(int id, Guid key, string name, string description, string sku, string imageUrl, string productVariantReference,
                         bool isGiftCard, Guid storeId, Guid? taxClassId, IEnumerable<ProductPrice> prices,
                         IEnumerable<AttributeCombination> attributes, IDictionary<string, string> properties)
    {
        ProductReference = key.ToString();
        Id = id;
        Name = name;
        Description = description;
        Sku = sku;
        StoreId = storeId;
        Prices = prices;
        ImageUrl = imageUrl;
        TaxClassId = taxClassId;
        IsGiftCard = isGiftCard;
        Properties = properties;
        Attributes = attributes;
        ProductVariantReference = productVariantReference;
    }

#endregion   

}

Expected result / actual result

That the order line properties are updated to the new dictionary values.

Dependencies

None

[mattbrailsford]

How did you set the orderline property the first time? Properties can be marked as "readonly" which means they can only be written once which it sounds like this is what happened and when you try to update it, it throws the error you are seeing as the property is marked as read only.

[orangejuice-martin]

I implemented a CustomProductPlate which implements: the IProductSnapshot interface which only has a IDictionary<string, string> Properties.

[orangejuice-martin]

I think you mean https://docs.umbraco.com/umbraco-commerce/13.latest/key-concepts/properties#setting-properties

// Set a PropertyValue property as Read Only
order.SetProperty("propertyAlias", new PropertyValue("Property Value", isReadOnly: true));

this means i have to add the product first, then retrieve the order line to add the properties with isReadOnly: false?

The default method overloads of order.AddProduct doesn't support the isReadOnly method.

[orangejuice-martin]

Did some more testing and when I use the next code sample it does work.

  order.AddProduct(customProduct,
                   quantity,
                   properties);

So it appears that adding a property dictionary witha Snapshort interface it's marked as readonly but when you add the property dictionary to the AddProduct it's not readonly.

[mattbrailsford]

Yea, that's expected behaviour. A product snapshot is expected to be just that, a snapshot, so it's data is read only. If you need properties that you want to override, these should be added when calling AddProduct as you've found.