Versions Compared

Key

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

...

Sr No.API EndpointDescriptionTasksStatusPhase
1POST /guest-tokenThis API will return a token for a guest account.
PlanningI
2POST /customer-tokenThis API will return a token for the registered user.
PlanningI
3POST /refresh-tokenIn case we need to update the token. As JWT token ideally contains a certain expiry time. So if the user is active then instead of getting him to log out, this API can generate a new token from the existing token.
PlanningI


Customer

Sr No.API EndpointDescriptionTasks/PRsStatusPhase
Customer Profile
1POST /customersTo register the customer.


2GET /customers/{customerPartyId}To get the customer's personal information, addresses, emails, phones, etc.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
2
3
GET
PUT /customers/
password-hint
{customerPartyId}To
get the password hint
update the customer's personal information.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
3
4POST /customers/reset-passwordTo get the reset password link on the registered email.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
4
5POST /customers/{customerPartyId}/change-passwordTo change the password.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
5
6
GET
POST /customers/{customerPartyId}
To get the customer's personal information, addresses, emails, phones, etc.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
/addressesTo create the postal address
6PUT /customers/{customerPartyId}To update the customer's personal information
.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
7
POST
GET /customers/{customerPartyId}/addresses
To create the postal address.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI




8PUT /customers/{customerPartyId}/addresses/{contactMechId}To update the postal address and to mark the default address.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
9DELETE /customers/{customerPartyId}/addresses/{contactMechId}To delete/expire the postal address.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
10POST /customers/{customerPartyId}/credit-cardsTo create a credit card.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
11PUT /customers/{customerPartyId}/credit-cards/{paymentMethodId}To update the credit card detail and to mark it as default.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
12DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId}To remove a credit card.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
13POST /customers/{customerPartyId}/gift-cardsTo create a gift card.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
14PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId}To update the gift card detail and to mark it as default.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
15DELETE /customers/{customerPartyId}/gift-cards/{paymentMethodId}To remove the gift card.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
16POST /customers/{customerPartyId}/eft-accountsTo create an EFT account.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
17PUT /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To update the EFT account detail and to mark it as default.https://github.com/apache/ofbiz-plugins/pull/45In Code ReviewI
18DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To remove the EFT account.https://github.com/apache/ofbiz-plugins/pull/45In Code Review
I19POST /customers/{customerPartyId}/shipment-methods/{shipmentMethodId}To mark the default shipping method if there is a default shipping address.PlanningI20POST /customers/{customerPartyId}/contact-list/{contactListId}/subscriptionTo subscribe to the contact list.In ProgressI21PUT /customers/{customerPartyId}/contact-list/{contactListId/subscriptionTo unsubscribe from the contact list.In Progress
I
Order History & Return
1GET /customers/{customerPartyId}/ordersTo fetch all the orders of a customer.
PlanningI
2GET /customers/{customerPartyId}/orders/{orderId}To fetch the order detail.
PlanningI
3PUT /customers/{customerPartyId}/orders/{orderId}To update the order. Right now the support to cancel an item(partially or fully) is there. That should be handled in this API.
PlanningI
4GET /customers/{customerPartyId}/orders/{orderId}/order-pdfTo get the order pdf.
PlanningI
5GET /customers/{customerPartyId}/orders/{orderId}/invoice-pdfTo get the invoice pdf.
PlanningI
6POST /customers/{customerPartyId}/returnsTo create a return.
PlanningI


Catalog

Sr No.API EndpointDescriptionTasksStatusPhase
Catalog
1GET /catalogsTo get the list of catalogs.
PlanningI
2GET /catalogs/{catalogId}To get the feature categories, feature products, category hierarchy in a single call.
PlanningI
3GET /catalogs/{catalogId}/feature-categoriesTo get the feature categories of a catalog.
PlanningI
4GET  /catalogs/{catalogId}/feature-productsTo get the feature products of a catalog.
PlanningI
5GET /catalogs/{catalogId}/category-hierarchyTo get the category hierarchy of a catalog.
PlanningI
6GET /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
7GET /products/{productId}To get the product detail.
PlanningI
8POST /products/{productId}/reviewsTo add a review of a product.
PlanningI
9GET /products/{productId}/reviewsTo get the reviews of a product.
PlanningI
10GET /products/{productId}/associated-productsTo get the list of cross-sell/upsell products.
PlanningI
11POST /products/{productId}/product-tagsTo add a tag for a product.
PlanningI
12GET /products/{productId}/product-tagsTo get all the tags of a product.
PlanningI
13GET /products/product-tagsAll the product tags for the tag cloud.
PlanningI
14GET /offersTo list the special offers
PlanningI
15GET /offers/{promotionId}To get the complete detail of a particular offer
PlanningI
16POST /sendMailFor Tell a Friend functionality
PlanningI
17POST /products/compare-listTo create a compare list and to add a product to it.
PlanningI
18GET /products/compare-listTo get the list of added products with detail for the comparison view.
PlanningI
19DELETE /products/compare-list/{productId}To remove a product from the compare list.
PlanningI

...