THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|---|---|---|---|---|
| 1 | POST /shopping-lists | To create a new shopping list. | Planning | I | |
| 2 | GET /shopping-lists | To get the list of shopping lists. | Planning | I | |
| 3 | GET /shopping-lists/{shoppingListId} | To get the detail of a shopping list. This will also bring the list of available interval/frequency data for setting the recurrence detail using the update shopping list API. | Planning | I | |
| 4 | PUT /shopping-lists/{shoppingListId} | To update the shopping list detail. Recurrence info can also be set from this API. | Planning | I | |
| 5 | POST /shopping-lists/{shoppingListId}/items | Add an item to the shopping list. | Planning | I | |
| 6 | GET /shopping-lists/{shoppingListId}/items | Get the list of items on a shopping list. | Planning | I | |
| 7 | PUT /shopping-lists/{shoppingListId}/items/{itemId} | Update the particular item on the shopping list. | Planning | I | |
| 8 | DELETE /shopping-lists/{shoppingListId}/items/{itemId} | Remove the particular item from the shopping list. | Planning | I | |
| 9 | POST /quote-requests | Quotes Request can be created from the shopping list and from the cart. This API will create a quote request. | Planning | I | |
| 10 | GET /quote-requests | To get the list of quote requests(request history). | Planning | I | |
| 11 | GET /quote-requests/{requestId} | To get the detail of a quote request. | Planning | I | |
| 12 | GET /quotes | To get the list of quotes. | Planning | I | |
| 13 | GET /quotes/{quoteId} | To get the detail of a quote. | Planning | I | |
| 14 | POST /order-quotes | To create an order from the quote. | Planning | I |
Shopping Cart & Checkout
Note: The below API endpoints are written considering the Object-Oriented implementation of Shopping Cart. We need to identify the best way to store the shopping cart object as the user session won't be in the picture here. One way to introduce a new table to keep the cart object with a unique cart ID. For better performance cache can also be used efficiently. The cart object should have the last updated timestamp so that a clear policy to remove the abandoned cart can be imposed.
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|---|---|---|---|---|
| 1 | POST /carts | ||||
| 2 | GET /carts/{cartReference} | ||||
| 3 | DELETE /carts/{cartReference} | ||||
| 4 | POST /carts/{cartReference}/items | For adding products and other order adjustments like shipping charges, tax, etc. | |||
| 5 | GET /carts/{cartReference}/items | ||||
| 6 | PUT /carts/{cartReference}/items/{itemIditemSeqId} | ||||
| 7 | DELETE /carts/{cartReference}/items/{itemIditemSeqId} | ||||
| 8 | POST /carts/{cartReference}/promotions | To apply the promo code on the cart. | |||
| 9 | DELETE /carts/{cartReference}/promotions/{itemIditemSeqId} | To remove an applied promotion. | |||
| 10 | POST /carts/{cartReference}/items/shopping-list/{shoppingListId} | This will add all the items of a given shopping list to the cart. | |||
| 11 | POST /carts/{cartReference}/items/order/{orderId} | This will add all the items of a given past order to the cart. | |||
| 12 | POST /carts/{cartReference}/ship-groups | To create a new ship group in case of split shipment. | |||
| 13 | GET /carts/{cartReference}/ship-groups | To get the ship groups with items. | |||
| 14 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-address/{contactMechId} | To add the shipping address. | |||
| 15 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/items | To move items from one ship group to another in case of split shipment. | |||
| 16 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructions | To add special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available) | |||
| 17 | PUT /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructions | To update special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available) | |||
| 18 | GET /shipping-methods} | To get the shipping methods. | |||
| 19 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-method | To add/update the shipping method. | |||
| 20 | GET /payment-options | To get the list of supported payment options. | |||
| 21 | POST /carts/{cartReference}/payment-methods | To add a payment method. The combination of the gift card and other payment methods are supported as of now. | |||
| 22 | POST /checkout | To place the order. |
...