THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Sr No. | API Endpoint | Description | Tasks | Status | Phase |
---|---|---|---|---|---|
Customer Profile | |||||
1 | POST /customers | To register the customer. | Planning | I | |
2 | GET /customers/{customerPartyId}/password-hint | To get the password hint. | Planning | I | |
3 | POST /customers/reset-password | To get the reset password link on the registered email. | Planning | I | |
4 | POST /customers/{customerPartyId}/change-password | To change the password. | Planning | I | |
5 | POST /customers/{customerPartyId}/profile | To 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. | Planning | I | |
6 | PUT /customers/{customerPartyId} | To update the customer's personal information. | Planning | I | |
7 | POST /customers/{customerPartyId}/addresses | To create the postal address. | Planning | I | |
8 | PUT /customers/{customerPartyId}/addresses/{contactMechId} | To update the postal address and to mark the default address. | Planning | I | |
9 | DELETE /customers/{customerPartyId}/addresses/{contactMechId} | To delete/expire the postal address. | Planning | I | |
10 | POST /customers/{customerPartyId}/phones | To create a telecom number. | Planning | I | |
11 | PUT /customers/{customerPartyId}/phones/{contactMechId} | To update a telecom number. | Planning | I | |
12 | DELETE /customers/{customerPartyId}/phones/{contactMechId} | To delete a telecom number | Planning | I | |
13 | POST /customers/{customerPartyId}/emails | To create an email address. | Planning | I | |
14 | PUT /customers/{customerPartyId}/emails/{contactMechId} | To update an email address. | Planning | I | |
15 | DELETE /customers/{customerPartyId}/emails/{contactMechId} | To remove an email address. | Planning | 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. | Planning | I | |
17 | PUT /customers/{customerPartyId}/contact-information/{contactMechId} | To update the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc. | Planning | I | |
18 | DELETE /customers/{customerPartyId}/contact-information/{contactMechId} | To remove the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc. | Planning | I | |
19 | POST /customers/{customerPartyId}/sendEmail | To 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. | Planning | I | |
21 | PUT /customers/{customerPartyId}/credit-cards/{paymentMethodId} | To update the credit card detail and to mark it as default. | Planning | I | |
22 | DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId} | To remove a credit card. | Planning | 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 | I |
...