Storefront API - Cant unset a shipping method or payment method against a cart

[johnk-granite]

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)

15.3.12--preview.11.g0b2d153

Bug summary

Trying to edit a cart via the storefront API and while I can set a payment method or shipping method, I cant unset one (ie, remove the selected method from the cart). So I can change it from A to B, but I cant simply remove whatever is selected. Have tried passing both null and an empty string. When null, nothing happens but an empty string causes an error.

Specifics

curl -X 'PATCH'
'https://localhost:44343/umbraco/commerce/storefront/api/v1/order/4aeb316a-5e4b-4f20-a0d9-01991a5f4b6c'
-H 'accept: application/json'
-H 'Api-Key: xxxxxxxxxxxxxxxx'
-H 'Store: xxxxxxxxxxxxxxxx'
-H 'Content-Type: application/json'
-d '{"shippingMethod":"","paymentMethod":""}'

{
"type": "Error",
"title": "Could not parse supplied value. (Parameter 's')",
"status": 500,
"detail": " at Umbraco.Commerce.Cms.Web.Api.Json.IdOrAliasJsonConverter.Read(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options)\r\n at System.Text.Json.Serialization.JsonConverter1.TryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value, Boolean& isPopulatedValue)\r\n at System.Text.Json.Serialization.Metadata.JsonPropertyInfo1.ReadJsonAndSetMember(Object obj, ReadStack& state, Utf8JsonReader& reader)\r\n at System.Text.Json.Serialization.Converters.ObjectDefaultConverter1.OnTryRead(Utf8JsonReader& reader, Type typeToConvert, JsonSerializerOptions options, ReadStack& state, T& value)\r\n at System.Text.Json.Serialization.JsonConverter1.ReadCore(Utf8JsonReader& reader, T& value, JsonSerializerOptions options, ReadStack& state)\r\n at System.Text.Json.Serialization.Metadata.JsonTypeInfo1.DeserializeAsync(Stream utf8Json, CancellationToken cancellationToken)\r\n at System.Text.Json.Serialization.Metadata.JsonTypeInfo1.DeserializeAsObjectAsync(Stream utf8Json, CancellationToken cancellationToken)\r\n at Microsoft.AspNetCore.Mvc.Formatters.SystemTextJsonInputFormatter.ReadRequestBodyAsync(InputFormatterContext context, Encoding encoding)\r\n at Microsoft.AspNetCore.Mvc.Formatters.SystemTextJsonInputFormatter.ReadRequestBodyAsync(InputFormatterContext context, Encoding encoding)\r\n at Microsoft.AspNetCore.Mvc.ModelBinding.Binders.BodyModelBinder.BindModelAsync(ModelBindingContext bindingContext)\r\n at Microsoft.AspNetCore.Mvc.ModelBinding.ParameterBinder.BindModelAsync(ActionContext actionContext, IModelBinder modelBinder, IValueProvider valueProvider, ParameterDescriptor parameter, ModelMetadata metadata, Object value, Object container)\r\n at Microsoft.AspNetCore.Mvc.Controllers.ControllerBinderDelegateProvider.<>c__DisplayClass0_0.<g__Bind|0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.g__Awaited|13_0(ControllerActionInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|25_0(ResourceInvoker invoker, Task lastTask, State next, Scope scope, Object state, Boolean isCompleted)\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Rethrow(ResourceExecutedContextSealed context)\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.Next(State& next, Scope& scope, Object& state, Boolean& isCompleted)\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.InvokeFilterPipelineAsync()\r\n--- End of stack trace from previous location ---\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)\r\n at Microsoft.AspNetCore.Mvc.Infrastructure.ResourceInvoker.g__Awaited|17_0(ResourceInvoker invoker, Task task, IDisposable scope)\r\n at Umbraco.Cms.Web.Common.Middleware.BasicAuthenticationMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<b__0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at Umbraco.Cms.Api.Management.Middleware.BackOfficeExternalLoginProviderErrorMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<b__0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIMiddleware.Invoke(HttpContext httpContext)\r\n at Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext, ISwaggerProvider swaggerProvider)\r\n at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)\r\n at Microsoft.AspNetCore.Session.SessionMiddleware.Invoke(HttpContext context)\r\n at Microsoft.AspNetCore.Localization.RequestLocalizationMiddleware.Invoke(HttpContext context)\r\n at Microsoft.AspNetCore.Authorization.AuthorizationMiddleware.Invoke(HttpContext context)\r\n at Microsoft.AspNetCore.Authentication.AuthenticationMiddleware.Invoke(HttpContext context)\r\n at StackExchange.Profiling.MiniProfilerMiddleware.Invoke(HttpContext context) in C:\projects\dotnet\src\MiniProfiler.AspNetCore\MiniProfilerMiddleware.cs:line 112\r\n at Umbraco.Cms.Web.Common.Middleware.UmbracoRequestMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Umbraco.Cms.Web.Common.Middleware.UmbracoRequestMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<b__0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at Umbraco.Cms.Web.Common.Middleware.PreviewAuthenticationMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<b__0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at Umbraco.Cms.Web.Common.Middleware.UmbracoRequestLoggingMiddleware.InvokeAsync(HttpContext context, RequestDelegate next)\r\n at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.InterfaceMiddlewareBinder.<>c__DisplayClass2_0.<b__0>d.MoveNext()\r\n--- End of stack trace from previous location ---\r\n at SixLabors.ImageSharp.Web.Middleware.ImageSharpMiddleware.Invoke(HttpContext httpContext, Boolean retry)\r\n at Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddlewareImpl.g__Awaited|10_0(ExceptionHandlerMiddlewareImpl middleware, HttpContext context, Task task)",
"instance": "ArgumentException"
}

