跳到主要内容
开发者文档API 参考模板

列出模板

您组织的货物模板(已保存的物品),按创建时间倒序。

GEThttps://runner.cargoduo.com/v1/templates

在物品中用 template_id 引用模板。免费,不扣积分。

认证

Bearer API 密钥 · 所需权限范围resources:read了解更多

查询参数

名称类型必填说明
limitinteger
integer
否

每页条数。

默认值 201–100
cursorstring
string
否

上一页返回的 next_cursor。

qstring
string
否

仅返回标签包含此文本的模板。

created_bystring
string
否

仅返回该成员创建的记录:me(密钥的创建者)或成员 ID(usr_…)。

请求示例

curl -X GET "https://runner.cargoduo.com/v1/templates?created_by=me" \
  -H "Authorization: Bearer $CARGODUO_API_KEY"

响应示例

200 OK · TemplateList
{
  "data": [
    {
      "id": "tpl_43",
      "object": "template",
      "label": "Carton A",
      "shape": "box",
      "length": 60,
      "width": 40,
      "height": 40,
      "radius": 0,
      "weight": 12,
      "stackable": true,
      "max_stack_weight": 0,
      "rotation": "upright",
      "hazardous": false,
      "priority": 0,
      "color": "#f59e0b",
      "nesting_height": 0,
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-09-28T14:05:52Z",
      "updated_at": "2026-09-28T14:05:52Z"
    },
    {
      "id": "tpl_42",
      "object": "template",
      "label": "Euro pallet",
      "shape": "box",
      "length": 120,
      "width": 80,
      "height": 140,
      "radius": 0,
      "weight": 450,
      "stackable": false,
      "max_stack_weight": 0,
      "rotation": "all",
      "hazardous": false,
      "priority": 0,
      "color": "#3b82f6",
      "nesting_height": 0,
      "created_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "updated_by": {
        "id": "usr_7",
        "name": "Elif Kaya"
      },
      "created_at": "2026-09-28T14:05:52Z",
      "updated_at": "2026-09-28T14:05:52Z"
    }
  ],
  "next_cursor": ""
}

响应

  • 200OK一页模板。
    名称类型必填说明
    dataTemplate[]
    Template[]
    否

    按创建时间倒序。

    next_cursorstring
    string
    否

    作为 ?cursor= 传入以获取下一页;最后一页为空。

  • 401Unauthorizedunauthorizedkey_revokedkey_expired
    • unauthorizedAPI 密钥缺失、格式错误或无法识别。
    • key_revoked密钥已被撤销。
    • key_expired密钥已过期。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码
  • 403Forbiddenip_not_allowedsubscription_inactiveaccount_inactivescope_missing
    • ip_not_allowed调用方 IP 不在该密钥的 IP 白名单中。
    • subscription_inactive组织没有包含 API 的有效订阅。
    • account_inactive组织已被暂停使用,或其所有者的账户均未处于有效状态。
    • scope_missing密钥缺少此接口所需的权限范围。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码
  • 422Unprocessable entityvalidation_failed
    • validation_failed请求是格式正确的 JSON,但描述的任务无效。details[] 列出了所有问题。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码
  • 429Too many requestsrate_limited
    • rate_limited当前分钟、小时或天内的请求过多(按密钥或按组织计),或您的 IP 地址每分钟认证失败超过 60 次。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码
  • 500Internal server errorinternal_error
    • internal_error服务端发生内部错误。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码
  • 503Service unavailableapi_disabled
    • api_disabledAPI 暂时停用(维护中),或已对该组织关闭。
    名称类型必填说明
    errorErrorBody必填
    ErrorBody
    是
    全部错误码