Shipwell API

The Shipwell Developer Hub

Welcome to the Shipwell developer hub. You'll find comprehensive guides and documentation to help you start working with Shipwell API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Postman

Exploring the Shipwell's API with Postman collections

Postman is a very popular and capable platform for working with and testing REST APIs. While you are in the exploratory stage with the Shipwell API, we recommend Postman as a platform for familiarizing yourself with the various endpoints exposed through the API. Postman is a feature-rich application that can run as a Chrome app or natively in Windows or Mac OSX.

Installation

The first step is to get Postman installed on your computer. Because Postman is provided as a Chrome App as well as a native application for Windows and Mac OSX, you will want to pick the installation that makes the most sense for your development environment and processes. Visit the Postman website, download the appropriate installation package, and install as instructed here

1) Download the Swagger specification for the latest version of Shipwell's API. Shipwell provides a downloadable postman collection here

2) Import the swagger file to Postman as a collection. Go to import -> import file, and select the swagger file downloaded in step 1.

3) Verify that the collection was successfully imported

4) Create a production user token and create two variables. a baseUrl variable with the appropriate environment and version of the app. E.g. https://api.shipwell.com/v2 and a variable that specifies the authorization_token either a API KEY or a User Token. The picture below shows a production user environment that points to v2 of Shipwell's production api. Note the default baseUrl will be specified as a variable in the collection which is found under the edit collection modal.

the baseURL must be one of the environments here Environments

Key Type
environment
baseUrl
authorization_token

User based token

sandbox

Token <YOUR_USER_TOKEN>

API based token

production

APIkey <YOU_API_TOKEN>

It is best practice to setup a user based environment and an api key based token. This is because some API endpoints require a user (e.g. posting to a loadboard) and some can just be an API (e.g. creating purchase orders)

Testing Your Postman Environment

Once you have setup a environment, you will want to test an endpoint. Navigate to the purchase orders endpoints and find the get endpoint for purchase orders. Navigate to the headers tab and use the authorization variable defined in the aforementioned steps. You may need to uncheck all of the params in the params tab, or set them to the appropriate query params you would like to test.

Once you have put in the variable, simply hit send and verify that you get a list of locations returned by the endpoint as shown in the figure below. Use this endpoint to test for your user based token and api based token.

Updated 14 days ago

Postman


Exploring the Shipwell's API with Postman collections

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.