Документы

Документы заказа (счета, накладные и т.п.) формируются в PlatParts при печати или генерации в панели управления либо в публичной части сайта.

Через API их нельзя создать, изменить номер/тип/PDF или удалить. Для CRM доступны только список и запись внешнего ID.

Маршруты API определяют только два действия:

Метод	URL	Право	Назначение
GET	/documents	documents.read	Список снимков для синхронизации
POST	/documents/{id}/external-ref	documents.write_external_ref	Записать внешний ID (CRM)

---

Список документов

GET /documents — documents.read

Query	Описание
since	updated_at ≥ даты
per_page	1–100
cursor	курсор

Snapshot:

Поле	Описание
id	Id документа
order_id	Заказ
document_type_id / type	Тип
number	Номер (document_number)
pickup_point_id	Точка
payload	JSON (в т.ч. integration после external-ref)
archived_at / created_at	Даты

curl -sS "https://ВАШ_ДОМЕН/api/integrations/v1/documents?per_page=50" \
 -H "Authorization: Bearer pp_abc123:ВАШ_СЕКРЕТ" \
 -H "Accept: application/json"

{
 "data": [
 {
 "id": 55,
 "order_id": 42,
 "document_type_id": 1,
 "type": 1,
 "number": "СЧ-2026-001",
 "pickup_point_id": 1,
 "payload": {},
 "archived_at": null,
 "created_at": "2026-07-15T15:00:00+03:00"
 }
 ],
 "per_page": 50,
 "next_cursor": null,
 "path": "https://ВАШ_ДОМЕН/api/integrations/v1/documents"
}

---

Внешний ID документа

Нужен, чтобы связать уже существующий документ сайта с записью во внешней системе. Не создаёт документ — пишет ссылку в payload.integration.

POST /documents/{id}/external-ref — documents.write_external_ref

Поле	Тип	Обяз.	Описание
external_id	string≤191	да	Id во внешней системе
system	string≤80	нет	Метка системы, по умолчанию "api"

404 — документ не найден.

curl -sS -X POST "https://ВАШ_ДОМЕН/api/integrations/v1/documents/55/external-ref" \
 -H "Authorization: Bearer pp_abc123:ВАШ_СЕКРЕТ" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"external_id":"CRM-DOC-7788","system":"crm"}'

{
 "ok": true,
 "document_id": 55,
 "integration": {
 "external_id": "CRM-DOC-7788",
 "system": "crm"
 }
}

---

Чего нет в API (намеренно)

Метод	Почему нет
POST /documents	Документ создаёт сайт
PATCH /documents/{id}	Содержимое не правится через REST
DELETE /documents/{id}	Удаление документов через API не предусмотрено

Дальше

• Работать с заказами.
• Посмотреть все методы API.