This article describes how to call the Infosys Equinox Platform using Postman.

Overview

Postman is a powerful tool used to explore and invoke Web APIs.

Getting Ready

This document assumes that you have received access to a Business and Store and have registered an account on Infosys Equinox. If you have not yet requested a business, please send an email request to devportal@infosysequinox.com that includes your name, company, and email address.

• If you need a refresher on Account Registration and Login, please see  Account Creation and Login/.

Once you have access to your Business, you will want to have followed the steps outlined at How to retrieve business ID/ to locate your:

1. Business ID
2. Business Secret Keys
3. API Gateway Keys
4. Store ID
5. Default Catalog Collection ID

You should also have created a Customer account on your store for testing and know its password. If you are unfamiliar with Postman, please find additional details on how to download and setup Postman at https://developer.infosysequinox.com/dev-center/how-to-setup-postman. Included in those instructions are steps for importing the Postman collection at https://www.getpostman.com/collections/3a9000dd305ee72bd2e7 and the Environment file at https://duseqpxtuo98y.cloudfront.net/enablement82/cloud-060319_postman_environment.json.

Making Calls via Postman

You need to edit your environment to set the businessId, storeId, API Gateway Keys, and collectionId. The Postman collection has several sections. We will start with Orchestration, which as you might expect is focused on the Storefront Orchestration (SFO) APIs. Within Orchestration you will find Catalog, Cart Checkout, and Customers sections. We’ll start with Catalog.

Catalog

These form a sequence. We can call Guest Login, which will login as a guest and establish a sessionId. A script within the call saves the sessionId in the Postman Environment where it is used over the next several calls.

If you peek in the call section of the call, you will see the test script.

This simply parses the response, and captures the sessionId, storing it in the environment as SFOUserSessionId.  We can then look at categories:

And then a Product List Page (PLP):

And a product detail page (PDP).  There is a second collection which shows customer calls, and then a collection which shows how to manage a cart, and check it out:

Cart Checkout

Checkout Flow:

1. Customer login
2. Add item one
3. Update Bag attributes address
4. Update Bag attributes communication preferences
5. Add payment
6. Submit order
7. Get order

Exercise

• Start by stepping through the cart checkout flow above
  • You may do a view bag at any time, and a review order prior to the submit order call.
• Once you have created your order you can view it with get order.
  • The order will remain in the viewable state, and then the backend will automatically fulfill it.
• Should you get the bag in an invalid state, you may always delete it and start over.

Revision History
2022-04-10 | JP – Fixed link and http issues.
2020-03-27 | JP – Minor edits.
2019-07-03 | PLK – Minor formatting edits.
2019-06-12 | PLK – Page added and content uploaded.