Quickstart

Create a key, send one request, read the plan.

Create an API key

In the developer console, open API keys and create a key. The secret is shown once.

Bash

export CARGODUO_API_KEY="cd_live_..."

Create a job

?wait=60 answers with the finished job when it ends within 60 s.

curl -X POST "https://runner.cargoduo.com/v1/pack?wait=60" \
  -H "Authorization: Bearer $CARGODUO_API_KEY" \
  -H "Idempotency-Key: order-1042-v1" \
  -H "Content-Type: application/json" \
  -d '{
    "reference": "order-1042",
    "vehicles": [
      {
        "id": "trailer",
        "type": "trailer",
        "name": "13.6 m trailer",
        "length": 1360,
        "width": 245,
        "height": 270,
        "max_weight": 24000
      }
    ],
    "items": [
      {
        "id": "pallet-eu",
        "label": "Euro pallet",
        "length": 120,
        "width": 80,
        "height": 140,
        "weight": 450,
        "quantity": 18,
        "stackable": false
      },
      {
        "id": "carton-a",
        "label": "Carton A",
        "length": 60,
        "width": 40,
        "height": 40,
        "weight": 12,
        "quantity": 40,
        "rotation": "upright"
      }
    ],
    "options": {
      "packing_mode": "auto"
    }
  }'

const res = await fetch("https://runner.cargoduo.com/v1/pack?wait=60", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
    "Idempotency-Key": "order-1042-v1",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reference": "order-1042",
    "vehicles": [
      {
        "id": "trailer",
        "type": "trailer",
        "name": "13.6 m trailer",
        "length": 1360,
        "width": 245,
        "height": 270,
        "max_weight": 24000
      }
    ],
    "items": [
      {
        "id": "pallet-eu",
        "label": "Euro pallet",
        "length": 120,
        "width": 80,
        "height": 140,
        "weight": 450,
        "quantity": 18,
        "stackable": false
      },
      {
        "id": "carton-a",
        "label": "Carton A",
        "length": 60,
        "width": 40,
        "height": 40,
        "weight": 12,
        "quantity": 40,
        "rotation": "upright"
      }
    ],
    "options": {
      "packing_mode": "auto"
    }
  }),
});

const data = await res.json();
console.log(res.status, data);

import os
import requests

response = requests.post(
    "https://runner.cargoduo.com/v1/pack",
    headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}", "Idempotency-Key": "order-1042-v1"},
    params={
        "wait": 60,
    },
    json={
        "reference": "order-1042",
        "vehicles": [
            {
                "id": "trailer",
                "type": "trailer",
                "name": "13.6 m trailer",
                "length": 1360,
                "width": 245,
                "height": 270,
                "max_weight": 24000,
            },
        ],
        "items": [
            {
                "id": "pallet-eu",
                "label": "Euro pallet",
                "length": 120,
                "width": 80,
                "height": 140,
                "weight": 450,
                "quantity": 18,
                "stackable": False,
            },
            {
                "id": "carton-a",
                "label": "Carton A",
                "length": 60,
                "width": 40,
                "height": 40,
                "weight": 12,
                "quantity": 40,
                "rotation": "upright",
            },
        ],
        "options": {
            "packing_mode": "auto",
        },
    },
)
print(response.status_code, response.json())

Finished in time: 200, status: "succeeded", the plan in result. Still running: 202, go to step 3.

Poll until it ends

curl "https://runner.cargoduo.com/v1/jobs/$JOB_ID?include=result" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

async function waitForJob(job) {
  while (job.status === "queued" || job.status === "running") {
    await new Promise((r) => setTimeout(r, 2000));
    const res = await fetch(`https://runner.cargoduo.com/v1/jobs/${job.id}?include=result`, {
      headers: { Authorization: `Bearer ${process.env.CARGODUO_API_KEY}` },
    });
    job = await res.json();
  }
  return job;
}

import os, time, requests

def wait_for_job(job):
    headers = {"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}"}
    while job["status"] in ("queued", "running"):
        time.sleep(2)
        job = requests.get(f"https://runner.cargoduo.com/v1/jobs/{job['id']}", params={"include": "result"}, headers=headers).json()
    return job

Read the plan

Field	Holds
`result.vehicles[].placements[]`	Position, size, orientation and loading `step` of every item
`result.unplaced[]`	Items that did not fit, with a `reason`
`cost.credits`	What the job was charged
`pdf_url`	A link that builds the loading plan PDF

POST /v1/estimate validates and prices the same body for free.

Create a packing jobValidates the request, reserves the worst-case price from your credits and queues a job.Results & coordinatesWhere every item sits, in which orientation and loading order.IdempotencyRetry POST /v1/pack without creating a second job.

Create an API key

Create a job

Poll until it ends

Read the plan

Related#

Related