3PL Warehouse Manager

Updated on August 2nd, 2023

  • Extensiv Hub
    Popular Articles Getting Started Using Hub Technical Issues & FAQs Extensiv's Ideas Portal
  • 3PL Warehouse Manager
    Receiving Operations Inventory Management Shipping Operations System Configuration Scanning Operations Integrations Content Best Practice Resources Release Notes Popular Articles Troubleshooting Guides
  • Warehouse Management
    Getting Started Admin Console Shipping Order Picking & Packing Receiving Customer Portal Cycle Counting Kit Building Managing Users Barcode Scanner Import/Export Integrations Barcoding Wave Picking Bin Move Mobile Receiving and Picking Settings Popular Articles Reporting
  • Order Management
    Dashboard Orders Inventory Purchase Orders Shipments Customers Products Analytics Settings API API Integrations Accessing and Navigating Order Manager Error Messages Order Manager Popular Articles Accounting Integrations
  • Integration Management
    Getting Started with Integration Manager General Support Troubleshooting Extras & Addons API Documentation Popular Articles Order Sources Order Destinations
  • FAQs
  • Network Manager
    Getting Started Order Routing Management Technical Issues Shopping Carts Settings Settings, Products, and Orders
  • Billing Manager
    Getting Started Using Billing Manager
  • Release Notes
    Extensiv Sandbox Extensiv Extensiv Hub 3PL Warehouse Manager Integration Management Warehouse Management Order Management Billing Manager
  • Fulfillment Marketplace
    Getting Started
  • Sandbox
    Getting Started
+ More
  • Help Center
  • 3PL Warehouse Manager
  • Integrations Content
  • REST API
  • Integrations Content
    • API Shopping Cart Integrations
        • Getting Started with Shopping Cart Integrations
        • ShipStation Integration
        • Shopify Shopping Cart Connection
        • WooCommerce Shopping Cart Connection
        • Amazon Shopping Cart Connection
        • Magento 2.x Shopping Cart Connection
        • Volusion Shopping Cart Connection
        • eBay Shopping Cart Connection
    • EDI Processes
        • Getting Started with an EDI Integration
        • Extensiv UCC Carton Label Library
        • EDI Processing
        • Setting Up FTP Email Notifications
        • Sending Receipt Advice
        • Printing UCC Labels
        • Sending an ASN
        • Troubleshooting ASN Errors
        • Using the Customer Error Log
        • Understanding Common EDI Errors
    • DataDocks
        • Understanding DataDocks
        • Using the 3PL Warehouse Manager and DataDocks Integration
    • General Information
        • Whitelisting IP Addresses
    • QuickBooks Desktop
        • Connecting a QuickBooks Desktop Account
        • Connecting Customers to QuickBooks Desktop
        • Understanding Class Tracking
        • Understanding QuickBooks Desktop Billing Setup
    • QuickBooks Online
        • Connecting a QuickBooks Online Account
        • Connecting Customers to QuickBooks Online
        • Configuring Invoice Settings
        • Defining International Tax Codes
        • Understanding QuickBooks Online Billing Setup
    • REST API
        • Getting Started with Credential Management
        • Providing REST API Access
        • Webhooks FAQs
        • Configuring Webhooks
        • Implementing Webhooks
    • Shopify
        • Changing your fulfillment settings in the Shopify app
        • Shopify App Write Fulfillment Permissions

Providing REST API Access

This article reviews the next steps for external developers to access Extensiv's open REST API once they are provided with a unique set of REST API keys.

API support

Our general Technical Support team is unable to provide deep technical and within 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.extensiv.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 Extensiv Community, please specify the customer you are working within 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.

Authorization key

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:

  1. Navigate to a Base64 encoder tool, such as https://www.base64encode.org/.
  2. Insert the Client ID value, followed by a colon and the Client Secret value (e.g., ClientID:ClientSecret), into the encoder tool.
  3. The encoded value is your authorization key. Use this value to request an access token.

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 the 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.

Header

POST https://secure-wms.com/AuthServer/api/Token

Content-Type: application/json; charset=utf-8

Accept: application/json

Host: secure-wms.com

Accept-Language: Content-Length

Accept-Encoding: gzip,deflate,sdch

Authorization: Basic MTg2ZDczZDgtY2FmNy00MzFmLWJkMWEtY2ZmMzIzNDliZjA3OmRPemowandIWE05ZjJUbnFtWVlMOGszWTVyWGkxS1Fa

JSON

{

"grant_type": "client_credentials",

"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:

{

"access_token": "eyJ0eXAi….25lNRk",

"token_type": "Bearer",

"expires_in": 0,

"refresh_token": null,

"scope": null

}

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 purposes.

 

For more information on API authentication to Extensiv, visit our API documentation.

 

Orders

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.

Inventory

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.

access rest api

Was this article helpful?

Yes
No
Share additional feedback about this article

Related Articles

  • Entering Order Line Items
  • Managing Retailers
  • Entering Basic Item Details
  • March 10, 2020 – Minor Release Notes

Not finding the help you need?

Contact Support
Solutions
  • Solutions for Brands
  • Solutions for 3PLs
  • Solutions for 4PLs
  • Solutions for B2B
Products
  • Extensiv 3PL Warehouse Manager
  • Extensiv Warehouse Manager
  • Extensiv Order Manager
  • Extensiv Integration Manager
  • Extensiv Network Manager
Products
  • Customer Success
  • Implementation
  • Consulting
Ecosystem
  • Fulfillment Marketplace
  • Integrations
  • Partners
  • Become a Partner
Resources
  • Resource Library
  • Blog
  • Market Insights
  • What is a 3PL?
  • What is a 4PL?
  • What is a WMS?
  • Why a Cloud-based WMS?
  • Glossary
Help
  • Help Center
  • API Documentation
  • Extensiv Univerisity
  • Community
  • System Status
  • Extensiv Logo
  • 100 N Pacific Coast Hwy, Suite 1100, El Segundo, CA 90245
  • |
  • Contact Us:
  • 83-EXTENSIV 888.375.2368 (main)
  • |
  • 310.844.7570 (local)
  • Copyright © 2023 Extensiv
  • |
  • All rights reserved.
  • Privacy Policy
  • |
  • Terms of Service
  • Follow Us:
Expand