Cargotime
Справочник API

Удаление или архивирование отслеживаний

Скачать OpenAPI
DELETE
/v2/shipments

Если неархивное отслеживание создано не более 72 часов назад и shipment_status отличается от IN_TRANSIT (в том числе DELIVERED, UNKNOWN или STUCK), запись удаляется с возвратом одного отслеживания на баланс. Записи со статусом IN_TRANSIT и неархивные записи старше 72 часов архивируются без возврата. Уже архивные записи удаляются без возврата. В data.deleted возвращаются идентификаторы удалённых записей, в data.archived — архивированных.

Авторизация

api_key
api_key<token>

Передаётся в: query

Тело запроса

application/json

Типы TypeScript

Используйте тип request body в TypeScript.

Тело ответа

application/json

curl -X DELETE "https://example.com/v2/shipments" \  -H "Content-Type: application/json" \  -d '{    "shipmentIds": [      "9ff48bf7-4541-49e2-947c-c269200e030f",      "fb8936b9-ff16-4776-8710-d4073ab06d1e",      "2305a40b-97b2-4c1b-94c4-6d9416b22bde"    ]  }'
{  "success": true,  "data": {    "deleted": [      "9ff48bf7-4541-49e2-947c-c269200e030f",      "fb8936b9-ff16-4776-8710-d4073ab06d1e"    ],    "archived": [      "2305a40b-97b2-4c1b-94c4-6d9416b22bde"    ]  },  "status": "OK",  "status_description": "Отслеживания успешно удалены"}

Список отслеживаний GET

Пример запроса: https://tracking.cargotime.ru/v2/shipments?api_key=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&page=1&limit=50&status=ACTIVE

Изменение заметки к отслеживанию PATCH

Обновляет заметку отслеживания, в том числе архивного. Чтобы удалить заметку, отправьте в теле пустую строку `{ "note": "" }`. Максимальная длина — 40 символов. Другие поля тела отклоняются.