As a means to test communication with the AutoStore Interface V2, a collection of a Postman environment and requests is provided by AutoStore. Postman is an API platform for building and using APIs, and the Postman API client is a tool that can easily be used to organize and test request towards a target API (in this case AutoStore Interface V2).
The Postman API client (also known as the Postman App) can be downloaded here. Alternatively you can also use Postman via their site (as detailed in this guide), regardless the steps below will be the same.

The Postman request collection (named “AutoStore API.postman_collection.json”) contains a collection of sample requests for the different methods provided by the AutoStore Interface and the AutoStore Simulation Interface. The requests in this collection are divided into requests for the Standard AutoStore Interface and requests for the Simulation Interface.

The postman collection has been created to replace the Interface HTTP Test Client. As of v2024.5.0 of the WMS SDK Application you can now find a button to open the postman collection instead of the old Test Client as seen below:

Using the Postman collection

Clicking the "Open Postman folder" button will open up the postman collection included with your WMS SDK Install on your local machine.

The collection consists of two files; a Postman environment and a Postman request collection. Both files can be imported for use in the Postman API client.

The Postman environment file (named “AutoStore Environment.postman_environment.json”) contains definitions of the environment for the API. This consists of the server address, and endpoints for the Task Interface, Bin Interface and the Simulation Interface.

Now navigate to the postman website on your browser: https://www.postman.com/ create an account and then create a new workspace (or use the downloaded app)

Import the Postman collection

After creating a new workspace click on the "Import" button to import the two postman files from your local machine.

Click import to confirm the importing of the postman collection and environment as seen below.

Specify environment for use for testing the API

In the top right corner for the Postman application, there is a dropdown menu. By default, this might be set to “No Environment”. Click the dropdown menu, and select “AutoStore Environment” to use the server and endpoint addresses specified in the AutoStore Environment collectionas seen here:

Note: By default the AutoStore environment uses your localhost(127.0.0.1) to send the API calls to. Also ensure that the WMS SDK Simulation/Interface is running or you won't be able to reach the host.

Sending a request to AutoStore Interface

1. In order to send a request to the AutoStore Interface, first navigate to the specific method. As an example, we will use the openport method from the Task Interface. Navigate to the AutoStore API → Standard → Task Interface → Port Methods folder, and select the request named “Open Port”.
2. Click Body.
3. This will show the details for this request on the right side of the screen. In order to see and edit the XML which will be sent to the AutoStore Interface. In the Body view, the XML will be shown just the way it will be sent to the AutoStore Interface. Before sending the request, you might need to edit the parameters for that specific method. To do so, simply edit the parameters within the section of the XML in the top half part of the view.
4. Click the "Send" button.
5. The response XML from the AutoStore Interface will be shown in the bottom half of the view.
6. You will also see the response code 200 if successful.