...
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|
| 1 | POST /guest-token | This API will return a token for a guest account. |
| Planning | I |
| 2 | POST /customer-token | This API will return a token for the registered user. |
| Planning | I |
| 3 | POST /refresh-token | In 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. |
| Planning | I |
Customer
| Sr No. | API Endpoint | Description | Tasks/PRs | Status | Phase |
|---|
| Customer Profile |
password-hint| {customerPartyId} | To get the |
password hintPOST reset-password get the reset password link on the registered email{customerPartyId}/change change profile get the complete profile of a customer, personal information, addresses, emails, phones, etc. There should be one filter to bring specific information like only personal information, only addresses, etc.PUT | GET /customers/{customerPartyId}/shipping-addresses | To |
update personal information. postal postal address and to mark the default address postal phonesTo create a telecom number. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I | | 11 | PUT /customers/{customerPartyId}/phones/{contactMechId} | To update a telecom number. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I |
12 | DELETE /customers/{customerPartyId}/phones/{contactMechId} | To delete a telecom number | 13POST | GET /customers/{customerPartyId}/ |
emailsTo create an email address. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I | | 14 | PUT /customers/{customerPartyId}/emails/{contactMechId} | To update an email address. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I |
| 15 | DELETE /customers/{customerPartyId}/emails/{contactMechId} | To remove an email address. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I |
16 | POST /customers/{customerPartyId}/contact-information | To add the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc. 17| 12 | PUT /customers/{customerPartyId}/ |
contactinformationcontactMechId| paymentMethodId} | To update the |
other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc18| 13 | DELETE /customers/{customerPartyId}/ |
contactinformationcontactMechId| paymentMethodId} | To remove |
the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc19POST | GET /customers/{customerPartyId}/ |
sendEmailTo send the mail from the profile page to the added email address. | Planning | I | 20 | POST /customers/{customerPartyId}/credit-cards | To create a credit card. | In Progress | I | 21 | PUT /customers/{customerPartyId}/credit-cards/{paymentMethodId} | To update the credit card detail and to mark it as default. | In Progress | I | 22 | DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId} | To remove a credit card. | In Progress | I | 23 | POST /customers/{customerPartyId}/gift-cards | To create a gift card. | Planning | I | 24 | PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId} | To update the gift card detail and to mark it as default. | Planning | I | 25 | DELETE /customers/{customerPartyId}/gift-cards/{paymentMethodId} | To remove the gift card. | Planning | I | 26 | POST /customers/{customerPartyId}/eft-accounts | To create an EFT account. | Planning | I | 27 | PUT /customers/{customerPartyId}/eft-accounts/{paymentMethodId} | To update the EFT account detail and to mark it as default. | Planning | I | 28 | DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId} | To remove the EFT account. | Planning | I | 29 | POST /customers/{customerPartyId}/shipment-methods/{shipmentMethodId} | To mark the default shipping method if there is a default shipping address. | Planning | I | 30 | POST /customers/{customerPartyId}/contact-list/{contactListId}/subscription | To subscribe to the contact list. | Planning | I | 31 | PUT /customers/{customerPartyId}/contact-list/{contactListId/subscription | To unsubscribe the contact list. | Planning | I | | Order History & Return |
1 | GET /customers/{customerPartyId}/orders | | To fetch all the orders of a customer. |
Planning | I | 2 | GET /customers/{customerPartyId}/orders/{orderId} | To fetch the order detail. | Planning | I | 3 | PUT /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. | Planning | I | 4 | GET /customers/{customerPartyId}/orders/{orderId}/order-pdf | To get the order pdf. | Planning | I | 5 | GET /customers/{customerPartyId}/orders/{orderId}/invoice-pdf | To get the invoice pdf. | Planning | I | 6 | POST /customers/{customerPartyId}/returns | To create a return. | Planning |
Catalog
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|
| Catalog |
catalogsTo get the list of catalogs. | Planning | I | 2 | GET /catalogs/{catalogId} feature categories, feature products, in a single call3GET /catalogs/{catalogId}/feature-categories | To get the feature categories of a catalog. | Planning | I | | GET /categories/{categoryId} | This will fetch all the products of a category |
4 | GET /catalogs/{catalogId}/feature-products | To get the feature products of a catalog. | Planning | I | 5 | GET /catalogs/{catalogId}/category-hierarchy | To get the category hierarchy of a catalog6| 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 |
7| 4 | GET /products/{productId} | To get the product detail. |
| Planning | I |
8| 5 | POST /products/{productId}/reviews | To add a review of a product. |
| Planning | I |
9 | GET /products/{productId}/reviews | To get the reviews of a product. | Planning | I | 10 | GET /products/{productId}/associated-products | To get the list of cross-sell/upsell products. | Planning | I | 11 | POST /products/{productId}/product-tags | To add a tag for a product. | Planning | I | 12 | GET /products/{productId}/product-tags | To get all the tags of a product. | Planning | I | 13 | GET /products/product-tags | All the product tags for the tag cloud. | Planning | I | 14 | GET /| offers | To list the special |
offersPlanning | I | 15 | GET //{promotionId}To get the complete detail of a particular offer | Planning | I | 16 | POST /sendMail | For Tell a Friend functionality | Planning | I | 17 | POST /products/compare-list | To create a compare list and to add a product to it18 | GET /products/compare-list | To get the list of added products with detail for the comparison view. | Planning | I | 19 | DELETE /products/compare-list/{productId} | To remove a product from the compare list. | Planning | I | Shopping List and Quotes
Wishlist
| Sr No. | API Endpoint | Description | Tasks | Status | Phase | Shopping List |
|---|
| 1 | POST / | shopping-listsTo create a new shopping list. | Planning | I | customers/{customerPartyId}/wishlist | To Create a wishlist | 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 |
|
| I1 | 4 | PUT /shopping-listscustomers/{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 listcustomerPartyId}/wishlist/{wishlistId} | To add a product to the wishlist. |
| Planning | I |
| 62GET | DELETE / | shopping-listscustomers/{ | shoppingListIdcustomerPartyId}/ | itemsGet 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 |
| Quote |
| wishlist/{wishlistId}/{productId} | To remove a product from the wishlist | 1 | 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 | 2 | GET /quote-requests | To get the list of quote requests(request history). |
| Planning | I |
| 3 | GET /quote-requestscustomers/{requestId} | To get the detail of a quote request. | Planning | I | 4 | GET /quotes | To get the list of quotes. | Planning | I | 5 | GET /quotes/{quoteIdcustomerPartyId}/wishlist/{wishlistId} | To get the detail of a quotewishlist. |
| Planning | I | 6 | POST /order-quotes | To create an order from the quote. | Planning | I |
...
Checkout
...
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|
| Shopping Cart |
cartsPlanning | I | 2 | GET /carts/{cartReference} | Planning | I | 3 | DELETE /carts/{cartReference} | Planning | I | 4 | POST /carts/{cartReference}/items | For adding products and other order adjustments like shipping charges, tax, etc. | Planning | I | 5 | GET /carts/{cartReference}/items | Planning | I | 6 | PUT /carts/{cartReference}/items/{itemSeqId} | Planning | I | 7 | DELETE /carts/{cartReference}/items/{itemSeqId} | Planning | I | 8 | POST /carts/{cartReference}/promotions | To apply the promo code on the cart. | Planning | I | 9 | DELETE /carts/{cartReference}/promotions/{itemSeqId} | To remove an applied promotion. | Planning | I | 10 | POST /carts/{cartReference}/items/shopping-list/{shoppingListId} | This will add all the items of a given shopping list to the cart. | Planning | I | 11 | POST /carts/{cartReference}/items/order/{orderId} | This will add all the items of a given past order to the cart. | Planning | I | | Checkout |
1 | POST /carts/{cartReference}/ship-groups | To create a new ship group in case of split shipment. | Planning | I | 2 | GET /carts/{cartReference}/ship-groups | To get the ship groups with items. | Planning | I | 3 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-address | To add the shipping address. | Planning | I | 4 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/items | To move items from one ship group to another in case of split shipment. | Planning | I | 5 | POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructions | | orders | To Create an order with all the necessary detail (items, shipping address, payment information, etc. |
To add special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available6PUT cartscartReferenceship-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) | Planning | I | | statuses/CANCEL | To cancel an order |
7 | GET /shipping-methods} | To get the shipping methods8POST cartscartReferenceship-groups/{shipGroupSeqId}/shipping-methodTo add/update the shipping method. | Planning | I | 9 | GET /payment-options | To get the list of supported payment options. | Planning | I | 10 | 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. | Planning | I | | items/statuses/CANCEL | To Cancel order items. |
11 | POST /checkout | To place the order. | Planning | I | | Anonymous Checkout |
1 | POST /carts/{cartReference}/guest/personal-information | Set the anonymous user's detail for the order. Name, phone, email, etc. | Planning | I | 2 | PUT /carts/{cartReference}/guest/personal-information | Planning | I | 3 | POST /carts/{cartReference}/guest/shipping-address | Planning | I | 4 | PUT /carts/{cartReference}/guest/shipping-address | Planning | I | 5 | POST /carts/{cartReference}/guest/payment-informaion | Planning | I | 6 | PUT /carts/{cartReference}/guest/payment-informaion