Page History

...

Sr No.	API Endpoint	Description	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.

PlanningI2GET /customers/{customerPartyId}/password-hintTo get the password hint.PlanningI3POST /customers/reset-passwordTo get the reset password link on the registered email.PlanningI4POST /customers/{customerPartyId}/change-passwordTo change the password.PlanningI5

https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
2	GET

POST

/customers/{customerPartyId}

/profile

To get the

complete profile of a customer,

customer's personal information, addresses, emails, phones, etc.

There should be one filter to bring specific information like only personal information, only addresses, etc.

	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
3

PlanningI6

PUT /customers/{customerPartyId}

To update the customer's personal information.

PlanningI7POST /customers/{customerPartyId}/addressesTo create the postal address.PlanningI8PUT /customers/{customerPartyId}/addresses/{contactMechId}To update the postal address and to mark the default address.PlanningI

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

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

POST /customers/{customerPartyId}/

phones

change-password

To

create a telecom number.PlanningI11PUT /customers/{customerPartyId}/phones/{contactMechId}To update a telecom number.PlanningI

change the password.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
6	GET

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

/customers/{customerPartyId}/

emailsTo create an email address.PlanningI14PUT /customers/{customerPartyId}/emails/{contactMechId}To update an email address.PlanningI15DELETE /customers/{customerPartyId}/emails/{contactMechId}To remove an email address.PlanningI16

shipping-addresses	To get the customer's shipping addresses	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
7	POST /customers/{customerPartyId}/

contact

shipping-

information

addresses

To

add the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc.

create the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
8	PUT

PlanningI17PUT /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.PlanningI18DELETE

/customers/{customerPartyId}/

contact

shipping-

information

addresses/{contactMechId}

To

remove the other contact information like electronic address, Internet IP address, Internet Domain Name, Web Url, LDAP address, File server, etc.

update the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
9	DELETE

PlanningI19POST /customers/{customerPartyId}/sendEmailTo send the mail from the profile page to the added email address.PlanningI20POST /customers/{customerPartyId}/credit-cardsTo create a credit card.PlanningI21PUT

/customers/{customerPartyId}/

credit

shipping-

cards

addresses/{

paymentMethodId

contactMechId}

To

update the credit card detail and to mark it as default.PlanningI22DELETE /customers/{customerPartyId}/credit-cards/{paymentMethodId}To remove a credit card.PlanningI23

delete/expire the shipping address.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
10	POST /customers/{customerPartyId}/

gift

payment-

cards

methods

To

create a gift card.PlanningI24PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId}To update the gift card detail and to mark it as default.PlanningI

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

25DELETE

/customers/{customerPartyId}/

gift-cards/{paymentMethodId}

payment-methods

To

remove the gift card.PlanningI26POST /customers/{customerPartyId}/eft-accountsTo create an EFT account.PlanningI27

get the user's payment methods eg. saved credit cards, gift cards, eft accounts	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
12	PUT /customers/{customerPartyId}/

eft

payment-

accounts

methods/{paymentMethodId}

To update the

EFT account detail and to mark it as default.PlanningI28DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To remove the EFT account.PlanningI29

payment method detail.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
13	DELETE

POST

/customers/{customerPartyId}/

shipment

payment-methods/{

shipmentMethodId

paymentMethodId}

To

mark the default shipping method if there is a default shipping address.PlanningI

remove a saved credit card, gift card, eft account.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
14

30POST /customers/{customerPartyId}/contact-list/{contactListId}/subscriptionTo subscribe to the contact list.PlanningI31PUT /customers/{customerPartyId}/contact-list/{contactListId/subscriptionTo unsubscribe the contact list.PlanningIOrder History & Return1

GET /customers/{customerPartyId}/

orders

order-history

To fetch all the orders of a customer.

PlanningI2GET /customers/{customerPartyId}/orders/{orderId}To fetch the order detail.PlanningI3PUT /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.PlanningI4GET /customers/{customerPartyId}/orders/{orderId}/order-pdfTo get the order pdf.PlanningI5GET /customers/{customerPartyId}/orders/{orderId}/invoice-pdfTo get the invoice pdf.PlanningI6POST /customers/{customerPartyId}/returnsTo create a return.PlanningI

In Progress

I

Catalog

Sr No.	API Endpoint	Description	Tasks	Status	Phase

Catalog


1	GET /

catalogsTo get the list of catalogs.PlanningI2GET /catalogs/{catalogId}

Shopping List and Quotes

Wishlist

shopping-listsAdd an item to the shopping listshopping-listsshoppingListId}/itemsRemove the particular item from the shopping list

