This article reviews next steps for external developers to access Extensiv's open REST API once they are provided with a unique set of REST API keys.
Our general Technical Support team is unable to provide deep technical and development support on the API when it is beyond credential updates, potential defects, or system/knowledge-related issues. However, we do have an active developer community at https://community.3plcentral.com. Troubleshooting questions should go through this community forum, where answers are visible to other developers who might have similar questions.
If this is your first time accessing 3PL Central Community, please specify the customer you are working with in your membership request.
Direct developer support is only available as part of a Developer Enablement package. If you're interested in learning more about Developer Enablement, please ask your warehouse representative to contact their Customer Success Manager for more information.
When using Extensiv's REST API, authorization in the HTTP header is required to request an access token (reviewed in the next section). To access your authorization key, do the following:
- Navigate to a Base64 encoder tool, such as https://www.base64encode.org/.
- Insert the Client ID value, followed by a colon and the Client Secret value (e.g., ClientID:ClientSecret), into the encoder tool.
- The encoded value is your authorization key. Use this value to request an access token.
As mentioned above, an access token is required in your HTTP header when accessing 3PL Warehouse Manager’s external REST API. For security purposes, this access token is only valid temporarily—typically between 30 and 60 minutes. It is best practice and most efficient to refresh your access token programmatically no less than every 30 minutes, as well as refresh the token when it is no longer valid.
Below is an example, of the HTTP header and JSON payload for you to gain an access token.
Content-Type: application/json; charset=utf-8
Authorization: Basic MTg2ZDczZDgtY2FmNy00MzFmLWJkMWEtY2ZmMzIzNDliZjA3OmRPemowandIWE05ZjJUbnFtWVlMOGszWTVyWGkxS1Fa
"tpl": "[Provided by warehouse]",
"user_login_id": "[Provided by warehouse]"
After submitting a successful call, Extensiv will return a response code of 200. The following JSON is typical of what will be returned:
The element, user_login_Id, is provided to you by your warehouse representative and helps provide visibility to which specific connection created a transaction for auditing purpose.
For more information on API authentication to Extensiv, visit our API documentation.
One of the most common uses of the API is to create and retrieve orders in 3PL Warehouse Manager. For more details on order API calls, see our Orders API documentation.
Retrieving inventory is another common usage of the API, and there are several methods for accomplishing this—including retrieving inventory received on and before a particular date, as well as stock summaries. For more details on inventory API calls, see our Inventory API documentation.