Page History

...

Sr No.	API Endpoint	Description
1	POST /customers	To register the customer.
2	GET /customers/{customerPartyId}/password-hint	To get the password hint.
3	POST /customers/reset-password	To get the reset password link on the registered email.
4	POST /customers/{customerPartyId}/change-password	To change the password.
5	GET /customers/{customerPartyId}	To get the full data of the customer profile.
6	PUT /customers/{customerPartyId}	To update the customer's personal information.
7	POST /customers/{customerPartyId}/addresses	To create the postal address.
8	PUT /customers/{customerPartyId}/addresses/{contactMechId}	To update the postal address and to mark the default address.
9	DELETE /customers/{customerPartyId}/addresses/{contactMechId}	To delete/expire the postal address.
10	POST /customers/{customerPartyId}/phones	To create a telecom number.
11	PUT /customers/{customerPartyId}/phones/{contactMechId}	To update a telecom number.
12	DELETE /customers/{customerPartyId}/phones/{contactMechId}	To delete a telecom number
13	POST /customers/{customerPartyId}/emails	To create an email address.
14	PUT /customers/{customerPartyId}/emails/{contactMechId}	To update an email address.
15	DELETE /customers/{customerPartyId}/emails/{contactMechId}	To remove an email address.
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	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.
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.
19	POST /customers/{customerPartyId}/sendEmail	To send the mail from the profile page to the added email address.
20	POST /customers/{customerPartyId}/credit-cards	To create a credit card.
21	PUT /customers/{customerPartyId}/credit-cards/{paymentMethodId}	To update the credit card detail and to mark it as default.
22	DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId}	To remove a credit card.
23	POST /customers/{customerPartyId}/gift-cards	To create a gift card.
24	PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId}	To update the gift card detail and to mark it as default.
25	DELETE /customers/{customerPartyId}/gift-cards/{paymentMethodId}	To remove the gift card.
26	POST /customers/{customerPartyId}/eft-accounts	To create an EFT account.
27	PUT /customers/{customerPartyId}/eft-accounts/{paymentMethodId}	To update the EFT account detail and to mark it as default.
28	DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId}	To remove the EFT account.
29	POST /customers/{customerPartyId}/shipment-methods/{shipmentMethodId}	To mark the default shipping method if there is a default shipping address.
30	POST /customers/{customerPartyId}/contact-list/{contactListId}/subscription	To subscribe to the contact list.
31	PUT /customers/{customerPartyId}/contact-list/{contactListId/subscription	To unsubscribe the contact list.
32	GET /customers/{customerPartyId}/orders	To fetch all the orders of a customer.
33	GET /customers/{customerPartyId}/orders/{orderId}	To fetch the order detail.
34	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.
35	GET /customers/{customerPartyId}/orders/{orderId}/order-pdf	To get the order pdf.
36	GET /customers/{customerPartyId}/orders/{orderId}/invoice-pdf	To get the invoice pdf.
37	POST /customers/{customerPartyId}/returns	To create a return.

Catalog

Sr No.	API Endpoint	Description	Tasks	Status	Phase
1
2
3

...

Space shortcuts

Child pages

Versions Compared

Old Version 9

New Version 10

Key

Catalog