Access to add and change pages is restricted. See: https://cwiki.apache.org/confluence/display/OFBIZ/Wiki+access

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Purpose

The purpose of this document is to list the high-level API endpoints required for headless commerce(B2C). This will helps in finalizing API design.

API Endpoints

Authentication

Sr No.API EndpointDescriptionTasksStatusPhase
1GET /getGuestToken



2POST /getCustomerToken



3POST /refreshToken



Customer

Sr No.API EndpointDescriptionTasksStatusPhase
1POST /customersTo register the customer.


2GET /customers/{customerPartyId}/password-hintTo get the password hint.


3POST /customers/reset-passwordTo get the reset password link on the registered email.


4POST /customers/{customerPartyId}/change-passwordTo change the password.


5GET /customers/{customerPartyId}To get the full data of the customer profile.


6PUT /customers/{customerPartyId}To update the customer's personal information.


7POST /customers/{customerPartyId}/addressesTo create the postal address.


8PUT /customers/{customerPartyId}/addresses/{contactMechId}To update the postal address and to mark the default address.


9DELETE /customers/{customerPartyId}/addresses/{contactMechId}To delete/expire the postal address.


10POST /customers/{customerPartyId}/phonesTo create a telecom number.


11PUT /customers/{customerPartyId}/phones/{contactMechId}To update a telecom number.


12DELETE /customers/{customerPartyId}/phones/{contactMechId}To delete a telecom number


13POST /customers/{customerPartyId}/emailsTo create an email address.


14PUT /customers/{customerPartyId}/emails/{contactMechId}To update an email address.


15DELETE /customers/{customerPartyId}/emails/{contactMechId}To remove an email address.


16POST /customers/{customerPartyId}/contact-informationTo add the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server etc. 


17PUT /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.


18DELETE /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.


19POST /customers/{customerPartyId}/sendEmailTo send the mail from the profile page to the added email address.


20POST /customers/{customerPartyId}/credit-cardsTo create a credit card.


21PUT /customers/{customerPartyId}/credit-cards/{paymentMethodId}To update the credit card detail and to mark it as default.


22DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId}To remove a credit card.


23POST /customers/{customerPartyId}/gift-cardsTo create a gift card.


24PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId}To update the gift card detail and to mark it as default.


25DELETE /customers/{customerPartyId}/gift-cards/{paymentMethodId}To remove the gift card.


26POST /customers/{customerPartyId}/eft-accountsTo create an EFT account.


27PUT /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To update the EFT account detail and to mark it as default.


28DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To remove the EFT account.


29POST /customers/{customerPartyId}/shipment-methods/{shipmentMethodId}To mark the default shipping method if there is a default shipping address.


30POST /customers/{customerPartyId}/contact-list/{contactListId}/subscriptionTo subscribe to the contact list.


31PUT /customers/{customerPartyId}/contact-list/{contactListId/subscriptionTo unsubscribe the contact list.


























Catalog

Sr No.API EndpointDescriptionTasksStatusPhase
1




2




3




Shopping List and Quotes

Sr No.API EndpointDescriptionTasksStatusPhase
1




2




3




Shopping Cart & Checkout

Sr No.API EndpointDescriptionTasksStatusPhase
1




2




3




  • No labels