Documentação para desenvolvedoresGet started
Saved data & projects
Vehicles, templates and projects shared with the app.
Your organization's vehicles, cargo templates and projects are the same records the CargoDuo app shows. Change one here and it changes there.
| Resource | Ids | Endpoints |
|---|---|---|
| Vehicles | Presets: slug (standard-trailer-13-6m), yours: veh_… | /v1/vehicles (presets are read-only) |
| Templates | tpl_… | /v1/templates |
| Projects | prj_…; slots pv_…, items item_… | /v1/projects |
Reading needs resources:read; creating, changing and deleting need resources:write. These calls cost nothing and count against the rate limits like any other.
Use them in a job
{
"vehicles": [
{
"vehicle_id": "veh_118",
"quantity": 2
}
],
"items": [
{
"template_id": "tpl_42",
"quantity": 18
},
{
"template_id": "tpl_43",
"quantity": 40,
"weight": 14
}
]
}Fields sent next to an id override the saved values. id defaults to the saved id.
Projects
| Step | Call |
|---|---|
| 1 | POST /v1/projects with a name, vehicles (vehicle_id, quantity) and items |
| 2 | POST /v1/projects/{id}/pack: priced and run like POST /v1/pack |
| 3 | The plan is saved into the project and opens in the app (app_url) |
If someone edits the project while the job runs, the plan stays on the job only (warning project_not_saved).
Members
Each record shows created_by and updated_by. A call counts as the member who created the key. Filter lists with ?created_by=me or a member id (usr_…).
Related
List vehiclesEvery vehicle you can name with vehicle_id: the presets (containers, trailers, trucks, pallets of the types your organization may use), then your organization's own vehicles.List templatesYour organization's cargo templates (saved items), newest first.Pack a projectPacks the project's vehicles and items exactly like POST /v1/pack: same price, credit reservation, limits, Idempotency-Key, ?wait= and job.