Sr No.	API Endpoint	Description	Tasks	Status	Phase
Shopping List
1	POST /	To create a new shopping list.	Planning	I	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	I	4	PUT /shopping-lists/{shoppingListId}	To update the shopping list detail. Recurrence info can also be set from this API.	Planning	I	5	POST /shopping-lists/{shoppingListId}/items	customers/{customerPartyId}/wishlist	To Create a wishlist.		Planning
1	PUT /customers/{customerPartyId}/wishlist/{wishlistId}	To add a product to the wishlist.		Planning	I
62GET	DELETE /	customers/{	Get 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}	customerPartyId}/wishlist/{wishlistId}/{productId}	To remove a product from the wishlist.		Planning	I
Quote
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 quote.	Planning	I	6	POST /order-quotes	To create an order from the quotewishlist.	Planning	I

...

Checkout

...

Sr No. API Endpoint Description Tasks Status Phase
Shopping Cart
1 POST /
cartsPlanningI2GET /carts/{cartReference}PlanningI3DELETE /carts/{cartReference}PlanningI4POST /carts/{cartReference}/itemsFor adding products and other order adjustments like shipping charges, tax, etc.PlanningI5GET /carts/{cartReference}/itemsPlanningI6PUT /carts/{cartReference}/items/{itemSeqId}PlanningI7DELETE /carts/{cartReference}/items/{itemSeqId}PlanningI8POST /carts/{cartReference}/promotionsTo apply the promo code on the cart.PlanningI9DELETE /carts/{cartReference}/promotions/{itemSeqId}To remove an applied promotion.PlanningI10POST /carts/{cartReference}/items/shopping-list/{shoppingListId}This will add all the items of a given shopping list to the cart.PlanningI11POST /carts/{cartReference}/items/order/{orderId}This will add all the items of a given past order to the cart.PlanningICheckout1POST /carts/{cartReference}/ship-groupsTo create a new ship group in case of split shipment.PlanningI2GET /carts/{cartReference}/ship-groupsTo get the ship groups with items.PlanningI3POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-addressTo add the shipping address.PlanningI4POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/itemsTo move items from one ship group to another in case of split shipment.PlanningI5POST /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 available
)
Planning I
6
2
PUT
PATCH /
carts
orders/{
cartReference
orderId}/
ship-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)PlanningI
statuses/CANCEL To cancel an order
7GET /shipping-methods}To get the shipping methods
.
Planning I
8
3
POST
PATCH /
carts
orders/{
cartReference
orderId}/
ship-groups/{shipGroupSeqId}/shipping-methodTo add/update the shipping method.PlanningI9GET /payment-optionsTo get the list of supported payment options.PlanningI10POST /carts/{cartReference}/payment-methodsTo add a payment method. The combination of the gift card and other payment methods are supported as of now.PlanningI
items/statuses/CANCEL To Cancel order items.
11POST /checkoutTo place the order.PlanningIAnonymous Checkout1POST /carts/{cartReference}/guest/personal-informationSet the anonymous user's detail for the order. Name, phone, email, etc.PlanningI2PUT /carts/{cartReference}/guest/personal-informationPlanningI3POST /carts/{cartReference}/guest/shipping-addressPlanningI4PUT /carts/{cartReference}/guest/shipping-addressPlanningI5POST /carts/{cartReference}/guest/payment-informaionPlanningI6PUT /carts/{cartReference}/guest/payment-informaion

Planning I

Space shortcuts

Child pages

Versions Compared

Old Version 34

New Version Current

Key

Customer

Catalog

Shopping List and Quotes

Wishlist

Checkout