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

GET /getGuestToken

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 /getCustomerTokencustomer-token	This API will return a token for the registered user.	Planning	I
3	POST /refreshTokenrefresh-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
1	POST /customers	To register the customer.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
2	GET /customers/{customerPartyId}

/password-hint

To 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.

customer's personal information, addresses, emails, phones, etc.	https://github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
3

6

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

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.10

POST /customers/{customerPartyId}/

phones

change-password

To

create a telecom numberPUT

change the password.

11

https:/

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

/github.com/apache/ofbiz-plugins/pull/45	In Code Review	I
6	GET

POST

/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.16

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

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

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

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

shipping-

cards

addresses/{

paymentMethodId

contactMechId}

To

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

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.24PUT /customers/{customerPartyId}/gift-cards/{paymentMethodId}To update the gift card detail and to mark it as default.

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.26POST /customers/{customerPartyId}/eft-accountsTo create an EFT account.27

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.28DELETE /customers/{customerPartyId}/eft-accounts/{paymentMethodId}To remove the EFT account.29

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.30POST /customers/{customerPartyId}/contact-list/{contactListId}/subscriptionTo subscribe to the contact list.31PUT /customers/{customerPartyId}/contact-list/{contactListId/subscriptionTo unsubscribe the contact list.32

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

orders

order-history

To fetch all the orders of a customer.

33GET /customers/{customerPartyId}/orders/{orderId}To fetch the order detail.34PUT /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.35GET /customers/{customerPartyId}/orders/{orderId}/order-pdfTo get the order pdf.36GET /customers/{customerPartyId}/orders/{orderId}/invoice-pdfTo get the invoice pdf.37POST /customers/{customerPartyId}/returnsTo create a return.

In Progress

I

Catalog

Sr No.	API Endpoint	Description	Tasks	Status	Phase
1	GET /

catalogs

categories	To get the category hierarchy.		Planning	I
2

GET

GET /

catalogs

categories/{

catalogId

categoryId}

/feature-categories

	This will fetch all the products of a category.		Planning	I
3

3GET /catalogs/{catalogId}/feature-products4GET /catalogs/{catalogId}/category-hierarchy5

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.

6GET /products/{productId}

	Planning	I
4	GET

7POST

/products/{productId}

/reviews8GET /products/{productId}/reviews9GET /products/{productId}/associated-products10

	To get the product detail.		Planning	I
5	POST /products/{productId}/

product-tags11GET /products/{productId}/product-tags12GET /products/product-tagsAll the product tags for the tag cloud.13

reviews	To add a review of a product.		Planning	I
6	GET /offers	To list the special offers.		Planning	I

Wishlist

DELETE /products/compare-list compare list

Sr No.	API Endpoint	Description	Tasks	Status	Phase
1	POST /customers/{customerPartyId}/wishlist	To Create a wishlist.		Planning
1	PUT /customers/{customerPartyId}/wishlist/{wishlistId}	To add a product to the wishlist.		Planning	I
2	DELETE /customers/{customerPartyId}/wishlist/{wishlistId}	14	GET /offers/{promotionId}	To get the complete detail of a particular offer	15	POST /sendMail	For Tell a Friend functionality	16	POST /products/compare-list	To create a compare list and to add a product to it.	17	GET /products/compare-list	To get the list of added products with detail for the comparison view.	18	/{productId}	To remove a product from the	wishlist.

Shopping List and Quotes

PUT /shopping-listsshoppingListId}

Sr No.	API Endpoint	Description	Tasks	Status	Phase
	Planning	I
1	POST /shopping-lists	2	GET /shopping-lists	3	GET /shopping-listscustomers/{shoppingListIdcustomerPartyId}	4	/wishlist/{	5	POST /shopping-lists/{shoppingListId}/items	6	GET /shopping-lists/{shoppingListId}/items	7	PUT /shopping-lists/{shoppingListId}/items/{itemId}	8	DELETE /shopping-lists/{shoppingListId}/items/{itemId}	9	POST /quote-requests	Quotes Request can be created from the shopping list and from the cart	10	GET /quote-requests	11	GET /quote-requests/{requestId}	12	GET /quotes	13	GET /quotes/{quoteId}	14	POST /orders/quotes/{quoteId}	To create an order from the quote.

Shopping Cart & Checkout

wishlistId}

To get the wishlist.

Planning

I

Checkout

Phase

Sr No.	API Endpoint	Description	Status	Phase
1	POST /orders	To Create an order with all the necessary detail (items, shipping address, payment information, etc.)	Planning	I
2	PATCH /orders/{orderId}/statuses/CANCEL	To cancel an order.	Planning	I
3	PATCH /orders/{orderId}/items/statuses/CANCEL	To Cancel order items.	Planning	I	Sr No.	API Endpoint	Description	Tasks	Status

Space shortcuts

Child pages

Versions Compared

Old Version 13

New Version Current

Key

Purpose

API Endpoints

Authentication

Customer

Catalog

Wishlist

Shopping List and Quotes

Shopping Cart & Checkout

Checkout

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 13

New Version Current

Key

Purpose

API Endpoints

Authentication

Customer

Catalog

Wishlist

Shopping List and Quotes

Shopping Cart & Checkout

Checkout