If you’re connecting Ordoro to a custom tool (or a third-party app that uses our API), you’ll need to create an API key in Ordoro.

An API key gives that tool permission to connect to Ordoro securely.

If you run into questions while building, our API Forum is the best place to ask and connect with our developers and community.


Topics

  1. When would I need an API key?
  2. What is an API key?
  3. How do I create an API key?
  4. Where do I find the Client ID and Client Secret?
  5. How do I delete an API key?

When would I need an API key?

You might create an API key if you are:

  • Connecting Ordoro to a custom warehouse dashboard
  • Sending order data to an internal reporting tool
  • Working with a developer who is building a custom integration for your business.

What is an API key?

An API key is a secure way for another system to connect to your Ordoro account.

Each API key includes two parts:

  • Client ID
  • Client Secret

The system you are connecting to Ordoro will need both values.

Think of the Client Secret like a password. It should be stored securely and only shared with people or systems you trust.


How do I create an API key?

  1. In Ordoro, go to Company Name → Account Settings → API Keys.
  2. Click Add an API Key.
  3. Enter a name so you’ll remember what it’s used for.
    • Examples: Warehouse Dashboard, Custom Reporting Tool, 3PL Integration
  4. Click Create New API Key.


Where do I find the Client ID and Client Secret?

After the API key is created:

  1. Click Edit next to the key.
  2. Copy the following values and store them somewhere secure:
    • Client ID
    • Client Secret

You will need both values in the system you are connecting to Ordoro.


Tips for storing your API credentials

  • Treat the Client Secret like a password.
  • Do not share it in email threads or support tickets.
  • Store it in a secure password manager or another secure system.
  • Give each integration its own API key when possible, so it is easier to manage access later.

How do I delete an API key?

If you stop using an integration or think an API key may have been exposed, you can delete that key to remove access.

Important to know before deleting a key

  • Deleting an API key is permanent.
  • Any integration using that key will stop working right away.
  • You can create a new API key at any time if you need to reconnect or replace an old one.

Deleting the API key

  1. Go to Account Settings.
  2. Click API Keys.
  3. Click Delete next to the key you want to remove.