Developer Guide

How to Use the Cargo Load Planner API

Connect Cargo Load Planner to your existing software: in-house tools, ERP systems, Excel, or anything else you use. Follow the steps below to get integrated.

1

Activate Your Trial

Start your trial of the Cargo Load Planner API by contacting us. Please provide your username, email, and company name. Once we receive your information, we'll send an email with your login password to the address you provided.

Link: Contact Us

2

Generate Your API Key

To generate an API key, first log in to Cargo Load Planner.

Go to your user profile: User Profile

Check the section labeled "Cargo Load Planner - API Keys" and use the + Add Row button to generate a new key.

User profile API key section, before generating a key
User profile · API Keys section

Once the key has been generated, you can copy it for further use.

User profile API key section, with a generated key listed
User profile · generated API key
3

Download the Demo Program

Use the link below to download the demo program. It contains JavaScript for calling the Cargo Load Planner API.

Link: Download

The index.js file inside the demo program:

JavaScript program that calls the Cargo Load Planner API
index.js · demo program

On the index.html page, paste your API key into the text box and select Show Result.

HTML demo page for calling the Cargo Load Planner API
index.html · demo program
4

Understand the Result

See the Cargo Load Planner API documentation for a full breakdown of the response fields.

Link: API Documentation

Support

Need help?

If you get stuck at any step, our team is happy to help you get connected.

Ready to capture space you're paying for?

Start a 10-day free trial. Prove the ROI on your next shipment.