Последнее обновление
06.10.2026doc
Назначение
Документ доставки, возврата или поручения
Где используется
Параметры
Примечание
Для получения документов (метод GET) выглядит так же, но добавляется суффикс _id:
type->type_id,payment_preferred_type->payment_preferred_type_id
| Наименование | Тип | Описание |
|---|---|---|
| out_id (обязательно) | string | Идентификатор документа в системе учета |
| type (обязательно) | int | Тип документа: 0 - Заказ, 1 - Возврат, 2 - Поручение |
| number (обязательно) | string | Номер документа в системе учета |
| date (обязательно) | timestamp | Дата создания в формате Unix timestamp |
| barcode | string | Штрихкод документа |
| comment | string | Комментарий документа |
| priority | int | Приоритет документа |
| client_name | string | Наименование клиента |
| recipient | object | Объект информации о получателе |
| manager | object | Объект информации о менеджере |
| address (обязательно) | string | Адрес доставки |
| address_location | string | Координаты доставки в формате “широта,долгота” |
| finish_location | string | GPS-координаты завершения документа |
| date_from | timestamp | Время начала действия документа |
| date_to | timestamp | Время окончания действия документа |
| user_id | string | Идентификатор пользователя в системе учета |
| fiscal_tags | string | Фискальные теги в формате json |
| inn | string | ИНН |
| payment_preferred_type_id | int | Предпочтительный тип оплаты для Заказов: 0 - наличный, 1 - безналичный, 2 - смешанный |
| client_notification | object | Объект настроек уведомления для клиента |
| receipts | object array | Массив объектов с данными по пробитым чекам |
| started_at | timestamp | Время начала обработки документа в Unix timestamp |
| updated_at | timestamp | Время последнего обновления документа в Unix timestamp |
| created_at | timestamp | Время создания документа в Unix timestamp |
| canceled_at | timestamp | Время отмены документа в Unix timestamp |
| finished_at | timestamp | Время завершения документа в Unix timestamp |
| payments | object array | Массив объектов с данными по оплатам |
| details | object array | Массив объектов с данными по строкам документа |
| cancel_reason | object | Объект причины отмены |
| description (обязательно для “Поручений”) | string | Описание поручения |
Примечание
Для получения документов (метод GET) выглядит так же, но добавляется суффикс _id:
type->type_id,payment_preferred_type->payment_preferred_type_id
Пример
{
"out_id": "83df1b98-b7a6-11ef-a33f-d04c4ac51d43",
"type": 0,
"number": "ТД00-000028",
"date": 1733778000,
"date_from": 1733778000,
"date_to": 1733778000,
"barcode": "175287309371853769858969354570599570755",
"comment": "",
"priority": 5,
"client_name": "Розничный покупатель",
"recipient": {
...
},
"manager": {
...
},
"client_notification": {
...
},
"address": "Город Москва, Нахимовский проспект, д. 2, стр. а, этаж 8",
"address_location": "",
"finish_location": "55.737851,37.633401",
"user_id": "6f87e844-722c-11df-b336-0011955cba6b",
"fiscal_tags": "{}",
"inn": "9999115007",
"payment_preferred_type": "2",
"payments": [],
"details": [
{
"out_id": "8U-a1680fe8-58a0-11ef-a33d-f365c883963500000000-0000-0000-0000-000000000000",
"source_qty": 12,
"price": 33,
"source_sum": 396,
...
},
{
"out_id": "8U-c34ba7ca-71b0-11ef-a33f-d04c4ac51d4300000000-0000-0000-0000-000000000000",
"source_qty": 1,
"price": 149,
"source_sum": 149,
...
}
]
}
См. recipient
См. manager
См. payment
См. detail