[ECOMMERCE-315] DOC: Checkout & Cart API changes (V2 added) Created: 10/Jul/20 Updated: 02/Jul/21 Resolved: 02/Jul/21 |
|
| Status: | Closed |
| Project: | E-commerce |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major |
| Reporter: | Julie Legendre | Assignee: | Julie Legendre |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||
| Template: |
|
||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||
| Task DoD: |
[ ]*
Doc/release notes changes? Comment present?
[ ]*
Downstream builds green?
[ ]*
Solution information and context easily available?
[ ]*
Tests
[ ]*
FixVersion filled and not yet released
[ ] 
Architecture Decision Record (ADR)
|
||||||||||||
| Epic Link: | DOC: E-commerce V1.2.5 documentation | ||||||||||||
| Sprint: | Add-Ons 42, Content Mngmt 6, Content Mngmt 7 | ||||||||||||
| Story Points: | 3 | ||||||||||||
| Description |
|
Current behaviour For the checkout, we might have incorrect resources. For instance: /checkouts/address/{cartId} New behaviour This method is setting the address of a cartId, then the correct endpoint would be: /carts/{cartId}/address But the same happens for the rest of the checkout methods From evzen in We need to update this page https://documentation.magnolia-cms.com/display/DOCS62/Checkout+endpoint+API we are adding version 2 endpoint of checkout endpointall rest-call paths are slightly changes to be more descriptive and intuitive.
setAddress @PUT @Path("/checkouts/cart/{cartId}/address") setShippingMethod @PUT @Path("/checkouts/cart/{cartId}/shippingmethod") createOrder @POST @Path("/checkouts/cart/{cartId}/order") getShippingMethods @POST @Path("/checkouts/cart/{cartId}/shippingmethods") From evzen in We need to update this page https://documentation.magnolia-cms.com/display/DOCS62/Cart+endpoint+API we are adding version 2 endpoint of cart endpoint where we have cart id as path parameter instead of form parameter in these rest-calls. Rest of rest-calls is unchanged addItem @POST @Path("/v2/carts/{cartId}/items") removeItem @DELETE @Path("/v2/carts/{cartId}/items/{itemId}") updateItemQuantity @POST @Path("/v2/carts/{cartId}/items/{itemId}") |
| Comments |
| Comment by Julie Legendre [ 30/Jul/20 ] |
|
Moving this ticket out of current sprint as i'm ooo FTR: *I*nstead of updating the rest endpoint pages, I’ve provided a bit more info in the changelog for 1.2. I will update the specific pages (this ticket) when I get back. |
| Comment by Julie Legendre [ 07/Apr/21 ] |