Download OpenAPI specification:
Спецификация OpenAPI 3.0 для 3PL.
Создает или обновляет документ "План поступления" на основе переданных данных.
| ИдСсылка required | string <= 36 characters Уникальный идентификатор документа. Используется для получения данных запросами "ФактПоступления" и "ФактПоступленияПакет". |
| Номер required | string <= 50 characters Номер входящего документа. Используется в печатных формах ТОРГ-2 и ТОРГ-3. |
| Дата required | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| КодСклада | string or null <= 50 characters Код склада для идентификации склада при работе с несколькими складами контрагента. Если в интеграции используется один склад, поле будет проигнорировано. Использование нескольких складов и коды складов определяются ответственным за настройку интеграции. |
| Комментарий | string Комментарий к документу. |
required | Array of objects (AdmissionPlanGoodsTable) |
{- "ИдСсылка": "83d8472c-3f4f-11ef-8183-00155de27c10",
- "Номер": "ОТ000998841",
- "Дата": "2024-08-15T00:00:00.000Z",
- "КодСклада": "VL",
- "Комментарий": "Тест комментарий",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10",
- "БазоваяЕИ": "796",
- "ШтрихкодEAN13": "4607017161388"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "ПроверочныйКод": "123456",
- "Datamatrix": [
- "123456789"
], - "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "ЕдиницаИзмерения": "796",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоБазовыхЕИ": 450,
- "КоличествоУпаковок": 10,
- "Штрихкод": "4607017161388",
- "Цена": 150,
- "Кроссдок": false
}
]
}{- "Данные": null,
- "Результат": true,
- "Описание": "Заказ на поступление сформирован успешно."
}Получает состояние документа "План поступления" и данные о принятом грузе по идентификатору документа.
| ИдСсылка required | string <= 36 characters Идентификатор документа, который был ранее отправлен запросом "ПланПоступления". |
{- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8"
}{- "Данные": {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8",
- "Статус": "Выполнен",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Datamatrix": [
- {
- "КодКороба": "123456789",
- "КИЗ": [
- "982749811876124"
]
}
], - "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоУпаковокПлан": 10,
- "КоличествоУпаковокФакт": 9,
- "КоличествоУпаковокБрак": 1
}
]
}, - "Результат": true,
- "Описание": "Ответ по заказу на поступление сформирован успешно."
}Аналогичен "ФактПоступления", но позволяет работать со списком документов вместо отправки их "по одному". Отмененные и не найденные документы не возвращают исключение, а падают в общий пул ответов.
required | Array of objects |
{- "ПакетЗаказов": [
- {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8"
}
]
}{- "Данные": {
- "СписокДокументов": [
- {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8",
- "Статус": "Выполнен",
- "ОписаниеОшибки": "Не найдена заявка на поступление.",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Datamatrix": [
- {
- "КодКороба": "123456789",
- "КИЗ": [
- "982749811876124"
]
}
], - "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоУпаковокПлан": 10,
- "КоличествоУпаковокФакт": 9,
- "КоличествоУпаковокБрак": 1
}
]
}
]
}, - "Результат": true,
- "Описание": "Ответ по пакету заказов на поступление сформирован успешно."
}Создает или обновляет документ "План отгрузки" на основе переданных данных.
| ИдСсылка required | string <= 36 characters Уникальный идентификатор документа. Используется для получения данных запросами "ФактОтгрузки" и "ФактОтгрузкиПакет". |
| Номер required | string <= 50 characters |
| Дата required | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| ДатаОтгрузкиПлан | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| ВариантОтгрузкиНаПаллетах | boolean Признак отгрузки на паллетах. |
| Контрагент required | string <= 150 characters Наименование контрагента-получателя. |
| АдресДоставки | string Предпочтительный формат адреса - в формате ФИАС |
| КодСклада | string or null <= 50 characters Код склада для идентификации склада при работе с несколькими складами контрагента. Если в интеграции используется один склад, поле будет проигнорировано. Использование нескольких складов и коды складов определяются ответственным за настройку интеграции. |
| СпособПоставки | string <= 50 characters Способ поставки товара. |
| Комментарий | string Комментарий к документу. |
required | Array of objects (ShipmentPlanGoodsTable) |
{- "ИдСсылка": "83d8472c-3f4f-11ef-8183-00155de27c10",
- "Номер": "ОТ000998841",
- "Дата": "2024-08-15T00:00:00.000Z",
- "ДатаОтгрузкиПлан": "2024-08-17T00:00:00.000Z",
- "ВариантОтгрузкиНаПаллетах": true,
- "Контрагент": "ООО Ромашка",
- "АдресДоставки": "123022,Москва г, Звенигородская 2-я ул, дом 5, строение 1, эт.2, пом.3, ком.2",
- "КодСклада": "VL",
- "СпособПоставки": "Самовывоз",
- "Комментарий": "Тест комментарий",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "ЕдиницаИзмерения": "796",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоБазовыхЕИ": 400,
- "КоличествоУпаковок": 10
}
]
}{- "Данные": null,
- "Результат": true,
- "Описание": "Заказ на выдачу сформирован успешно."
}Получает состояние документа "План отгрузки" и данные об отгруженном грузе по идентификатору документа.
| ИдСсылка required | string <= 36 characters Идентификатор документа, который был ранее отправлен запросом "ПланОтгрузки". |
{- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8"
}{- "Данные": {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8",
- "Статус": "Выполнен",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Datamatrix": [
- {
- "КодПаллеты": "123456789",
- "Состав": [
- {
- "КодКороба": "987654321",
- "КИЗ": [
- "201654610284"
]
}
]
}
], - "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоУпаковокПлан": 10,
- "КоличествоУпаковокФакт": 9
}
]
}, - "Результат": true,
- "Описание": "Ответ по заказу на выдачу сформирован успешно."
}Аналогичен "ФактОтгрузки", но позволяет работать со списком документов вместо отправки их "по одному". Отмененные и не найденные документы не возвращают исключение, а падают в общий пул ответов.
required | Array of objects |
{- "ПакетЗаказов": [
- {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8"
}
]
}{- "Данные": {
- "СписокДокументов": [
- {
- "ИдСсылка": "6edb66e5-008f-48ed-8dd1-775aaa88bdb8",
- "Статус": "Выполнен",
- "ОписаниеОшибки": "Не найдена заявка на отгрузку",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Datamatrix": [
- {
- "КодПаллеты": "123456789",
- "Состав": [
- {
- "КодКороба": null,
- "КИЗ": [ ]
}
]
}
], - "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоУпаковокПлан": 10,
- "КоличествоУпаковокФакт": 9
}
]
}
]
}, - "Результат": true,
- "Описание": "Ответ по пакету заказов на отгрузку сформирован успешно."
}Изменяет данные документа, который был ранее прислан схемой "ShipmentPlan". Корректировка доступна только для документа в статусах "Новый" и "В работе". Для просмотра статуса воспользуйтесь JSON по схеме "ShipmentFact" или "ShipmentFactPackage" (поле "Статус"). Схема идентична схеме "ShipmentPlan".
| ИдСсылка required | string <= 36 characters Уникальный идентификатор документа. Используется для получения данных запросами "ФактОтгрузки" и "ФактОтгрузкиПакет". |
| Номер required | string <= 50 characters |
| Дата required | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| ДатаОтгрузкиПлан | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| ВариантОтгрузкиНаПаллетах | boolean Признак отгрузки на паллетах. |
| Контрагент required | string <= 150 characters Наименование контрагента-получателя. |
| АдресДоставки | string Предпочтительный формат адреса - в формате ФИАС |
| КодСклада | string or null <= 50 characters Код склада для идентификации склада при работе с несколькими складами контрагента. Если в интеграции используется один склад, поле будет проигнорировано. Использование нескольких складов и коды складов определяются ответственным за настройку интеграции. |
| СпособПоставки | string <= 50 characters Способ поставки товара. |
| Комментарий | string Комментарий к документу. |
required | Array of objects (ShipmentPlanGoodsTable) |
{- "ИдСсылка": "83d8472c-3f4f-11ef-8183-00155de27c10",
- "Номер": "ОТ000998841",
- "Дата": "2024-08-15T00:00:00.000Z",
- "ДатаОтгрузкиПлан": "2024-08-17T00:00:00.000Z",
- "ВариантОтгрузкиНаПаллетах": true,
- "Контрагент": "ООО Ромашка",
- "АдресДоставки": "123022,Москва г, Звенигородская 2-я ул, дом 5, строение 1, эт.2, пом.3, ком.2",
- "КодСклада": "VL",
- "СпособПоставки": "Самовывоз",
- "Комментарий": "Тест комментарий",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "СерийныйНомер": "123456789",
- "ДатаПроизводства": "2024-08-15T00:00:00.000Z",
- "СрокГодности": "2024-08-15T00:00:00.000Z",
- "Упаковка": {
- "ГУИД": "08a19610-f4b0-11e5-80e5-0cc47a177883",
- "ЕдиницаИзмерения": "796",
- "Числитель": 40,
- "Вес": 10,
- "Высота": 1,
- "Глубина": 1,
- "Ширина": 0.5
}, - "КоличествоБазовыхЕИ": 400,
- "КоличествоУпаковок": 10
}
]
}{- "Данные": null,
- "Результат": true,
- "Описание": "Заказ на выдачу скорректирован успешно"
}Создает или обновляет документ "План рассортировки" на основе переданных данных.
| ИдСсылка required | string <= 36 characters Уникальный идентификатор документа. |
| Номер required | string <= 50 characters Номер документа в базе отправителя. |
| Дата required | string <date-time> Используется формат ISO 8601. Остальные форматы будут возвращать ошибку ErrGeneralCannotReadJSON. |
| КодСклада | string or null <= 50 characters Код склада для идентификации склада при работе с несколькими складами контрагента. Если в интеграции используется один склад, поле будет проигнорировано. Использование нескольких складов и коды складов определяются ответственным за настройку интеграции. |
| Комментарий | string Комментарий к документу. |
required | Array of objects (SortingPlanGoodsTable) |
{- "ИдСсылка": "83d8472c-3f4f-11ef-8183-00155de27c10",
- "Номер": "РС000998841",
- "Дата": "2024-08-15T00:00:00.000Z",
- "КодСклада": "VL",
- "Комментарий": "Тест комментарий",
- "Товары": [
- {
- "Номенклатура": {
- "Наименование": "Тест номенклатуры",
- "Артикул": "4645-81",
- "ГУИД": "2d6cc4f6-5c58-11ee-817e-00155de27c10"
}, - "Характеристика": {
- "Наименование": "Синий",
- "ГУИД": "d5eefd0f-7628-11e5-80dd-0cc47a177883"
}, - "КоличествоБазовыхЕИ": 450
}
]
}{- "Данные": null,
- "Результат": true,
- "Описание": "Заявка на рассортировку сформирована успешно"
}