Перейти к содержимому
CargoDuo logoCargoDuo
Цены
Документация для разработчиковСправочник 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_allowedIP-адреса вызывающей стороны нет в списке разрешённых IP для этого ключа.
    • subscription_inactiveУ организации нет активной подписки, включающей API.
    • account_inactiveРабота организации приостановлена, или у неё нет владельца с активной учётной записью.
    • scope_missingУ ключа нет области доступа, необходимой для этого endpoint.
    ИмяТипОбязательноОписание
    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
    Да
    Все коды ошибок