Inventory Planner - Enable API Access

Karl Falconer · Updated

This article is for whoever connects an Inventory Planner order source inside DropStream — a fulfillment provider (3PL) or a merchant who manages their own DropStream account. You’ll add the store through DropStream’s Add Connection wizard.

Setup with Inventory Planner is a two-way handoff: DropStream generates an SSH Public Key here, you register that key in Inventory Planner (which returns an SFTP Endpoint), and you bring the endpoint plus your API Key and Account ID back to this screen. The Inventory Planner steps are covered in Gather Your API Credentials.

What you’ll need

  • A DropStream account you can sign in to.
  • From Inventory Planner — your SFTP Endpoint, API Key, and Account ID. See Gather Your API Credentials.

How DropStream connects to Inventory Planner

Every store connects through the same Add Connection wizard. For the full walkthrough of the wizard’s steps, see Add a Connection. This article covers only the Store Setup step, where you enter the Inventory Planner-specific details.

Enter your Inventory Planner details

  1. In the Add Connection wizard, work through to the Store Setup step. Choose Create new store, give the store a Name, and select Inventory Planner as the Platform. The Inventory Planner fields appear below.

  2. In the SFTP Configuration section, DropStream has generated a Public Key. Click Copy, then register it in Inventory Planner by creating an Advanced CSV connection — see Gather Your API Credentials. That step returns your SFTP Endpoint.

    You don’t have to keep both windows open. If the person setting up Inventory Planner isn’t you, you can save the connection now without the SFTP Endpoint and add it once they send it back (see Notes below).

  3. Fill in the connection credentials:

    Field What it is Example
    API Key Your Inventory Planner API key a1b2c3d4e5…
    Account ID Your Inventory Planner account ID (the a= value in the Inventory Planner URL) 123456
    SFTP Endpoint The SFTP endpoint Inventory Planner generates for your Advanced CSV connection s-abc123.server.transfer.us-east-1.amazonaws.com

    For where to find each value, see Gather Your API Credentials.

  4. Optionally set the Purchase Order Settings. Leave these blank to import every purchase order:

    Field What it is Example
    Import Status Filter Only import purchase orders that are in this Inventory Planner status ORDERED
    Acknowledgement Status The Inventory Planner status DropStream sets on a purchase order once it’s received CLOSED
  5. Click Add connection.

You can edit any of these values later by opening the store from Connections or Stores.

Notes

  • The SFTP Endpoint is required for a fully working connection, but it’s optional when you first save. Inventory Planner only generates it after the Advanced CSV connection is created, and the person doing that may not be you — so DropStream lets you save the store without it and add it later. Until the endpoint is filled in, inventory updates can’t be delivered to Inventory Planner.
  • Keep the Public Key as-is. DropStream generates and manages the SSH key pair; the Public Key field is read-only and is the value you register in Inventory Planner.
  • After the connection details are in place, the DropStream onboarding team will help complete and validate the setup.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.