Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

Catalog
Sr No.API EndpointDescriptionTasksStatusPhase
1GET /categoriesTo get the category hierarchy.
PlanningI
2GET /categories/{categoryId}This will fetch all the products of a category.
PlanningI
3GET /productsThis 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.
PlanningI
4GET /products/{productId}To get the product detail.
PlanningI
5POST /products/{productId}/reviewsTo add a review of a product.
PlanningI
6GET /offersTo list the special offers.
PlanningI

...

Shopping List
Sr No.API EndpointDescriptionTasksStatusPhase
1POST /customers/{customerPartyId}/wishlistTo Create a wishlist.
Planning
1PUT /customers/{customerPartyId}/wishlist/{wishlistId}To add a product to the wishlist.
PlanningI
2DELETE /customers/{customerPartyId}/wishlist/{wishlistId}/{productId}To remove a product from the wishlist.
PlanningI
3GET /customers/{customerPartyId}/wishlist/{wishlistId}To get the wishlist.
PlanningI

...


Checkout

...

Sr No.API EndpointDescriptionTasksStatusPhase
1POST /
cartsTo create a cart.PlanningI2PUT /carts/{cartReference}To update the cart.PlanningI3GET /carts/{cartReference}To get the complete cart.PlanningI4POST /carts/{cartReference}/deleteTo remove items from the cart.
ordersTo Create an order with all the necessary detail (items, shipping address, payment information, etc.)
PlanningI
5
2
POST
PATCH /
carts
orders/{
cartReference
orderId}/
promotionsTo apply the promo code on the cart.PlanningI6DELETE /carts/{cartReference}/promotionsTo remove an applied promotion
statuses/CANCELTo cancel an order.
PlanningI
7
3
POST
PATCH /
carts
orders/{
cartReference
orderId}/
shipping-informationTo add shipping informationPlanningI8POST /carts/{cartReference}/shipping-methodsTo add shipping methods.PlanningI9GET /carts/{cartReference}/payment-methodsTo get the available payment methodsPlanningI
items/statuses/CANCELTo Cancel order items
10GET carts/{cartReference}/totalsTo get the cart total
.
PlanningI