Page History

...

Sr No.	API Endpoint	Description	Tasks/PRs	Status	Phase
Customer Profile
1	POST /customers	To register the customer.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
2	GET /customers/{customerPartyId}	To get the customer's personal information, addresses, emails, phones, etc.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
3	PUT /customers/{customerPartyId}	To update the customer's personal information.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
4	POST /customers/reset-password	To get the reset password link on the registered email.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
5	POST /customers/{customerPartyId}/change-password	To change the password.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
6	GET /customers/{customerPartyId}/shipping-addresses	To get the customer's shipping addresses	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
7	POST /customers/{customerPartyId}/shipping-addresses	To create the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
8	PUT /customers/{customerPartyId}/shipping-addresses/{contactMechId}	To update the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
9	DELETE /customers/{customerPartyId}/shipping-addresses/{contactMechId}	To delete/expire the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
10	POST /customers/{customerPartyId}/payment-methods	To save a payment method e.g. credit card, gift card, eft account	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
11	GET /customers/{customerPartyId}/payment-methods	To get the user's payment methods eg. saved credit cards, gift cards, eft accounts	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
12	PUT /customers/{customerPartyId}/payment-methods/{paymentMethodId}	To update the payment method detail.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
13	DELETE /customers/{customerPartyId}/payment-methods/{paymentMethodId}	To remove a saved credit card, gift card, eft account.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
14	GET /customers/{customerPartyId}/order-history	To fetch all the orders of a customer.		In Progress	I

...

Catalog

Sr No.	API Endpoint	Description	Status	Phase
1	GET /categories	To get the category hierarchy.	Planning	I
2	GET /categories/{categoryId}	This will fetch all the products of a category.	Planning	I
3	GET /products	This API will have support for the search string and other additional filters. This API will also bring the products of a selected category if provided.	Planning	I
4	GET /products/{productId}	To get the product detail.	Planning	I
5	POST /products/{productId}/reviews	To add a review of a product.	Planning	I
6	GET /offers	To list the special offers.	Planning	I

Wishlist

Sr No.API EndpointDescriptionTasksStatusPhaseShopping Cart

Sr No.	API Endpoint	Description	Tasks	Status	Phase
Shopping List
1	PUT /wishlist	To add a product to the wishlist.	Planning	I	2	DELETE /wishlist/{productId}	To remove a product from the wishlist.	Planning	I	3	GET POST /customers/{customerPartyId}/wishlist	To get the Create a wishlist.		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.

1

POST /cartsPlanningI2GET /carts/{cartReference}PlanningI3DELETE /carts/{cartReference}PlanningI4POST /carts/{cartReference}/items

For adding products and other order adjustments like shipping charges, tax, etc.PlanningI5GET /carts/{cartReference}/itemsPlanningI6PUT /carts/{cartReference}/items/{itemSeqId}PlanningI7DELETE /carts/{cartReference}/items/{itemSeqId}PlanningI8POST /carts/{cartReference}/promotionsTo apply the promo code on the cart.PlanningI9DELETE /carts/{cartReference}/promotions/{itemSeqId}To remove an applied promotion.PlanningI10POST /carts/{cartReference}/items/shopping-list/{shoppingListId}This will add all the items of a given shopping list to the cart

PUT /customers/{customerPartyId}/wishlist/{wishlistId}

To add a product to the wishlist.

Planning

I

11

2

POST

DELETE /

carts

customers/{

cartReference

customerPartyId}/

items/order

wishlist/{

orderId}This will add all the items of a given past order to the cart.PlanningICheckout1POST /carts/{cartReference}/ship-groupsTo create a new ship group in case of split shipment.PlanningI2GET /carts/{cartReference}/ship-groupsTo get the ship groups with items

wishlistId}/{productId}	To remove a product from the wishlist.		Planning	I
3

POST

GET /

carts

customers/{

cartReference

customerPartyId}/

ship-groups

wishlist/{

shipGroupSeqId

wishlistId}

/shipping-address

To

add the shipping address.PlanningI4POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/itemsTo move items from one ship group to another in case of split shipment.PlanningI5POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructionsTo add special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available)PlanningI6PUT /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructionsTo update special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available)PlanningI7GET /shipping-methods}To get the shipping methods

get the wishlist.

Planning

I

8POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-methodTo add/update the shipping method.PlanningI9GET /payment-optionsTo get the list of supported payment options.PlanningI10POST /carts/{cartReference}/payment-methodsTo add a payment method. The combination of the gift card and other payment methods are supported as of now.PlanningI11POST /checkoutTo place the order.PlanningIAnonymous Checkout

Checkout

Sr No.	API Endpoint	Description	Tasks	Status	Phase
1	POST /orders	To Create an order with all the necessary detail (items, shipping address, payment information, etc.)

1POST /carts/{cartReference}/guest/personal-informationSet the anonymous user's detail for the order. Name, phone, email, etc.

		Planning	I
2

PUT

PATCH /

carts

orders/{

cartReference

orderId}/

guest/personal-information

statuses/CANCEL	To cancel an order.		Planning	I
3

POST

PATCH /

carts

orders/{

cartReference

orderId}/

guest/shipping-addressPlanningI4

items/statuses/CANCEL

To Cancel order items.

PUT /carts/{cartReference}/guest/shipping-addressPlanningI5POST /carts/{cartReference}/guest/payment-informaionPlanningI6PUT /carts/{cartReference}/guest/payment-informaion

Planning

I

Space shortcuts

Child pages

Versions Compared

Old Version 56

New Version Current

Key

Wishlist

Shopping Cart & Checkout

Checkout