Steps to reproduce

Assign a shipping and/or payment method to a cart.

Using the storefront API, make a PATCH call to
/umbraco/commerce/storefront/api/v1/order/{orderId}
{"shippingMethod":null,"paymentMethod":null}
OR
{"shippingMethod":"","paymentMethod":""}

Expected result / actual result

Expected result is that any selected payment method or shipping method on the selected order should be removed, essentially to the state before a payment method or shipping method was selected.

Actual result is when passing null, nothing happens. Payment method and shipping method remain associated with the cart.

When passing an empty string I get the error above. Payment method and shipping method remain associated with the cart.

Dependencies

No response

---

This item has been added to our backlog AB#56450

[mattbrailsford]

Ok, I think I've got a fix for this in place and I've pushed a 15.3.12--preview.13 build to our nightly feed if you want to give it a try.

Essentially there should now be a difference between omitting the shippingMethod and paymentMethod properties and setting them to null. So if they are omitted then no update will take place, but if they are set to null or have a value, they will get updated (with null clearing their value)

Could you give the nightly build a try and confirm if this resolves your issues?

[johnk-granite]

@mattbrailsford I'm trying the nightly now and I'm hitting a new issue around shippingMethod and paymentMethod.

I create the order via POST to /umbraco/commerce/storefront/api/v1/orders setting the language, currency, and customer reference. Then on a second call I set the customer details, shipping address, and billing address via PATCH to /umbraco/commerce/storefront/api/v1/order/{orderId} - this second call is now failing with a message that both payment method and shipping method are required fields - even when I post a null for them so those fields don't seem to be optional any more.

Typically I'd omit them completely on this call as I'm not trying to set or unset them, just including them now as a test but it still doesn't let me proceed.

My json for the PATCH
{"customer":{"firstName":"John","lastName":"Eleven","email":"john1\u002B11@granite.ie","telephone":"0123456789","mobile":"0123456789"},"billingAddress":{"line1":"billing 1","line2":"billing 2","city":"delivery county","zipCode":"def6789","country":"fc878e51-a389-458d-9c32-019363fc5c5b"},"shippingAddress":{"line1":"delivery1","line2":"delivery2","city":"delivery county","zipCode":"abc1234","country":"fc878e51-a389-458d-9c32-019363fc5c5b","contact":{"firstName":"John","lastName":"Eleven","email":"john1\u002B11@granite.ie","telephone":"0123456789","mobile":"0123456789"}},"redeem":[],"unredeem":[],"shippingMethod":null,"paymentMethod":null}

Response
{"type":"https://tools.ietf.org/html/rfc9110#section-15.5.1","title":"One or more validation errors occurred.","status":400,"errors":{"PaymentMethod":["The PaymentMethod field is required."],"ShippingMethod":["The ShippingMethod field is required."]},"traceId":"00-e6ee5dbc89129555a58e462cc1c0bbe1-d8a38b96c3ff0d59-00"}

[mattbrailsford]

Ok let me take another look tomorrow. I’ll setup a full test our end to check your same scenario

[mattbrailsford]

There is a new 15.3.12--preview.15 build on the nightly feed for you to try. I've tested all 3 options via the swagger UI so these should now be working

• Unset > Nothing changes on the order
• Null > The value is cleared
• Value > The value is updated to the supplied value

[johnk-granite]

Thanks @mattbrailsford its working for me now across all 3 options with 15.3.12--preview.15

[mattbrailsford]

Excellent. Thanks for confirming. I'll close this issue and get that update rolled out by the end of the week.