3PL Warehouse Manager

Updated on November 5th, 2024

  • 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

Getting Started with Credential Management

A REST API credential consists of a set of unique keys, known as Client ID and Client Secret values, and is required to access our external REST API. The REST API Credentials page in 3PL Warehouse Manager's Support Portal allows you to provision your own REST API keys so that external developers can access the WMS instantly without having to send a request to Extensiv.

This article reviews how to generate a REST API credential in the Support Portal and provide your developer with REST API access keys.

Before proceeding with the instructions below, you must create a customer user in 3PL Warehouse Manager for each set of keys with a name that reflects the respective credential (e.g., TechDinamics Integration). You must assign the relevant customers to this user, but the level of access you assign to this user does not impact the permissions of the API keys.

 

This helps provide visibility to which specific connection created a transaction for auditing purposes, and the user ID associated with this user (found in the Manage Users grid) must be provided to the developer for use with the authorization call.

If you don't have access to this page or would like to grant Support Portal access to additional warehouse users, please contact your Customer Success Manager and reference our Support Portal FAQs to learn more.

 

Step 1: Create REST API keys

  1. Log in to Extensiv.
  2. Open 3PL Warehouse Manager. 
  3. Click Support in the upper-right corner. 
  4. In the Support Portal, select Manage Credentials (Beta). The Manage Credentials grid displays all existing REST API credentials.
  5. To generate new REST API keys, click Create New Credential, select External REST/Developer from the drop-down list, then click Continue.
  6. Complete each field.
    • Customer ID: Specifies which customer this set of keys is used for—this value must match the Customer ID listed in the Manage Customers grid within the WMS

      If you don't see the Customer ID values displayed in the Manage Customers grid, you can add this column by clicking the ellipsis next to a column header, selecting Columns, then choosing Customer ID.

       

    • Platform: Specifies the platform for which the credential will be used
    • Developer Contact Info: Specifies the contact information for the developer responsible for using the credential
    • Notes: Requires you to enter additional information associated with the keys, such as additional contact information, context, or anything else helpful to your operations
    • Enabled: When checked, indicates that the credential is active (or will be active once saved)
  7. Choose which roles you wish to assign to the developer by selecting one or more roles from the 'Available Roles' list (using < Ctrl > to multi-select), then clicking the top arrow pointing to the 'Selected Roles' list. Each role is defined below.

    If you're unsure which roles to assign, the following combination of roles is typically assigned to developers: CustomerView, FacilityView, InventoryDetailView, ItemView, OrderEdit, OrderView, OrderWrite, ReadPropertiesThirdParty, and ReceiverView.

     
    • C2CTransfer: Allows for inventory transfers between customers
    • CustomerEdit: Allows for modification of customer details
    • CustomerNotifyEdit: Allows for modification of customer notifications
    • CustomerNotifyView: Allows for retrieval of customer notifications
    • CustomerView: Allows for retrieval of customer details
    • FacilityEdit: Allows for modification of warehouse details
    • FacilityView: Allows for retrieval of warehouse details
    • InventoryDetailView: Allows for retrieval of inventory details
    • InventoryEdit: Allows for modification of inventory availability
    • InventoryRead: Allows for retrieval of inventory availability
    • ItemEdit: Allows for modification of item details
    • ItemView: Allows for retrieval of item details
    • OrderConfirm: Allows for closing of orders
    • OrderEdit: Allows for modification of Open and Complete orders
    • OrderImport: Allows for importing of orders
    • OrderView: Allows for retrieval of order details
    • OrderWrite: Allows for canceling and splitting of orders
    • PoEdit: Allows for modification of purchase order transactions
    • PoView: Allows for retrieval of purchase order transactions
    • ReadPropertiesThirdParty: Allows for retrieval of carriers, items, and capacity types
    • ReceiverEdit: Allows for modification of receipt details
    • ReceiverView: Allows for retrieval of receipt details
    • WritePropertiesThirdParty: Allows for retrieval of detailed carrier information
  8. Once you've selected the appropriate roles, click Save to generate the REST API keys.

Step 2: Distribute keys to your developer

Once saved, the REST API keys populate in the Credentials Management grid and you can distribute the credential to your developer for immediate use.

  1. Select the newly generated credential from the grid, then copy the Client ID and Client Secret values. Be sure to also take note of the Customer ID noted for the credential and the relevant Warehouse ID (found in the WMS under Warehouse > Manage Warehouse).
  2. Review our article on Providing REST API Access.
  3. Provide your developer with the newly generated API keys; the relevant User ID, Customer ID, and Warehouse ID values; and the article linked in Step 2.

Deprovisioning REST APIs

In order to deprovision REST API access you need to email API@extensiv.com with the connection you want to deactivate.

Contact your CSM about any invoicing matters caused by deactivating connections. 
 

management credentialing

Was this article helpful?

Yes
No
Share additional feedback about this article

Related Articles

  • Completing the API Integration Survey
  • May 14, 2020 – Minor Release Notes
  • Support Portal FAQs
  • Shipping in Small Parcel Suite

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