取消任务
停止排队中或运行中的任务。
已取消的任务需支付任务基础费、大批量装载附加费(如有)及截至取消时已用的计算费用,不收取车辆费用。再次取消已取消的任务会原样返回该任务。
认证
路径参数
idstring必填任务 ID(job_…)。
请求示例
curl -X DELETE "https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e" \
-H "Authorization: Bearer $CARGODUO_API_KEY"const res = await fetch("https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e", {
method: "DELETE",
headers: {
Authorization: `Bearer ${process.env.CARGODUO_API_KEY}`,
},
});
const data = await res.json();
console.log(res.status, data);import os
import requests
response = requests.delete(
"https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e",
headers={"Authorization": f"Bearer {os.environ['CARGODUO_API_KEY']}"},
)
print(response.status_code, response.json())package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("DELETE", "https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CARGODUO_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.StatusCode, string(out))
}import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e"))
.header("Authorization", "Bearer " + System.getenv("CARGODUO_API_KEY"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("CARGODUO_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Delete, "https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e");
var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");<?php
$ch = curl_init('https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('CARGODUO_API_KEY'),
],
]);
$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), ' ', $response, PHP_EOL;require "net/http"
require "uri"
uri = URI("https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CARGODUO_API_KEY")}"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts response.code, response.body响应示例
{
"id": "job_2cR8vL4nXp6tQb1mZk9WsH5e",
"object": "job",
"status": "canceled",
"reference": "order-1043",
"source": "api",
"created_at": "2026-10-19T09:15:03Z",
"started_at": "2026-10-19T09:15:03Z",
"finished_at": "2026-10-19T09:15:05Z",
"progress": {
"stage": "done",
"vehicles_done": 0,
"placed_items": 0
},
"summary": {
"items_requested": 58,
"items_placed": 0,
"items_unplaced": 0,
"vehicles_used": 0,
"total_weight": 0,
"volume_utilization": 0,
"queue_ms": 15,
"compute_ms": 2300
},
"cost": {
"credits": 0.0715,
"reserved_credits": 1.11,
"rate_card_version": 1,
"breakdown": {
"base": 0.06,
"vehicles": 0,
"compute": 0.0115,
"large_load": 0
}
},
"error": {
"code": "canceled",
"message": "Canceled by request."
},
"warnings": [],
"result_url": "https://runner.cargoduo.com/v1/jobs/job_2cR8vL4nXp6tQb1mZk9WsH5e/result",
"pdf_url": "",
"expires_at": "2026-11-02T09:15:03Z"
}响应
200OK已取消的任务。
名称类型必填说明idstring必填string是任务 ID(job_…)。
objectstring必填string是始终为
job。jobstatusstring必填string是queued→running→succeeded|failed|canceled。queuedrunningsucceededfailedcanceledreferencestringstring否请求中提供的参考编号。
sourcestringstring否任务的创建来源。
apiplaygroundproject_idstringstring否POST /v1/projects/{id}/pack 任务将方案保存到的项目(prj_…)。其他任务不含此字段。
created_atstring必填string是RFC 3339 时间戳。
started_atstring | nullstring | null否开始计算的时间(RFC 3339),或
null。finished_atstring | nullstring | null否任务结束时间(RFC 3339),或
null。progressJobProgressJobProgress否排队中/运行中的实时进度。
stagestringstring否当前阶段,例如
queued、running、finalizing或done。仅供参考:请根据Job.status进行分支处理。vehicles_doneintegerinteger否目前已完成装载的车辆数。
placed_itemsintegerinteger否目前已摆放的物品件数。
summaryJobSummaryJobSummary否计数和耗时。
items_requestedintegerinteger否物品总件数(所有数量之和)。
items_placedintegerinteger否已摆放的件数。
items_unplacedintegerinteger否未能摆放的件数。
vehicles_usedintegerinteger否至少装载一件物品的车辆数。
total_weightnumber · kgnumber · kg否已装载重量。
volume_utilizationnumbernumber否已用车辆的平均容积利用率,0–1。
queue_msintegerinteger否等待计算槽位的时间(不计费)。
compute_msintegerinteger否计算时长(计费)。
costJobCostJobCost否已扣积分(任务结束后为最终值)以及运行期间预留的积分。
creditsnumber · creditsnumber · credits否已扣积分(任务结束前为 0)。失败的任务不收费,但 time_limit_exceeded 除外,它按已取消任务计费。
reserved_creditsnumber · creditsnumber · credits否任务排队/运行期间预留的积分(即最高可能费用)。任务结束时释放。
rate_card_versionintegerinteger否该任务计价所用的价目表。
breakdownCostBreakdownCostBreakdown否费用明细。
basenumber · creditsnumber · credits否任务基础费。
vehiclesnumber · creditsnumber · credits否按装载的车辆计费(已取消或 time_limit_exceeded 的任务不收取)。
computenumber · creditsnumber · credits否按计算秒计费,按毫秒比例折算。
large_loadnumber · creditsnumber · credits否超出大批量装载阈值的部分,每 100 件收取的附加费(不足 100 件按 100 件计)。
errorJobError | nullJobError | null否任务失败或被取消的原因;否则为
null。codestringstring否机器可读的错误码(参见“错误”)。
messagestringstring否英文说明。
warningsWarning[]Warning[]否关于请求的非阻断性提示(结果中也会重复列出)。
codestringstring否机器可读的代码。
messagestringstring否英文说明。
result_urlstringstring否status为succeeded后,对此 URL 发起 GET 请求以获取完整结果。pdf_urlstringstring否浏览器链接,打开后会将装载方案生成为 PDF(3D 视图 + 装载步骤)。在 expires_at 之前有效,过期后为空。
expires_atstringstring否请求体/结果体和 PDF 链接的删除时间(RFC 3339)。任务元数据和扣费记录会保留。
resultResultResult否完整结果,仅在请求时(?include=result)或 POST /v1/pack?wait= 按时完成时内联返回。
job_idstringstring否所属任务。
vehiclesResultVehicle[]ResultVehicle[]否按装载顺序排列的已装载车辆(不含空车)。
indexintegerinteger否在方案中的位置,从 0 开始。
vehicle_idstringstring否您的车辆定义 ID(项目任务中为车辆条目 ID,pv_…)。
copyintegerinteger否该车辆定义的副本序号,从 1 开始(quantity > 1,或在 auto 模式下添加时)。
auto_addedbooleanboolean否在您列出的
quantity之外,由packing_modeauto自动添加。namestringstring否车辆名称。
typestringstring否车辆类型。
lengthnumber · cmnumber · cm否货厢长度。
widthnumber · cmnumber · cm否货厢宽度。
heightnumber · cmnumber · cm否货厢高度。
max_weightnumber · kgnumber · kg否载重上限。
items_placedintegerinteger否此车内的件数。
total_weightnumber · kgnumber · kg否此车装载的重量。
volume_utilizationnumbernumber否已用容积 / 货厢容积,0–1。
weight_utilizationnumbernumber否total_weight / max_weight,0–1(启用 allow_overweight 时可能超过 1)。
center_of_gravityPointPoint否货物的重心(cm)。
xnumber · cmnumber · cm否ynumber · cmnumber · cm否znumber · cmnumber · cm否placementsPlacement[]Placement[]否此车内每件物品的摆放位置。
item_idstringstring否您的物品定义 ID(项目任务中为物品 ID,item_…)。
instanceintegerinteger否该物品定义内从 1 开始的件序号(在整个方案中唯一)。
labelstringstring否物品标签。
xnumber · cmnumber · cm否最小角点沿长度方向的位置。
ynumber · cmnumber · cm否最小角点距地板的高度。
znumber · cmnumber · cm否最小角点沿宽度方向的位置。
lengthnumber · cmnumber · cm否摆放后沿 x 轴的尺寸。
widthnumber · cmnumber · cm否摆放后沿 z 轴的尺寸。
heightnumber · cmnumber · cm否摆放后沿 y 轴的尺寸。
rotatedbooleanboolean否以不同于定义的朝向摆放。
orientationstringstring否定义中的哪条边分别沿 x、z、y 轴:
lwh= 与定义一致,wlh= 绕竖直轴旋转 90°,lhw、hwl、whl、hlw= 侧放。stepintegerinteger否该车内从 1 开始的装载步骤(按升序装载)。
weightnumber · kgnumber · kg否单件重量。
axle_loads需申请开通AxleLoad[]AxleLoad[]否各轴载荷(仅限含车轴数据的车辆)。
namestringstring否Axle 1、Axle 2…,顺序与axle_positions一致。positionnumber · cmnumber · cm否车轴距货厢前端的位置。
loadnumber · kgnumber · kg否该轴承受的货物载荷。
maxnumber · kgnumber · kg否配置的上限(0 = 无上限)。
okbooleanboolean否load≤max(未设上限时始终为true)。unplacedUnplacedItem[]UnplacedItem[]否未能摆放的物品及原因。
item_idstringstring否您的物品定义 ID。
instanceintegerinteger否件序号,从 1 开始。
labelstringstring否物品标签。
reasonstringstring否无法摆放的原因。
warningsWarning[]Warning[]否关于方案的提示。
codestringstring否机器可读的代码。
messagestringstring否英文说明。
pdf_urlstringstring否浏览器链接,打开后会将方案生成为 PDF。
expires_atstringstring否此结果的删除时间(RFC 3339)。
401Unauthorized
unauthorizedkey_revokedkey_expiredunauthorizedAPI 密钥缺失、格式错误或无法识别。key_revoked密钥已被撤销。key_expired密钥已过期。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
403Forbidden
ip_not_allowedsubscription_inactiveaccount_inactivescope_missingip_not_allowed调用方 IP 不在该密钥的 IP 白名单中。subscription_inactive组织没有包含 API 的有效订阅。account_inactive组织已被暂停使用,或其所有者的账户均未处于有效状态。scope_missing密钥缺少此接口所需的权限范围。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
404Not found
job_not_foundjob_not_found您的组织中没有此 ID 的任务。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
409Conflict
job_already_finishedjob_already_finished任务已结束,无法取消。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
429Too many requests
rate_limitedrate_limited当前分钟、小时或天内的请求过多(按密钥或按组织计),或您的 IP 地址每分钟认证失败超过 60 次。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
500Internal server error
internal_errorinternal_error服务端发生内部错误。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。
503Service unavailable
api_disabledapi_disabledAPI 暂时停用(维护中),或已对该组织关闭。
全部错误码名称类型必填说明errorErrorBody必填ErrorBody是codestring必填string是机器可读的错误码(snake_case)。请根据它进行分支处理,切勿依据
message。messagestring必填string是英文说明。
request_idstring必填string是与 X-Request-Id 响应头相同。联系技术支持时请提供。
detailsErrorDetail[]ErrorDetail[]否逐字段列出的问题(
validation_failed)。pathstringstring否出错字段的 JSON 路径,例如 items[3].length。
codestringstring否required、invalid_value、out_of_range、duplicate_id、unknown_vehicle、unknown_template、type_not_allowed、unknown_group、does_not_fit、too_many_items、too_many_vehicles、unknown_field、invalid_json。messagestringstring否英文说明。