Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sr No.API EndpointDescriptionTasksStatusPhase
Catalog
1GET /catalogsTo get the list of catalogs.
PlanningI
2GET /catalogs/{catalogId}To get the feature categories, feature products, category hierarchy in a single call.
PlanningI
3GET /catalogs/{catalogId}/feature-categoriesTo get the feature categories of a catalog.
PlanningI
4GET  /catalogs/{catalogId}/feature-productsTo get the feature products of a catalog.
PlanningI
5GET /catalogs/{catalogId}/category-hierarchyTo get the category hierarchy of a catalog.
PlanningI
6GET /productsThis 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.
PlanningI
7GET /products/{productId}To get the product detail.
PlanningI
8POST /products/{productId}/reviewsTo add a review of a product.
PlanningI
9GET /products/{productId}/reviewsTo get the reviews of a product.
PlanningI
10GET /products/{productId}/associated-productsTo get the list of cross-sell/upsell products.
PlanningI
11POST /products/{productId}/product-tagsTo add a tag for a product.
PlanningI
12GET /products/{productId}/product-tagsTo get all the tags of a product.
PlanningI
13GET /products/product-tagsAll the product tags for the tag cloud.
PlanningI
14GET /offersTo list the special offers
PlanningI
15GET /offers/{promotionId}To get the complete detail of a particular offer
PlanningI
16POST /sendMailFor Tell a Friend functionality
PlanningI
17POST /products/compare-listTo create a compare list and to add a product to it.
PlanningI
18GET /products/compare-listTo get the list of added products with detail for the comparison view.
PlanningI
19DELETE /products/compare-list/{productId}To remove a product from the compare list.
PlanningI

...

Sr No.API EndpointDescriptionTasksStatusPhase
Shopping Cart
1POST /carts

PlanningI
2GET /carts/{cartReference}

PlanningI
3DELETE /carts/{cartReference}

PlanningI
4POST /carts/{cartReference}/itemsFor adding products and other order adjustments like shipping charges, tax, etc.
PlanningI
5GET /carts/{cartReference}/items

PlanningI
6PUT /carts/{cartReference}/items/{itemSeqId}

PlanningI
7DELETE /carts/{cartReference}/items/{itemSeqId}

PlanningI
8POST /carts/{cartReference}/promotionsTo apply the promo code on the cart.
PlanningI
9DELETE /carts/{cartReference}/promotions/{itemSeqId}To remove an applied promotion.
PlanningI
10POST /carts/{cartReference}/items/shopping-list/{shoppingListId}This will add all the items of a given shopping list to the cart.
PlanningI
11POST /carts/{cartReference}/items/order/{orderId}This will add all the items of a given past order to the cart.
PlanningI
Checkout
12POST /carts/{cartReference}/ship-groupsTo create a new ship group in case of split shipment.
PlanningI
13GET /carts/{cartReference}/ship-groupsTo get the ship groups with items.
PlanningI
14POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-addressTo add the shipping address.
PlanningI
15POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/itemsTo move items from one ship group to another in case of split shipment.
PlanningI
16POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-instructionsTo add special instructions, gift message in case of a gift, split preferences(ship all items together or ship items when available)
PlanningI
17PUT /carts/{cartReference}/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
18GET /shipping-methods}To get the shipping methods.
PlanningI
19POST /carts/{cartReference}/ship-groups/{shipGroupSeqId}/shipping-methodTo add/update the shipping method.
PlanningI
20GET /payment-optionsTo get the list of supported payment options.
PlanningI
21POST /carts/{cartReference}/payment-methodsTo add a payment method. The combination of the gift card and other payment methods are supported as of now.
PlanningI
22POST /checkoutTo place the order.
PlanningI
Anonymous Checkout
1POST /carts/{cartReference}/guest/personal-informationSet the anonymous user's detail for the order. Name, phone, email, etc.
PlanningI
2PUT /carts/{cartReference}/guest/personal-information

PlanningI
3POST /carts/{cartReference}/guest/shipping-address

PlanningI
4PUT /carts/{cartReference}/guest/shipping-address

PlanningI
5POST /carts/{cartReference}/guest/payment-informaion

PlanningI
6PUT /carts/{cartReference}/guest/payment-informaion

PlanningI

...