THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| 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 | |||||
| 1 | POST /customers | To register the customer. | |||
| 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 | POST /customers/{customerPartyId}/shipping-addresses | To create the postal address. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I |
| 7 | GET /customers/{customerPartyId}/shipping-addresses | To get the customer's postal addresses | |||
| 8 | PUT /customers/{customerPartyId}/shipping-addresses/{contactMechId} | To update the postal address and to mark the default address. | https://github.com/apache/ofbiz-plugins/pull/45 | In Code Review | I |
| 9 | DELETE /customers/{customerPartyId}/shipping-addresses/{contactMechId} | To delete/expire the postal 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 | |||
| 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 |
| 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 | I | |
Catalog
| Sr No. | API Endpoint | Description | Tasks | Status | Phase |
|---|---|---|---|---|---|
| Catalog | |||||
| 1 | GET /catalogs | To get the list of catalogs. | Planning | I | |
| 2 | GET /catalogs/{catalogId} | To get the feature categories, feature products, category hierarchy in a single call. | Planning | I | |
| 3 | GET /catalogs/{catalogId}/feature-categories | To get the feature categories of a catalog. | Planning | I | |
| 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 catalog. | Planning | I | |
| 6 | 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 | GET /products/{productId} | To get the product detail. | Planning | I | |
| 8 | 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 offers | Planning | I | |
| 15 | GET /offers/{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 it. | Planning | I | |
| 18 | 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 | |
...