{ "openapi": "3.0.1", "info": { "title": "Документация по SelSup API", "description": "API SelSup — программный интерфейс для работы с сервисом SelSup. Даёт возможность работать со всеми функциями SelSup из вашей системы. Для использования API добавьте новый токен на странице:https://selsup.ru/application/integration/api. Добавленный токен необходимо передавать во всех запросах к API SelSup, в заголовке Authorization.", "contact": { "name": "Support Team", "email": "admin@selsup.ru" }, "license": { "name": "Apache 2.0", "url": "https://selsup.ru/dogovor-offerta/" }, "version": "1.0" }, "servers": [ { "url": "https://api.selsup.ru/", "description": "Production server" } ], "tags": [ { "name": "Заказы со склада поставщика (FBS)", "description": "Импорт заказов и различные методы для сборки, комплектации, отмены заказов со своего склада" } ], "paths": { "/api/fbs/supply/{supplyId}": { "put": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Прикрепить заказ по FBS к поставке", "description": "Позволяет прикрепить заказ к поставке, в основном актуально для Wildberries", "operationId": "putOrdersToSupply", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } } }, "/api/fbs/updateWildberriesSupplies": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Импорт поставок Wildberries", "description": "Импортирует открытые поставки на маркетплейсе Wildberries по FBS", "operationId": "updateWildberriesSupplies", "parameters": [ { "name": "organizationId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/api/fbs/task/{taskId}/cancel": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Отменить задачу по сборке", "description": "Отменяет/возвращает сборочное задание, оно не будет выдаваться никакому оператору, пока его не откроют. Метод нужен в том числе для закрытия пустых заданий, которые собрали не через задание по сборке", "operationId": "taskCancel", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "finished", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/supply/{supplyId}/documents": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Скачать документы для поставки", "description": "Позволяет скачать документы для отгрузки поставки", "operationId": "supplyDocuments", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "string", "format": "byte" } } } } } }, "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Создать документы для поставки", "description": "Позволяет сформировать документы для отгрузки поставки", "operationId": "supplyDocuments_1", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "count", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "deliveryMethod", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/supply/{supplyId}/close": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Закрыть поставку", "description": "Позволяет закрыть поставку на маркетплейсе", "operationId": "supplyClose", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Supply" } } } } } } }, "/api/fbs/supply/{supplyId}/check": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Проверяет поставку FBS", "description": "Позволяет проверить поставку на маркетплейсе", "operationId": "supplyCheck", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/SupplyCheck" } } } } } } }, "/api/fbs/supply/{supplyId}/check/orders": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Проверяет заказы поставки FBS", "description": "Позволяет проверить поставку на маркетплейсе и сравнить состав заказов с SelSup", "operationId": "supplyCheckOrder", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "changeSupply", "in": "query", "description": "Изменять поставку в SelSup, если она не совпадает с поставкой на маркетплейсе", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } } }, "/api/fbs/stocks/reserve": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Резервирует остатки по заказам", "description": "Позволяет обновить резерв остатков по FBS заказам, например если появился новый остаток. Импорт с обновлением остатков самостоятельно обновляют остатки, даже если когда заказ поступал остатка не было", "operationId": "stocksReserve", "responses": { "200": { "description": "OK" } } } }, "/api/fbs/orders/collect": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Пометить собранными заказы по FBS", "description": "Позволяет отменить заказ, например если на складе не оказалосьтовара, на который пришел заказ", "operationId": "collect", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{status}": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Изменяет статус заказов", "description": "Изменяет статус нескольких заказов", "operationId": "ordersStatus", "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/update": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Обновить заказ с маркетплейса", "description": "Обновляет статус и этикетку заказа с маркетплейса", "operationId": "orderUpdate", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/api/fbs/order/{orderId}/reserve": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Принудительный резерв остатка для заказа", "description": "Позволяет обновить принудительно взять резерв остатков по FBS заказам", "operationId": "orderForceReserveStock", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/refund": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Возврат заказа на склад", "description": "Позволяет возвратить остаток заказа на склад, при возврате заказа от покупателя", "operationId": "orderRefund", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProduct" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/pack": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Укомплектовать заказ", "description": "Позволяет пометить заказ укоплектованным. Статус заказа меняется на COLLECTED - собран", "operationId": "orderPack", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "deliveryInvoiceNumber", "in": "query", "description": "Номер транспортного заказа для передачи", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/new": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Возвратить собранный заказ в новый", "description": "Позволяет возвратить заказ в новые, например если он не собран, чтобы потом массово пометить заказы собранными", "operationId": "orderNew", "parameters": [ { "name": "orderId", "in": "path", "description": "Идентификатор заказа", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/label": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Загрузить этикетку заказа", "description": "Обновляет статус и этикетку заказа с маркетплейса. После вызова данного метода, статус заказа изменится на маркетплейсе, чтобы можно было получить этикетку. На Wildberries заказ будет прикреплен к поставке, на других перейдет в статус Ожидает доставки.", "operationId": "orderLabel", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/api/fbs/order/{orderId}/collect": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Собрать заказ по FBS", "description": "Позволяет пометить собраным один заказ. В случае когда заказ помечается собранным,он меняет статус на маркетплейсе на Ожидает доставки. На маркетплейсе статус изменяется вофлайне - заказ попадает в очередь из которой постепенно они отправляются на маркетплейс ", "operationId": "orderCollect", "parameters": [ { "name": "orderId", "in": "path", "description": "Идентификатор заказа", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectOrderDTO" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{orderId}/cancel": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Отменить заказ", "description": "Позволяет отменить заказ, например если на складе не оказалосьтовара на который пришел заказ", "operationId": "orderCancel", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/{barcode}/check": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Проверка заказа", "description": "Помечает заказ проверенным к отправке", "operationId": "orderCheck", "parameters": [ { "name": "barcode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "string", "format": "date-time" } } } } } } }, "/api/fbs/order/update": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Обновить заказы с маркетплейса", "description": "Обновляет статус и этикетку заказа с маркетплейса", "operationId": "ordersUpdate", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/unreserve": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Списать резерв у заказа", "description": "Позволяет списать резерв у заказа, например для 1С, когда учет ведется в другой системе", "operationId": "orderUnreserve", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/packing": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Отправляет заказы на сборку", "description": "Изменяет статус заказов на На сборке, чтобы Новые заказы онлайн импорта не мешали сборке и список заказов фиксировался", "operationId": "orderPacking", "parameters": [ { "name": "collect", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/new": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Возвратить собранные заказы в новый", "description": "Позволяет возвратить заказы в новые", "operationId": "ordersNew", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "Идентификаторы заказов", "items": { "type": "integer", "description": "Идентификаторы заказов", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/label": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Загрузить этикетки заказов", "description": "Обновляет статус и этикетки заказа с маркетплейса. После вызова данного метода, статус заказа изменится на маркетплейсе, чтобы можно было получить этикетку. На Wildberries заказ будет прикреплен к поставке, на других перейдет в статус Ожидает доставки.", "operationId": "ordersLabel", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/import": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Импортировать заказы FBS", "description": "Позволяет запустить задачу по импорту заказов FBS с Wildberries, Ozon, Яндекс.Маркет, Aliexpress, СберМегаМаркет, Авито по FBS. После импорта могут обновляться остатки на маркетплейсе, если указана stocks = true. Статус задачи можно проверять по task/getTask", "operationId": "orderImport", "parameters": [ { "name": "stocks", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/fbs/moveToOtherSupply": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Переместить поставку", "description": "Перемещает не собранные заказы из поставки в другую", "operationId": "moveToOtherSupply", "parameters": [ { "name": "supplyId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Supply" } } } } } } }, "/api/fbs/marks-for-set": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Добавить маркировку к заказу c комплектами", "description": "Позволяет прикрепить код маркировки к заказу для тех, кто не использует уникальные коды маркировки", "operationId": "addMark", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkForSetParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/markCollected": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Пометить заказ по FBS собранным", "description": "Позволяет отметить заказ собранным, даже если заказ не был выдан в задание по сборке, например когда товара не оказалось на складе или можно заменить товардругим (в этом случае передается WmsItem.id - идентификатор уникального товара,который взяли со склада на замену)", "operationId": "markCollected", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код заказа маркетплейса", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Уникальный код единицы хранения на складе. Будет помечен отгруженным", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/lostItem": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Пометить уникальный код потерянным", "description": "Позволяет пометить единицу товара на складе - потерянной,если ее не удалось найти. Возвращает новую единицу товара со стока,если она есть на замену или null, если замены нет", "operationId": "lostItem", "parameters": [ { "name": "orderProductCollectId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } }, "/api/fbs/labels": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "PDF этикеток заказов", "description": "Скачивает PDF файл со списком этикеток всех заказов по фильтру", "operationId": "labels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderFilter" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/fbs/item/{orderProductCollectId}/collect": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Собрать позицию в заказе", "description": "Позволяет пометить собранным позицию из заказа. Можно передать замену уникального кода в параметре itemId, если на складе выбирается любой уникальный код, а не только зарезервированный под заказ. При этом с этого кода будет снят резерв, либо резерв перекинут на другой заказ. Можно передать код маркировки, если у уникального до этого не было привязки к коду маркировки. Если передан параметр barcode - производится дополнительная сверка, что выбран правильный шк заказа", "operationId": "itemCollect", "parameters": [ { "name": "orderProductCollectId", "in": "path", "description": "Код товара в заказе", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "barcode", "in": "query", "description": "Штрих-код заказа для проверки", "required": false, "schema": { "type": "string" } }, { "name": "itemId", "in": "query", "description": "Уникальный код единицы хранения на складе для проверки совпадения с выбранным товаром", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "mark", "in": "query", "description": "Код маркировки", "required": false, "schema": { "type": "string" } }, { "name": "gtd", "in": "query", "description": "ГТД", "required": false, "schema": { "type": "string" } }, { "name": "rnpt", "in": "query", "description": "РНПТ", "required": false, "schema": { "type": "string" } }, { "name": "base64", "in": "query", "description": "Код закодирован в base64", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/getOrderProductsByBarcode": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Найти заказ по штрих-коду", "description": "Позволяет найти сборочные позиции заказ по штрих-коду", "operationId": "getOrderProductsByBarcode", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код заказа маркетплейса", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/getDeliveryMethods": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение методов доставки", "description": "Возвращает список методов доставки", "operationId": "getDeliveryMethods", "parameters": [ { "name": "organizationId", "in": "query", "description": "Организация", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "service", "in": "query", "description": "Маркетплейс", "required": true, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryMethod" } } } } } } } }, "/api/fbs/getCountOrdersByPeriod": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Статистика заказов", "description": "Рассчитывает кол-во заказов созданных за день и агрегирует их по периоду(День/Неделя/Месяц/Год)", "operationId": "getCountOrdersByPeriod", "parameters": [ { "name": "fieldId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStatRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } }, "deprecated": true } }, "/api/fbs/getCollectTask": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получить список заданий для сборки в задании", "description": "Возвращает список сборочных заданий и прикрепляет их к оператору,который вызвал метод. Больше никто не может взять это задание на сборку, но можно изменить привязку задания к оператору через метод setUserForTask.", "operationId": "getCollectTask", "parameters": [ { "name": "force", "in": "query", "description": "Флаг, означающий принудительнуювыдачу новых заданий, даже если у пользователя уже есть сборочные задания. Позволяет пропускать задания, а когда они закончились выдать новые", "required": true, "schema": { "type": "boolean" } }, { "name": "count", "in": "query", "description": "Количество заданий, которое взять", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "nextDay", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/CollectTask" } } } } } } }, "/api/fbs/findOrdersForRefundByProductBarcode": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заказов по ШК товара", "description": "Позволяет найти заказ по ШК заказа Ozon (верхний или нижний), QR-коду WB, штрих-коду Яндекс.Маркета", "operationId": "findOrdersForRefundByProductBarcode", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код товара", "required": true, "schema": { "type": "string" } }, { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "description": "ID Номера счета", "format": "int64" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "format": "int64" } } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "description": "ID пользователя который брал на сборку заказ", "format": "int32" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID позиции в заказе", "format": "int64" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID товара из заказа", "format": "int64" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID организации заказа", "format": "int64" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "format": "int64" } } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "description": "ID поставки, в которой отгружается заказ", "format": "int64" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "format": "date-time" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "format": "date-time" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "description": "ID закупки из которого создан заказ", "format": "int64" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "description": "ID заказа, которому делаем возврат", "format": "int64" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа от - ISO", "format": "date-time" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа до - ISO", "format": "date-time" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID склада, с которого отгружается заказ", "format": "int64" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "format": "int64" } } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - от", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - до", "format": "date-time" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "description": "ID часового пояса клиента по UTC в часах, например 3", "format": "int32" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "description": "ID заказа", "format": "int64" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "format": "int64" } } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "description": "Ограничение на количество записей. Максимальное значение - 500", "format": "int32" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "description": "Номер страницы начиная с 1", "format": "int32" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } } }, "/api/fbs/findOrderByBarcode": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заказа по ШК заказа", "description": "Позволяет найти заказ по ШК заказа Ozon (верхний или нижний), QR-коду WB, штрих-коду Яндекс.Маркета", "operationId": "findOrderByBarcode", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код заказа маркетплейса", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Маркетплейс заказа", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/api/fbs/expirationDate": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Добавить срок годности к товарам в заказе", "description": "Позволяет указать срок годности товаров в заказе", "operationId": "addExpiredDate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExpirationDateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/downloadCollectLabels": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "PDF этикеток заказов на сборке", "description": "Скачивает PDF файл со списком этикеток всех заказов на сборке", "operationId": "downloadCollectLabels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderFilter" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/TmsTask" } } } } } } }, "/api/fbs/collect/{orderProductCollectId}/cancel": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Отменить позицию из заказа", "description": "Позволяет отменить товар из заказа, например если на складе не оказалосьтовара на который пришел заказ", "operationId": "collectCancel", "parameters": [ { "name": "orderProductCollectId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/addMark": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Добавить маркировку к заказу", "description": "Позволяет прикрепить код маркировки к заказу для тех, кто не использует уникальные коды маркировки", "operationId": "addMark_1", "parameters": [ { "name": "mark", "in": "query", "description": "Код маркировки", "required": true, "schema": { "type": "string" } }, { "name": "orderProductCollectId", "in": "query", "description": "Идентификатор сборки товара из заказа", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "base64", "in": "query", "description": "Маркировка закодирована в base64", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductCode" } } } } } } }, "/api/fbs/addCollectOrderTask": { "post": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Проставить заказам сборочные задания", "description": "Позволяет создать новое сборочное задание и связать с ним позиции из заказов. Сборочное задание формируется с учетом маршрутизации на складе, если заказы одиночные, а так же могут содержать один заказ - если в заказе несколько позиций. Задания потом фиксируются за конкретным исполнителем для сборки на складе", "operationId": "addCollectOrderTask", "parameters": [ { "name": "old", "in": "query", "description": "Распределить заказы от момента создания которых прошло больше 1 дня", "required": false, "schema": { "type": "boolean" } }, { "name": "tomorrow", "in": "query", "description": "Распределить заказы на завтра в том числе", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/task/{taskId}/user/{userId}": { "patch": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Присвоить задание пользователю", "description": "Ставит сборочное задание на пользователя или передает его другому пользователю, если нужно его изменить", "operationId": "patchUserForTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/order/warehouse": { "patch": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Изменить склад", "description": "Cпишет резерв с текущего склада резерва, если он взят, и возьмет резерв с нового указанного склада. Если склад не указан, то резервы обнуляются", "operationId": "changeStockWarehouse", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeStockWarehouseDTO" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/fbs/supply/{supplyId}/sign": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Подписать документы для поставки", "description": "Позволяет подписать электронный акт для отгрузки поставки", "operationId": "supplySign", "parameters": [ { "name": "supplyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/fbs/supplies": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поставки по FBS", "description": "Позволяет получить актуальные поставки по FBS", "operationId": "supplies", "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Supply" } } } } } } } }, "/api/fbs/order/find": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заказов", "description": "Возвращает список заказов с товарами из заказа, в отличии от метода supply/findOrder. В случае когда статус передается CREATED и не задан поисковый запрос возвращает актуальную очередь заданий на сборку в порядке выдачи.", "operationId": "orderFind", "parameters": [ { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "description": "ID Номера счета", "format": "int64" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "format": "int64" } } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "description": "ID пользователя который брал на сборку заказ", "format": "int32" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID позиции в заказе", "format": "int64" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID товара из заказа", "format": "int64" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID организации заказа", "format": "int64" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "format": "int64" } } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "description": "ID поставки, в которой отгружается заказ", "format": "int64" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "format": "date-time" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "format": "date-time" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "description": "ID закупки из которого создан заказ", "format": "int64" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "description": "ID заказа, которому делаем возврат", "format": "int64" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа от - ISO", "format": "date-time" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа до - ISO", "format": "date-time" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID склада, с которого отгружается заказ", "format": "int64" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "format": "int64" } } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - от", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - до", "format": "date-time" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "description": "ID часового пояса клиента по UTC в часах, например 3", "format": "int32" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "description": "ID заказа", "format": "int64" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "format": "int64" } } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "description": "Ограничение на количество записей. Максимальное значение - 500", "format": "int32" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "description": "Номер страницы начиная с 1", "format": "int32" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseOrder" } } } } } } }, "/api/fbs/order/count": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Подсчет заказов по статусам, организациям и маркетплейсам по фильтру", "description": "Возвращает количество заказов по статусам организациям и маркетплейсам по фильтру.", "operationId": "orderCount", "parameters": [ { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "description": "ID Номера счета", "format": "int64" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "format": "int64" } } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "description": "ID пользователя который брал на сборку заказ", "format": "int32" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID позиции в заказе", "format": "int64" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID товара из заказа", "format": "int64" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID организации заказа", "format": "int64" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "format": "int64" } } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "description": "ID поставки, в которой отгружается заказ", "format": "int64" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "format": "date-time" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "format": "date-time" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "description": "ID закупки из которого создан заказ", "format": "int64" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "description": "ID заказа, которому делаем возврат", "format": "int64" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа от - ISO", "format": "date-time" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа до - ISO", "format": "date-time" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID склада, с которого отгружается заказ", "format": "int64" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "format": "int64" } } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - от", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - до", "format": "date-time" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "description": "ID часового пояса клиента по UTC в часах, например 3", "format": "int32" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "description": "ID заказа", "format": "int64" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "format": "int64" } } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "description": "Ограничение на количество записей. Максимальное значение - 500", "format": "int32" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "description": "Номер страницы начиная с 1", "format": "int32" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderCounter" } } } } } } } }, "/api/fbs/order/count-by-period": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Статистика заказов", "description": "Рассчитывает кол-во заказов созданных за день и агрегирует их по периоду(День/Неделя/Месяц/Год)", "operationId": "getCountOrderByPeriod", "parameters": [ { "name": "period", "in": "query", "description": "Период агрегации", "required": false, "schema": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] } }, { "name": "dateFrom", "in": "query", "description": "Дата начала отчета", "required": false, "schema": { "type": "string", "description": "Дата начала отчета", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "Дата окончания отчета", "required": false, "schema": { "type": "string", "description": "Дата окончания отчета", "format": "date-time" } }, { "name": "services", "in": "query", "description": "Список маркетплейсов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, { "name": "categories", "in": "query", "description": "Фильтр категорий для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "description": "Фильтр категорий для которых отдать данные", "format": "int64" } } }, { "name": "brands", "in": "query", "description": "Фильтр брендов для которых отдать данные", "required": false, "schema": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "description": "Фильтр брендов для которых отдать данные", "format": "int64" } } }, { "name": "clientOrganizationId", "in": "query", "description": "Идентификатор организации, для которой отдать данные", "required": false, "schema": { "type": "integer", "description": "Идентификатор организации, для которой отдать данные", "format": "int64" } }, { "name": "organizations", "in": "query", "description": "Идентификаторы организаций клиента", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "description": "Идентификаторы организаций клиента", "format": "int64" } } }, { "name": "ids", "in": "query", "description": "Список идентификаторов", "required": false, "schema": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "description": "Список идентификаторов", "format": "int64" } } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "types", "in": "query", "description": "Типы заказа", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "timeZone", "in": "query", "description": "Часовой пояс клиента по UTC", "required": false, "schema": { "type": "integer", "description": "Часовой пояс клиента по UTC", "format": "int32" } }, { "name": "previousDateFrom", "in": "query", "description": "Дата начала периода для сравнения", "required": false, "schema": { "type": "string", "description": "Дата начала периода для сравнения", "format": "date-time" } }, { "name": "fieldId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "field", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PRODUCT", "MODEL", "GROUP", "ORGANIZATION", "CLIENT", "CATEGORY", "PRODUCT_VIEW", "BRAND", "REGION", "WAREHOUSE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/ProductStats" } } } } } } }, "/api/fbs/getOrdersForCollect": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение список всех заказов на сборку для печати", "description": "Возвращает список заказов на сборку", "operationId": "getOrdersForCollect", "parameters": [ { "name": "actual", "in": "query", "description": "Отображать только актуальные заказы - не закрытые?", "required": false, "schema": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" } }, { "name": "type", "in": "query", "description": "Тип заказа", "required": false, "schema": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, { "name": "serviceWarehouseId", "in": "query", "description": "Внешний номер склада", "required": false, "schema": { "type": "string", "description": "Внешний номер склада" } }, { "name": "externalOrderId", "in": "query", "description": "Внешний номер заказа", "required": false, "schema": { "type": "string", "description": "Внешний номер заказа" } }, { "name": "invoiceNumber", "in": "query", "description": "ID Номера счета", "required": false, "schema": { "type": "integer", "description": "ID Номера счета", "format": "int64" } }, { "name": "article", "in": "query", "description": "Фильтр по артикулу модели товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" } }, { "name": "product", "in": "query", "description": "Фильтр по названию товара в заказе", "required": false, "schema": { "type": "string", "description": "Фильтр по названию товара в заказе" } }, { "name": "organizations", "in": "query", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "format": "int64" } } }, { "name": "query", "in": "query", "description": "Поисковый запрос для фильтрации заказов по номеру или названию", "required": false, "schema": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" } }, { "name": "userId", "in": "query", "description": "ID пользователя который брал на сборку заказ", "required": false, "schema": { "type": "integer", "description": "ID пользователя который брал на сборку заказ", "format": "int32" } }, { "name": "service", "in": "query", "description": "Фильтр заказа по маркетплейсу", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "status", "in": "query", "description": "Фильтр по статусу заказа", "required": false, "schema": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, { "name": "statuses", "in": "query", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "required": false, "schema": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } } }, { "name": "withoutSupply", "in": "query", "description": "Фильтр по заказам не прикрепленным к поставке?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" } }, { "name": "orderProductId", "in": "query", "description": "Фильтр по ID позиции в заказе", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID позиции в заказе", "format": "int64" } }, { "name": "productId", "in": "query", "description": "Фильтр по ID товара из заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID товара из заказа", "format": "int64" } }, { "name": "hasCollectTask", "in": "query", "description": "Фильтр по наличию у заказа сборочного задания?", "required": false, "schema": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" } }, { "name": "organizationId", "in": "query", "description": "Фильтр по ID организации заказа", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID организации заказа", "format": "int64" } }, { "name": "updateInService", "in": "query", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" } }, { "name": "hasServiceError", "in": "query", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?", "required": false, "schema": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" } }, { "name": "noLabel", "in": "query", "description": "Фильтрует заказы без этикетки?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" } }, { "name": "noMsOrder", "in": "query", "description": "Фильтрует по заказам не созданным в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" } }, { "name": "noMsDemand", "in": "query", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?", "required": false, "schema": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" } }, { "name": "ids", "in": "query", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "format": "int64" } } }, { "name": "supplyId", "in": "query", "description": "ID поставки, в которой отгружается заказ", "required": false, "schema": { "type": "integer", "description": "ID поставки, в которой отгружается заказ", "format": "int64" } }, { "name": "notCollected", "in": "query", "description": "Заказы, которые не собирались через SelSup?", "required": false, "schema": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" } }, { "name": "dbs", "in": "query", "description": "DBS заказы?", "required": false, "schema": { "type": "boolean", "description": "DBS заказы?" } }, { "name": "express", "in": "query", "description": "Express заказы?", "required": false, "schema": { "type": "boolean", "description": "Express заказы?" } }, { "name": "fbs", "in": "query", "description": "FBS заказы?", "required": false, "schema": { "type": "boolean", "description": "FBS заказы?" } }, { "name": "noWarehouse", "in": "query", "description": "Заказы без склада?", "required": false, "schema": { "type": "boolean", "description": "Заказы без склада?" } }, { "name": "closeDate", "in": "query", "description": "Фильтр по дате сборки заказа - конкретный день", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" } }, { "name": "modifiedDate", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "format": "date-time" } }, { "name": "modifiedDateTo", "in": "query", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "required": false, "schema": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "format": "date-time" } }, { "name": "incomeId", "in": "query", "description": "ID закупки из которого создан заказ", "required": false, "schema": { "type": "integer", "description": "ID закупки из которого создан заказ", "format": "int64" } }, { "name": "bindingOrderId", "in": "query", "description": "ID заказа, которому делаем возврат", "required": false, "schema": { "type": "integer", "description": "ID заказа, которому делаем возврат", "format": "int64" } }, { "name": "closeDateFrom", "in": "query", "description": "Фильтр по дате сборки заказа от - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа от - ISO", "format": "date-time" } }, { "name": "closeDateTo", "in": "query", "description": "Фильтр по дате сборки заказа до - ISO", "required": false, "schema": { "type": "string", "description": "Фильтр по дате сборки заказа до - ISO", "format": "date-time" } }, { "name": "orderDate", "in": "query", "description": "Фильтр по дате заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа" } }, { "name": "deliveryDate", "in": "query", "description": "Фильтр по дате доставки заказа", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа" } }, { "name": "deliveryDateFrom", "in": "query", "description": "Фильтр по дате доставки заказа от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа от" } }, { "name": "deliveryDateTo", "in": "query", "description": "Фильтр по дате доставки заказа до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате доставки заказа до" } }, { "name": "forMoySklad", "in": "query", "description": "Для создания в МойСклад?", "required": false, "schema": { "type": "boolean", "description": "Для создания в МойСклад?" } }, { "name": "warehouseId", "in": "query", "description": "Фильтр по ID склада, с которого отгружается заказ", "required": false, "schema": { "type": "integer", "description": "Фильтр по ID склада, с которого отгружается заказ", "format": "int64" } }, { "name": "warehouseIds", "in": "query", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "format": "int64" } } }, { "name": "dateFrom", "in": "query", "description": "Фильтр по дате заказа - от", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - от", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "Фильтр по дате заказа - до", "required": false, "schema": { "type": "string", "description": "Фильтр по дате заказа - до", "format": "date-time" } }, { "name": "timeZone", "in": "query", "description": "ID часового пояса клиента по UTC в часах, например 3", "required": false, "schema": { "type": "integer", "description": "ID часового пояса клиента по UTC в часах, например 3", "format": "int32" } }, { "name": "markingStatus", "in": "query", "description": "Фильтр по статусу в честном знаке", "required": false, "schema": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] } }, { "name": "deleted", "in": "query", "description": "Показать удаленные заказы?", "required": false, "schema": { "type": "boolean", "description": "Показать удаленные заказы?" } }, { "name": "collectLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortOrdersByDate", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" } }, { "name": "sortBySku", "in": "query", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" } }, { "name": "notGroupByOrganization", "in": "query", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" } }, { "name": "notGroupByService", "in": "query", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" } }, { "name": "productLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" } }, { "name": "servicesForLabel", "in": "query", "description": "Сервисы для которых нужна печать в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, { "name": "infoLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" } }, { "name": "grouped", "in": "query", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?", "required": false, "schema": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменяет в заказах комплекты на компоненты?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" } }, { "name": "replaceSetsByComponentsIncome", "in": "query", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?", "required": false, "schema": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" } }, { "name": "collectDeliveryLabel", "in": "query", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?", "required": false, "schema": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" } }, { "name": "shippingServicesForLabel", "in": "query", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "required": false, "schema": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } } }, { "name": "orderId", "in": "query", "description": "ID заказа", "required": false, "schema": { "type": "integer", "description": "ID заказа", "format": "int64" } }, { "name": "hasVideoFixation", "in": "query", "description": "Идентификатор была ли видео фиксация?", "required": false, "schema": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" } }, { "name": "withProducts", "in": "query", "description": "Признак, что заказы необходимо отдать c товарами?", "required": false, "schema": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" } }, { "name": "passageIds", "in": "query", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "required": false, "schema": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "format": "int64" } } }, { "name": "withContractor", "in": "query", "description": "Включить информацию о поставщиках в выгрузку?", "required": false, "schema": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "description": "Ограничение на количество записей. Максимальное значение - 500", "format": "int32" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "description": "Номер страницы начиная с 1", "format": "int32" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } } } } } }, "/api/fbs/getOrdersByDate": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение список всех товаров на сборку для печати", "description": "Возвращает список товаров на сборку. Отдает упрощенную информацию о товаре. Максимум 500 товаров", "operationId": "getOrdersByDate", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/getCollectTasks": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение список всех товаров на сборку для печати", "description": "Возвращает список товаров на сборку. Отдает упрощенную информацию о товаре. Максимум 500 товаров", "operationId": "getCollectTasks", "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/getCollectOrderProduct": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение список всех товаров на сборку по заказу", "description": "Возвращает список товаров на сборку по заказу. OrderProductCollect создается для каждой штуки товара из заказа, чтобы правильно обрабатывать резерв остатков и была возможность работать с разными приемками товаров на склад, который создают каждый раз WmsItem", "operationId": "getCollectOrderProduct", "parameters": [ { "name": "orderId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/findOrderProductCollectByProductBarcode": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Найти заказ по штрих-коду с резервированием заказа за пользователем", "description": "Позволяет найти сборочные позиции заказа по штрих-коду. А так же зарезервировать заказ за текущим пользователем", "operationId": "findOrderProductCollectByProductBarcode", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код товара из заказа", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Маркетплейс заказа", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "express", "in": "query", "description": "Отфильтровать Express заказы", "required": false, "schema": { "type": "boolean" } }, { "name": "warehouseId", "in": "query", "description": "Склад заказа", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "organizationId", "in": "query", "description": "Организация", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменять наборы на компоненты", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/findOrderCollectsByItem": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заданий по уникальному коду", "description": "Позволяет найти товары из заказа для сборки по одному уникальному коду, который сейчас зарезервирован под этот заказ", "operationId": "findOrderCollectsByItem", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код уникального кода", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } } } } } }, "/api/fbs/findOrderByProductCode": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заказа по коду маркировки", "description": "Позволяет найти заказ по коду маркировки", "operationId": "findOrderByProductCode", "parameters": [ { "name": "mark", "in": "query", "description": "Код маркировки", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/api/fbs/findOrderByProductBarcode": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Поиск заказов на упаковку", "description": "Позволяет найти заказ по штрих-коду товара. Метод используется для сборки заказов через задание по упаковке", "operationId": "findOrderByProductBarcode", "parameters": [ { "name": "barcode", "in": "query", "description": "Штрих-код товара из заказа", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Маркетплейс заказа", "required": false, "schema": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, { "name": "express", "in": "query", "description": "Отфильтровать Express заказы", "required": false, "schema": { "type": "boolean" } }, { "name": "warehouseId", "in": "query", "description": "Склад заказа", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "organizationId", "in": "query", "description": "Организация", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "forceReplaceSetByComponent", "in": "query", "description": "Принудительно заменять все комплекты на компоненты", "required": false, "schema": { "type": "boolean" } }, { "name": "replaceSetByComponent", "in": "query", "description": "Заменять наборы на компоненты, в зависимости от использованных остатков", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/api/fbs/findCollectTask": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Получение список сборочных заданийпо фильтру", "description": "Возвращает список сборочных заданий по фильтру. В сборочных заданиях отдаются ", "operationId": "findCollectTasks", "parameters": [ { "name": "finished", "in": "query", "description": "Завершено?", "required": false, "schema": { "type": "boolean", "description": "Завершено?" } }, { "name": "limit", "in": "query", "description": "Ограничение на количество записей. Максимальное значение - 500", "required": false, "schema": { "type": "integer", "description": "Ограничение на количество записей. Максимальное значение - 500", "format": "int32" } }, { "name": "page", "in": "query", "description": "Номер страницы начиная с 1", "required": false, "schema": { "type": "integer", "description": "Номер страницы начиная с 1", "format": "int32" } }, { "name": "count", "in": "query", "description": "Возвратить в ответе общее количество записей", "required": false, "schema": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" } }, { "name": "sortBy", "in": "query", "description": "Поле для сортировки", "required": false, "schema": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "TASK" ] } }, { "name": "ascending", "in": "query", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка.", "required": false, "schema": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/FindResponseCollectOrderTask" } } } } } } }, "/api/fbs/excel": { "get": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Excel со списком заказов", "description": "Скачивает Excel файл со списком заказов по фильтру", "operationId": "excel", "parameters": [ { "name": "filter", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/OrderFilter" } } ], "responses": { "200": { "description": "OK", "content": { "application/hal+json": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/fbs/label": { "delete": { "tags": [ "Заказы со склада поставщика (FBS)" ], "summary": "Удалить этикетку заказа", "description": "Позволяет удалить этикетку заказа, чтобы ее заново загрузить. В теле запроса передается массив из ID заказов SelSup, для которых необходимо удалить этикетку", "operationId": "deleteLabel", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "Address": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "postCode": { "type": "string" }, "country": { "$ref": "#/components/schemas/Country" }, "region": { "$ref": "#/components/schemas/Region" }, "regionId": { "type": "integer", "format": "int32" }, "street": { "type": "string" }, "house": { "type": "string" }, "district": { "type": "string" }, "city": { "type": "string" }, "locality": { "type": "string" }, "building": { "type": "string" }, "flat": { "type": "string" }, "short": { "type": "string" }, "full": { "type": "string" }, "addressId": { "$ref": "#/components/schemas/Address" } }, "description": "Адресс организации" }, "AliexpressCategory": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "aliexpressId": { "type": "integer", "format": "int64" }, "lastSyncDate": { "type": "string", "description": "Дата последней синхронизации категории", "format": "date-time" }, "notChangedDays": { "type": "integer", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются", "format": "int32" }, "isLeaf": { "type": "boolean", "description": "Категория является листовой. Карточки можно добавлять только в листовые" } }, "description": "Категория Aliexpress" }, "AvitoCategory": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор категории на Авито.Совпадает с идентификатором Авито", "format": "int64" }, "name": { "type": "string", "description": "Полное название категории (включает в себя названия родительских категорий)" }, "shortName": { "type": "string", "description": "Краткое название категории" }, "published": { "type": "boolean", "description": "Опубликована категория" }, "parentId": { "type": "integer", "description": "id родительской категории Авито. Используется при импорте обьявлений с Авито", "format": "int64" }, "lastSyncDate": { "type": "string", "description": "Дата последней синхронизации категории", "format": "date-time" }, "isLeaf": { "type": "boolean", "description": "Категория является листовой. Карточки можно добавлять только в листовые" }, "goodsType": { "type": "string", "description": "Тег GoodsType в фиде" }, "category": { "type": "string", "description": "Тег Category в фиде" } }, "description": "Категория Авито" }, "Box": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "barcode": { "type": "string", "description": "Уникальный штрих-код короба" }, "type": { "type": "string", "description": "Тип короба в зависимости от типа заказа Order.boxType", "enum": [ "DEFAULT", "MONO", "MONO_PALLET", "SUPERSEIF", "QR", "FBS" ] }, "userId": { "type": "integer", "description": "Пользователь, который создал короб", "format": "int32" }, "createdUser": { "type": "string", "description": "Логин пользователя, который создал короб" }, "createdDate": { "type": "string", "description": "Дата создания короба", "format": "date-time" }, "orderId": { "type": "integer", "description": "Заказ к которому привязан короб", "format": "int64" }, "supplyId": { "type": "integer", "format": "int64" }, "clientId": { "type": "integer", "format": "int64" }, "organizationId": { "type": "integer", "format": "int64" }, "orderToSelect": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "products": { "type": "array", "description": "Выполненные работы для этого короба", "items": { "$ref": "#/components/schemas/BoxItem" } }, "quantity": { "type": "integer", "description": "Общее количество товаров в коробе, вычисляется при запросе", "format": "int32" }, "markQuantity": { "type": "integer", "description": "Общее количество маркировок в коробе, вычисляется при запросе", "format": "int32" }, "itemsCountInBoxLabel": { "type": "integer", "description": "Количество позиций в последнем скачанном стикере короба", "format": "int32" }, "labelUrl": { "type": "string", "description": "URL для получения стикера короба поставки", "readOnly": true }, "labelPath": { "type": "string", "description": "Путь к стикеру короба поставки в S3", "readOnly": true } }, "description": "Короб, в который упаковываются товары" }, "BoxItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "jobId": { "type": "integer", "description": "Идентификатор работы Job", "format": "int32" }, "box": { "$ref": "#/components/schemas/Box" }, "orderId": { "type": "integer", "description": "Заказ Order, к которому относится товар", "format": "int64" }, "orderProductId": { "type": "integer", "description": "Позиция в заказе, над которой выполнялась операция", "format": "int64" }, "product": { "$ref": "#/components/schemas/Product" }, "productId": { "type": "integer", "description": "ID товара, над которым выполнялась операция", "format": "int64" }, "quantity": { "type": "integer", "description": "Количество единиц товара, которые были упакованы", "format": "int32" }, "userId": { "type": "integer", "description": "Пользователь, который выполнил задание", "format": "int32" }, "date": { "type": "string", "description": "Дата выполнения задания", "format": "date-time" }, "price": { "type": "number", "description": "Оплата, которую получит исполнитель за выполнение данного задания", "format": "double" }, "comment": { "type": "string", "description": "Комментарий по работе" }, "correctOrderProductQuantity": { "type": "boolean", "description": "Корректировать количество товаров в заказе" }, "spendTime": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int64" } }, "description": "Добавленный в короб товар" }, "Brand": { "required": [ "name" ], "type": "object", "properties": { "brandId": { "type": "integer", "description": "Идентификатор бренда", "format": "int32", "readOnly": true }, "name": { "type": "string", "description": "Название бренда" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "logoUrl": { "type": "string", "description": "Ссылка логотипа бренда", "readOnly": true }, "logoSize": { "type": "integer", "description": "Размер логотипа в байтах", "format": "int32", "readOnly": true }, "logoWidth": { "type": "integer", "description": "Ширина логотипа в пикселях", "format": "int32", "readOnly": true }, "logoHeight": { "type": "integer", "description": "Высота логотипа в пикселях", "format": "int32", "readOnly": true }, "deleted": { "type": "boolean", "description": "Бренд удален?" }, "ozonName": { "type": "string", "description": "Название бренда на Ozon" }, "ozonId": { "type": "integer", "description": "ID бренда на Ozon", "format": "int64" }, "oneCId": { "type": "string", "description": "Идентификатор 1С" } }, "description": "Бренд", "readOnly": true }, "Category": { "required": [ "name", "tnved" ], "type": "object", "properties": { "categoryId": { "type": "integer", "description": "Идентификатор категории. Проставляется автоматически", "format": "int32", "readOnly": true }, "name": { "maxLength": 255, "type": "string", "description": "Наименование категории" }, "deleted": { "type": "boolean", "description": "Признак удаленных категорий", "readOnly": true }, "parentId": { "type": "integer", "description": "Идентификатор родительской категории", "format": "int32" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "marked": { "type": "boolean", "description": "Маркируется ли категория" }, "categoryClass": { "type": "string", "description": "Группы категорий Честного знака", "enum": [ "SHOES", "LIGHT", "DRUGS", "CAMERA", "TYRES", "MILK", "WATER", "TOBACCO", "FURS", "BEER", "BICYCLES", "PERFUMES", "ELECTRONIC", "OTHER", "NONE", "FOOD", "WHEELCHAIRS", "OTP", "NCP", "BIO", "ANTISEPTIC", "NABEER", "SOFTDRINKS", "PETFOOD", "SEAFOOD", "MEAT", "TOYS", "TITAN", "RADIO", "OPTIC_FIBER", "VEGETABLE_OIL", "CONSERVE", "VETPHARMA", "CHEMISTRY", "AUTOFLUIDS", "GROCERY", "BOOKS", "CONSTRUCTION", "FIRE", "HEATER", "CABLERAW", "POLYMER", "SWEETS" ] }, "wildberriesType": { "$ref": "#/components/schemas/WildberriesType" }, "wildberriesCategoryId": { "type": "integer", "description": "Идентификатор категории Wildberries, совпадает с ID категории на самом Wildberries", "format": "int64" }, "wildberriesFbmCommission": { "type": "number", "description": "Комиссия по тарифу FBM", "format": "double", "readOnly": true }, "wildberriesFbwCommission": { "type": "number", "description": "Комиссия по тарифу FBW", "format": "double", "readOnly": true }, "wildberriesFbsCommission": { "type": "number", "description": "Комиссия по тарифу FBS", "format": "double", "readOnly": true }, "wildberriesDbsCommission": { "type": "number", "description": "Комиссия по тарифу DBS", "format": "double", "readOnly": true }, "wildberriesEdbsCommission": { "type": "number", "description": "Комиссия по тарифу EDBS", "format": "double", "readOnly": true }, "wildberriesCAndCCommission": { "type": "number", "description": "Комиссия по тарифу C&C", "format": "double", "readOnly": true }, "wildberriesBookingCommission": { "type": "number", "description": "Комиссия за бронирование", "format": "double", "readOnly": true }, "ozonDescriptionCategoryId": { "type": "integer", "description": "Идентификатор категории на Ozon. Строится из ID категории + ID типа на Ozon", "format": "int64" }, "yandexMarketCategoryId": { "type": "integer", "description": "Идентификатор категории в Яндекс.Маркет. Совпадает с идентификатором категории на самом Яндекс.Маркет", "format": "int64" }, "yandexMarketCategory": { "$ref": "#/components/schemas/YandexMarketCategory" }, "ozonDescriptionCategory": { "$ref": "#/components/schemas/OzonDescriptionCategory" }, "ozonCommission": { "type": "number", "description": "Комиссия озона.", "format": "double", "readOnly": true }, "tnved": { "$ref": "#/components/schemas/Tnved" }, "tnvedId": { "type": "integer", "description": "Идентификатор ТНВЭД", "format": "int64" }, "laundry": { "type": "string", "description": "Правила ухода за вещами. Разделяются запятыми" }, "params": { "type": "string", "description": "JSON значений параметров для категории" }, "namePattern": { "type": "string", "description": "Шаблон названий категории" }, "aliexpressCategory": { "$ref": "#/components/schemas/AliexpressCategory" }, "aliexpressCategoryId": { "type": "integer", "description": "Идентификатор категории на самом Aliexpress", "format": "int64" }, "avitoCategory": { "$ref": "#/components/schemas/AvitoCategory" }, "avitoCategoryId": { "type": "integer", "description": "Идентификатор категории на самом Avito", "format": "int64" }, "packDepth": { "type": "integer", "description": "Глубина упаковки в мм. Проставляется всем товарам в категории", "format": "int32" }, "packWidth": { "type": "integer", "description": "Ширина упаковки в мм. Проставляется всем товарам в категории", "format": "int32" }, "packHeight": { "type": "integer", "description": "Высота упаковки в мм. Проставляется всем товарам в категории", "format": "int32" }, "packWeight": { "type": "integer", "description": "Вес упаковки в граммах. Проставляется всем товарам в категории", "format": "int32" }, "hasSize": { "type": "boolean", "description": "Признак разделения товаров в категории по размеру. Меняет вид редактора карточки" }, "hasColor": { "type": "boolean", "description": "Признак разделения товаров в категории по цвету. Меняет вид редактора карточки" }, "autoName": { "type": "boolean", "description": "Автоматически формировать названия товаров в категории" }, "removeFbsStock": { "type": "boolean", "description": "Не передавать остатки товаров по FBS для товаров из этой категории" }, "oneCId": { "type": "string", "description": "Идентификатор категории в 1С" }, "externalId": { "type": "string", "description": "Идентификатор категории на сайте" }, "moySkladId": { "type": "string", "description": "Идентификатор категории в сервисе МойСклад" }, "useClientParams": { "type": "boolean", "description": "Показывать пользовательские параметры в категории" }, "requiredExpirationDate": { "type": "boolean", "description": "Является ли срок годности обязательным параметром" } }, "description": "Категория" }, "Cell": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор ячейки", "format": "int32", "readOnly": true }, "warehouseId": { "type": "integer", "description": "Склад к которому относится ячейка", "format": "int64" }, "passageId": { "type": "integer", "description": "Проход на складе, к которому относится ячейка. Может соджержать название этажа и пр", "format": "int32" }, "shelfId": { "type": "integer", "description": "Полка стеллажа, к которой относится ячейка", "format": "int32" }, "rackId": { "type": "integer", "description": "Стеллаж, к которому относится ячейка", "format": "int32" }, "name": { "type": "string", "description": "Название ячейки. По умолчанию формируется автоматически" }, "fullName": { "type": "string", "description": "Полное название ячейки из названий прохода, стелажа, полки и ячейки" }, "sortName": { "type": "string", "description": "Название для сортировки ячейки из названий прохода, стелажа, полки и ячейки" }, "barcode": { "type": "string", "description": "Уникальный в рамках клиента штрих-код ячейки для идентификации ячейки с помощью сканера штрих-кода. Присваивается автоматически при создании ячейки" }, "deleted": { "type": "boolean", "description": "Признак того, что ячейка удалена" }, "width": { "type": "integer", "description": "Ширина ячейки для определения товаров, которые можно положить в нее", "format": "int32" }, "height": { "type": "integer", "description": "Высота ячейки для определения товаров, которые можно положить в нее", "format": "int32" }, "depth": { "type": "integer", "description": "Глубина ячейки для определения товаров, которые можно положить в нее", "format": "int32" }, "clientId": { "type": "integer", "description": "Клиент которому принадлежит ячейка. Проставляется автоматически", "format": "int64", "readOnly": true }, "lastInventoryId": { "type": "integer", "description": "Идентификатор последней инвентаризации", "format": "int32", "readOnly": true }, "type": { "type": "string", "description": "Тип ячейки: NORMAL, NO_PLACE - не разложенные, REFUND - для возвратов", "enum": [ "NORMAL", "NO_PLACE", "REFUND" ] } }, "description": "Ячейка хранения товара на складе, в которой может храниться один или несколько товаров" }, "Contractor": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор контрагента. Проставляется автоматически", "format": "int64" }, "name": { "maxLength": 255, "type": "string", "description": "Наименование контрагента" }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "createdUser": { "type": "string", "description": "Логин пользователя, который создал контрагента", "readOnly": true }, "lastIncomeDate": { "type": "string", "description": "Дата последнего поступления для этого контрагента для сортировки", "format": "date-time", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления контрагента", "readOnly": true }, "organizationId": { "type": "integer", "description": "Организация для реквизитов контрагента", "format": "int64" }, "phoneNumber": { "maxLength": 200, "type": "string", "description": "Номер телефона" }, "email": { "maxLength": 200, "type": "string", "description": "Адрес электронной почты" }, "contactName": { "maxLength": 200, "type": "string", "description": "Имя контакта" }, "moySkladId": { "type": "string", "description": "Идентификатор в сервисе МойСклад" }, "url": { "type": "string", "description": "Ссылка на сайт" }, "organization": { "$ref": "#/components/schemas/Organization" } }, "description": "Контрагенты", "readOnly": true }, "Country": { "type": "object", "properties": { "countryId": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название страны" }, "code2": { "type": "string", "description": "Двухбуквенный код страны" }, "code3": { "type": "string", "description": "Трехбуквенный код страны" }, "printName": { "type": "string" } }, "description": "Страна" }, "Customer": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор покупателя. Проставляется автоматически при создании", "format": "int64" }, "name": { "maxLength": 60000, "type": "string", "description": "Имя покупателя" }, "lastName": { "maxLength": 255, "type": "string", "description": "Фамилия покупателя" }, "middleName": { "maxLength": 255, "type": "string", "description": "Отчество покупателя" }, "wildberriesId": { "type": "integer", "description": "Связь покупателя с поставщиком в Wildberries", "format": "int64", "readOnly": true }, "ozonId": { "type": "integer", "description": "Связь покупателя с поставщиком в Ozon", "format": "int64", "readOnly": true }, "aliexpressId": { "type": "integer", "description": "Связь покупателя с поставщиком в Aliexpress", "format": "int64", "readOnly": true }, "yandexMarketId": { "type": "string", "description": "Связь покупателя с поставщиком в YandexMarket", "readOnly": true }, "sberMegaMarketId": { "type": "integer", "description": "Связь покупателя с поставщиком в СберМегаМаркет", "format": "int32", "readOnly": true }, "phone": { "maxLength": 100, "type": "string", "description": "Телефон" }, "email": { "maxLength": 100, "type": "string", "description": "Адрес электронной почты" }, "address": { "maxLength": 250, "type": "string", "description": "Строковый адрес доставки для покупателя" }, "zipCode": { "type": "string", "description": "Почтовый индекс покупателя." }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "lastOrderProduct": { "$ref": "#/components/schemas/OrderProduct" }, "moySkladId": { "type": "string", "description": "Идентификатор клиента в сервисе МойСклад", "readOnly": true }, "fullName": { "type": "string" } }, "description": "Покупатель товаров", "readOnly": true }, "Driver": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "surname": { "type": "string" }, "carNumber": { "type": "string" }, "carMark": { "type": "string" }, "clientId": { "type": "integer", "format": "int64" }, "driverId": { "type": "integer", "format": "int32", "writeOnly": true } } }, "Manufacturer": { "required": [ "name" ], "type": "object", "properties": { "manufacturerId": { "type": "integer", "description": "Идентификатор производителя. Генерируется автоматически", "format": "int32" }, "title": { "type": "string", "description": "Название производителя внешнее для печати" }, "name": { "type": "string", "description": "Название производителя внутреннее" }, "address": { "type": "string", "description": "Адрес производителя производителя внутреннее" }, "organizationId": { "type": "integer", "description": "Связь производителя с организацией - контрагентом", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "countryId": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "countryName": { "type": "string", "description": "Название страны", "readOnly": true }, "inn": { "type": "string", "description": "ИНН производителя, используется в основном для Честного знака" }, "deleted": { "type": "boolean", "description": "Если true - производитель удален" }, "oneCId": { "type": "string", "description": "Идентификатор в 1С" } }, "description": "Производитель", "readOnly": true }, "Option": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор значения, может отсутствовать", "format": "int64" }, "name": { "type": "string", "description": "Название значения, лучше всегда передавать" }, "paramId": { "type": "integer", "description": "Идентификатор значения параметра Param.id", "format": "int64" }, "ozonId": { "type": "integer", "description": "Идентификатор значения параметра на Ozon", "format": "int64" }, "wildberriesId": { "type": "integer", "description": "Признак того, что значение параметра WB", "format": "int64" }, "ymId": { "type": "integer", "description": "Признак того, что значение параметра YM", "format": "int64" }, "aliexpressId": { "type": "integer", "description": "Идентификатор значения параметра на Aliexpress", "format": "int64" }, "clientId": { "type": "integer", "format": "int64" }, "deleted": { "type": "boolean" }, "oneCId": { "type": "string", "description": "Идентификатор значения параметра в 1С" }, "dictionary": { "type": "boolean" }, "optionId": { "$ref": "#/components/schemas/Option" } }, "description": "Значение перечислимого параметра" }, "Order": { "required": [ "markingType", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор заказа. Проставляется автоматически", "format": "int64" }, "name": { "type": "string", "description": "Название заказа" }, "status": { "type": "string", "description": "Статус заказа", "readOnly": true, "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "bindingOrderId": { "type": "integer", "description": "Ид заказа, которому делаем возврат", "format": "int64" }, "type": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "boxType": { "type": "string", "description": "Вид упаковки для заказа", "enum": [ "DEFAULT", "MONO", "MONO_PALLET", "SUPERSEIF", "QR", "FBS" ] }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "writeOffStocks": { "type": "boolean", "description": "Списать товары с остатков" }, "warehouseId": { "type": "integer", "description": "Склад на который производится отгрузка", "format": "int64" }, "stockWarehouseId": { "type": "integer", "description": "Склад для списания остатков", "format": "int64" }, "createdDate": { "type": "string", "description": "Дата создания заказа на маркетплейсе", "format": "date-time", "readOnly": true }, "created": { "type": "string", "description": "Дата создания заказа в SelSup", "format": "date-time", "readOnly": true }, "deliveryDate": { "type": "string", "description": "Дата доставки заказа", "format": "date-time" }, "deliveryMethod": { "type": "integer", "description": "Способ доставки заказа", "format": "int64", "readOnly": true }, "deliveryMethodName": { "type": "string", "description": "Название способа доставки заказа", "readOnly": true }, "invoiceNumber": { "type": "integer", "description": "Короткий номер заказа", "format": "int32" }, "externalOrderId": { "type": "string", "description": "Внешний номер заказа на маркетплейсе" }, "postingNumber": { "type": "string", "description": "Номер отправления." }, "trackingNumber": { "type": "string", "description": "Трек-номер отправления" }, "wildberriesRid": { "type": "string", "description": "Идентификатор заказа Вайлдбериз", "readOnly": true }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "organizationId": { "type": "integer", "description": "Организация заказа", "format": "int64" }, "invoiceMessage": { "type": "string", "description": "Сообщение при отправке счета", "readOnly": true }, "deleted": { "type": "boolean", "description": "Статус удаления заказа", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, создавший заказ", "readOnly": true }, "userId": { "type": "integer", "description": "Пользователь, который взял этот заказ", "format": "int32", "readOnly": true }, "closeUserId": { "type": "integer", "description": "Пользователь, который закрыл заказ", "format": "int32", "readOnly": true }, "closeDate": { "type": "string", "description": "Дата, когда был закрыт заказ", "format": "date-time", "readOnly": true }, "startCollectDate": { "type": "string", "description": "Дата и время начала сборки заказа", "format": "date-time", "readOnly": true }, "supplyId": { "type": "integer", "description": "Идентификатор поставки", "format": "int64", "readOnly": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "customerId": { "type": "integer", "description": "ID покупателя", "format": "int64", "writeOnly": true }, "buyer": { "$ref": "#/components/schemas/Contractor" }, "buyerId": { "type": "integer", "description": "ID грузополучателя для WHOLESALE", "format": "int64", "writeOnly": true }, "supplier": { "$ref": "#/components/schemas/Contractor" }, "supplierId": { "type": "integer", "description": "Идентификатор поставщика", "format": "int64", "writeOnly": true }, "totalQuantity": { "type": "integer", "description": "Общее количество товара в заказе для отображения на списке товаров", "format": "int32", "readOnly": true }, "totalPrice": { "type": "number", "description": "Общая цена заказа", "format": "double", "readOnly": true }, "totalPriceWithExpenses": { "type": "number", "description": "Сумма заказа с доп расходами", "format": "double", "readOnly": true }, "totalPurchasePrice": { "type": "number", "description": "Сумма закупочных цен", "format": "double", "readOnly": true }, "products": { "type": "array", "description": "Список товаров заказа. Отдается только для FBS и при запросе информации о заказе. При создании можно передавать список товаров в запросе", "items": { "$ref": "#/components/schemas/OrderProduct" } }, "supply": { "$ref": "#/components/schemas/Supply" }, "labelsPath": { "type": "string", "description": "Путь к этикеткам для заказа", "readOnly": true }, "labelsUrl": { "type": "string", "description": "URL к этикеткам для заказа", "readOnly": true }, "moySkladId": { "type": "string", "description": "Идентификатор заказа Мой Склад", "readOnly": true }, "moySkladDemandId": { "type": "string", "description": "Идентификатор отгрузки Мой Склад", "readOnly": true }, "wildberriesStickerId": { "type": "integer", "description": "Идентификатор этикетки для FBS. Используется для печати и сканировании кода заказа", "format": "int64", "readOnly": true }, "wildberriesStickerEncoded": { "type": "string", "description": "Штрих-код этикетки для FBS. Используется при сканировании кода заказа", "readOnly": true }, "aliexpressHandoverId": { "type": "integer", "description": "Лист передачи с отправлениями Aliexpress", "format": "int64", "readOnly": true }, "express": { "type": "boolean", "description": "Является ли заказ Express - быстрая доставка курьеру в течении получаса - часа", "readOnly": true }, "updateInService": { "type": "boolean", "description": "Пометка необходимости обновить статус на маркетплейсе", "readOnly": true }, "quantumId": { "type": "integer", "description": "Идентификатор эконом-товара. Для OZON заказов", "format": "int64" }, "message": { "type": "string", "description": "Сообщение об ошибке при обновлении заказа во внешнем сервисе", "readOnly": true }, "messageParams": { "type": "string", "description": "JSON параметры сообщения об ошибке при обновлении заказа во внешнем сервисе", "readOnly": true }, "sberDeliveryNumber": { "type": "string", "description": "Номер доставки СберМегаМаркет (SberOrder.deliveryId)", "readOnly": true }, "checkDate": { "type": "string", "description": "Дата проверки отгрузки заказа", "format": "date-time", "readOnly": true }, "comment": { "type": "string", "description": "Комментарий к заказу" }, "oneCId": { "type": "string", "description": "Идентификатор заказа в 1С", "readOnly": true }, "gtd": { "type": "string", "description": "Номер государственной таможенной декларации" }, "gtdDate": { "type": "string", "description": "Дата государственной таможенной декларации для Честного знака", "format": "date-time" }, "customCode": { "type": "string", "description": "Код таможни ГТД" }, "decisionCode": { "type": "string", "description": "Код решения таможни" }, "remarkingCause": { "type": "string", "description": "Код причины перемаркировки", "enum": [ "KM_SPOILED", "DESCRIPTION_ERRORS", "RETAIL_RETURN", "REMOTE_SALE_RETURN", "LEGAL_RETURN", "INTERNAL_RETURN", "EEC_EXPORT_RETURN" ] }, "serviceWarehouseId": { "type": "string", "description": "Склад на маркетплейсе", "readOnly": true }, "supplySuccess": { "type": "boolean" }, "deliveryRegion": { "type": "string", "description": "Регион доставки." }, "logistics": { "type": "number", "description": "Затраты на логистику.", "format": "double" }, "totalCommissions": { "type": "number", "description": "Общая комиссия на товары в заказе.", "format": "double", "readOnly": true }, "saleDate": { "type": "string", "description": "Дата продажи.", "format": "date-time", "readOnly": true }, "returnDate": { "type": "string", "description": "Дата возврата.", "format": "date-time", "readOnly": true }, "modifiedDate": { "type": "string", "description": "Дата последнего изменения статуса", "format": "date-time", "readOnly": true }, "sberBoxIndex": { "type": "integer", "description": "Номер грузового места для СберМегаМаркета", "format": "int32", "readOnly": true }, "markingStatus": { "type": "string", "description": "Статус маркировки для заказа", "readOnly": true, "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] }, "markingType": { "type": "string", "description": "Тип заказа для маркировки", "enum": [ "PRODUCTION", "IMPORT", "REMAINS", "REMARK", "COMMISSION" ] }, "deliveryService": { "type": "string", "description": "Сервис доставки для DBS", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] }, "deliveryServiceIdentification": { "type": "string", "description": "Идентификатор заказа в сервисе доставки", "readOnly": true }, "deliveryPoint": { "type": "string", "description": "JSON точки доставки заказа для выбранной службы доставки" }, "deliveryPointCode": { "type": "string", "description": "Код точки доставки от маркетплейса" }, "deliveryLabelPath": { "type": "string", "description": "Путь на файл с накладной службы доставки", "readOnly": true }, "deliveryLabelUrl": { "type": "string", "description": "Ссылка на файл с накладной службы доставки", "readOnly": true }, "deliveryLabelRequest": { "type": "string", "description": "ID запроса на формирование этикетки", "readOnly": true }, "labelRequest": { "type": "string", "description": "ID запроса на формирование этикетки", "readOnly": true }, "labelTaskId": { "type": "integer", "description": "ID задачи на формирование стикера", "format": "int64", "readOnly": true }, "edoId": { "type": "string", "description": "Идентификатор документа в ЭДО", "readOnly": true }, "dropShippingOrderId": { "type": "string", "description": "Номер заказа в котором производится закупка товара или номер заказа по модели дроп шипинга" }, "deliveryInvoiceNumber": { "type": "string", "description": "Номер транспортной накладной" }, "fromAnalyticData": { "type": "boolean", "description": "Данные пришли из profit_report" }, "serviceWarehouse": { "type": "string", "description": "Склад отгрузки c МП" }, "deliveryPointType": { "type": "string", "description": "Доставка до (пункт выдачи / адрес)", "enum": [ "ADDRESS", "DELIVERY_POINT" ] }, "lastStatusUpdate": { "type": "string", "description": "Дата последнего обновления статуса с маркетплейсов", "format": "date-time", "readOnly": true }, "incomeId": { "type": "integer", "description": "id ордера типа INCOME", "format": "int64" }, "boxLimit": { "type": "integer", "description": "Ограничение на количество коробов", "format": "int32" }, "timeZone": { "type": "integer", "description": "Часовой пояс клиента по UTC", "format": "int32" }, "packages": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPackage" } }, "stickerId": { "type": "integer", "description": "Код на стикере заказа в виде номера", "format": "int64" }, "stickerText": { "type": "string", "description": "Код на стикере заказа для сканирования (штрих-код или qr-код)" }, "buyerCustomer": { "$ref": "#/components/schemas/YandexMarkerBuyerInfo" } }, "description": "Заказ (накладная) на отгрузку. В заказе обязательно должен быть хотя бы один товар" }, "OrderPackage": { "type": "object", "properties": { "packageId": { "type": "integer", "description": "Идентификатор грузового места. Передавать только для уже созданных грузовых мест", "format": "int64" }, "orderId": { "type": "integer", "description": "Идентификатор заказа", "format": "int64", "readOnly": true }, "number": { "type": "string", "description": "Номер грузового места" }, "width": { "type": "integer", "description": "Ширина грузового места", "format": "int32" }, "height": { "type": "integer", "description": "Высота грузового места", "format": "int32" }, "length": { "type": "integer", "description": "Длина грузового места", "format": "int32" }, "weight": { "type": "integer", "description": "Вес грузового места", "format": "int32" }, "items": { "type": "array", "description": "Список товаров в грузовом месте", "items": { "$ref": "#/components/schemas/OrderPackageItem" } }, "clientId": { "type": "integer", "description": "Клиент - проставляется автоматически", "format": "int64", "readOnly": true }, "organizationId": { "type": "integer", "description": "Организация - проставляется автоматически", "format": "int64", "readOnly": true } }, "description": "Грузовое место заказа" }, "OrderPackageItem": { "required": [ "orderProductId", "productId", "quantity" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор позиции в грузовом месте. Передавать только при обновлении", "format": "int64" }, "orderProductId": { "type": "integer", "description": "Идентификатор позиции в заказе", "format": "int64" }, "productId": { "type": "integer", "description": "Идентификатор товара", "format": "int64" }, "packageId": { "type": "integer", "description": "Идентификатор грузового места", "format": "int64", "readOnly": true }, "quantity": { "type": "integer", "description": "Количество товара", "format": "int32" }, "product": { "$ref": "#/components/schemas/Product" }, "packageItemOrderProductId": { "$ref": "#/components/schemas/OrderPackageItem" }, "packageItemPackageId": { "$ref": "#/components/schemas/OrderPackageItem" }, "packageItemProductId": { "$ref": "#/components/schemas/OrderPackageItem" }, "packageItemQuantity": { "$ref": "#/components/schemas/OrderPackageItem" }, "packageItemId": { "$ref": "#/components/schemas/OrderPackageItem" } }, "description": "Список товаров в грузовом месте" }, "OrderProduct": { "type": "object", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор позиции в заказе", "format": "int64" }, "orderId": { "type": "integer", "description": "Идентификатор заказа", "format": "int64" }, "collected": { "type": "boolean", "description": "Признак того, что позиция собрана полностью на складе" }, "collectedQuantity": { "type": "integer", "description": "Сколько штук собрано в позиции", "format": "int32" }, "reservedForCollectQuantity": { "type": "integer", "description": "Сколько штук собрано в позиции", "format": "int32" }, "product": { "$ref": "#/components/schemas/Product" }, "productId": { "type": "integer", "description": "Идентификатор карточки товара, может использоваться для простановки связи с товаром при вставке", "format": "int64" }, "quantity": { "type": "integer", "description": "Количество товара", "format": "int32" }, "introducedQuantity": { "type": "integer", "description": "Количество уже принятого остатка товара для приемки на склад", "format": "int32" }, "price": { "type": "number", "description": "Цена товара", "format": "double" }, "bonusPrice": { "type": "number", "description": "Цена c бонусами маркетплейса", "format": "double" }, "otherExpenses": { "type": "number", "description": "Дополнительные расходы на товар", "format": "double" }, "wholesalePrice": { "type": "number", "description": "Оптовая цена товара. Не обязательна, нужна была раньше для Wildberries", "format": "double" }, "boxes": { "type": "string" }, "position": { "type": "integer", "description": "Позиция товара в заказе для сортировки", "format": "int32" }, "cell": { "$ref": "#/components/schemas/Cell" }, "cellId": { "type": "integer", "description": "Ячейка хранения товара для поступления", "format": "int32" }, "sourceCell": { "$ref": "#/components/schemas/Cell" }, "sourceCellId": { "type": "integer", "description": "Исходная ячейка хранения товара для перемещения", "format": "int32" }, "createdDate": { "type": "string", "description": "Дата добавления товара в заказ", "format": "date-time" }, "createdUser": { "type": "string", "description": "Логин пользователя, который добавил позицию" }, "error": { "type": "string", "description": "Описание ошибки при взаимодействии с внешними сервисами" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "externalProductId": { "type": "integer", "description": "Идентификатор товара в системе Яндекс.Маркета или СберМегаМаркет", "format": "int64" }, "sberProductIndex": { "type": "string", "description": "Порядковый номер лота СберМегаМаркет" }, "markingRequired": { "type": "boolean", "description": "Признак обязательности маркировки для данного товара" }, "countryRequired": { "type": "boolean", "description": "Признак обязательности страны производства для данного товара" }, "rnpt": { "type": "string", "description": "Признак обязательности РНПТ для данного товара" }, "gtdRequired": { "type": "boolean", "description": "Признак обязательности ГТД для данного товара" }, "rnptRequired": { "type": "boolean", "description": "Признак обязательности РНПТ для данного товара" }, "moySkladId": { "type": "string", "description": "Идентификатор позиции в МойСклад" }, "codes": { "type": "array", "description": "Коды маркировки для товаров из заказа", "items": { "$ref": "#/components/schemas/ProductCode" } }, "items": { "type": "array", "description": "Список единиц хранения товара на складе для INCOME, FBS, RETAIL, WHOLESALE", "items": { "$ref": "#/components/schemas/WmsItem" } }, "commission": { "type": "number", "description": "Комиссия в руб.", "format": "double" }, "purchasePrice": { "type": "number", "description": "Закупочная цена", "format": "double" }, "deliveryCost": { "type": "number", "description": "Прочие расходы", "format": "double" }, "deliveryExpenses": { "type": "number", "description": "Расходы на доставку собственной или сторонней службой", "format": "double" }, "components": { "type": "array", "description": "Состав товара для комплектов. Отдается при передачи withComponents", "items": { "$ref": "#/components/schemas/Product" } }, "expiredDate": { "type": "string", "description": "Cрок годности товара", "format": "date-time" }, "productionDate": { "type": "string", "description": "Дата производства товара", "format": "date-time" }, "vsdNumber": { "type": "string", "description": "Идентификатор ВСД для ЧЗ" }, "collectedDate": { "type": "string", "description": "Дата и время сборки заказа FBO", "format": "date-time" }, "startCollectDate": { "type": "string", "description": "Дата и время начала сборки заказа FBO", "format": "date-time" }, "productionType": { "type": "string", "description": "Тип продукта в производственном заказе", "enum": [ "MATERIAL", "RESULT" ] }, "externalPositionId": { "type": "string", "description": "Идентификатор позиции во внешней системе учета (Например, Мой Склад)" }, "opReservedForCollectQuantity": { "$ref": "#/components/schemas/OrderProduct" }, "opVsdNumber": { "$ref": "#/components/schemas/OrderProduct" }, "opCollectedQuantity": { "$ref": "#/components/schemas/OrderProduct" } }, "description": "Позиция товара в заказе. В одном заказе не может быть двух OrderProduct с одинаковым productId" }, "Organization": { "required": [ "form", "inn", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор организации. Проставляется автоматически", "format": "int64", "readOnly": true }, "name": { "type": "string", "description": "Полное наименование организации" }, "shortName": { "type": "string" }, "taxType": { "type": "string", "description": "Система налогооблажения", "enum": [ "YSN", "YSN_CONSUMPTION", "OSNO", "SELF_EMPLOYED" ] }, "taxRate": { "type": "integer", "description": "Ставка налога, если она отличается от стандартной", "format": "int32" }, "taxNds": { "type": "integer", "description": "Ставка налога, если она отличается от стандартной", "format": "int32" }, "inn": { "type": "string", "description": "ИНН" }, "kpp": { "type": "string", "description": "КПП. Проставляется только для ООО" }, "bank": { "type": "string", "description": "Название банка" }, "bik": { "type": "string", "description": "БИК счета организации" }, "corrBill": { "type": "string", "description": "Номер корреспондентского счета" }, "billNumber": { "type": "string", "description": "Номер счета организации" }, "stampPath": { "type": "string", "description": "Ссылка на изображение печати организации", "readOnly": true }, "stampUrl": { "type": "string", "description": "Ссылка на изображение печати организации", "readOnly": true }, "stampSize": { "type": "integer", "description": "Размер в байтах изображения печати организации", "format": "int32", "readOnly": true }, "stampWidth": { "type": "integer", "description": "Ширина изображения печати организации", "format": "int32", "readOnly": true }, "stampHeight": { "type": "integer", "description": "Высота изображения печати организации", "format": "int32", "readOnly": true }, "signaturePath": { "type": "string", "description": "Фото подписи директора организации", "readOnly": true }, "signatureUrl": { "type": "string", "description": "Фото подписи директора организации", "readOnly": true }, "signatureSize": { "type": "integer", "description": "Размер файла в байтах подписи директора организации", "format": "int32", "readOnly": true }, "signatureWidth": { "type": "integer", "description": "Ширина изображения подписи директора", "format": "int32", "readOnly": true }, "signatureHeight": { "type": "integer", "description": "Высота изображения подписи директора", "format": "int32", "readOnly": true }, "ipPerson": { "$ref": "#/components/schemas/Person" }, "form": { "type": "string", "description": "Форма собственности организации", "enum": [ "OOO", "IP", "SELF_EMPLOYED" ] }, "ip": { "type": "boolean" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "address": { "$ref": "#/components/schemas/Address" }, "phoneNumber": { "type": "string", "description": "Номер телефона" }, "addressFull": { "type": "string", "description": "Полный адрес", "readOnly": true } }, "description": "Данные об организации", "readOnly": true }, "OzonDescriptionCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор категории на Ozon. Состоит из двух идентификаторов Категории + ID типа на самом Ozon", "format": "int64" }, "name": { "type": "string", "description": "Название категории" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "isLeaf": { "type": "boolean", "description": "Признак листовой категории, в которой могут находиться товары" }, "lastSyncDate": { "type": "string", "description": "Дата последней синхронизации категории с Озон", "format": "date-time" }, "notChangedDays": { "type": "integer", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются", "format": "int32" }, "isError": { "type": "boolean" }, "errorDate": { "type": "string", "format": "date" }, "types": { "type": "string" }, "typeId": { "type": "integer", "description": "Идентификатор типа на Ozon", "format": "int64" } }, "description": "Категория Озон" }, "ParamValue": { "required": [ "paramId" ], "type": "object", "properties": { "paramId": { "type": "integer", "description": "Идентификатор параметра", "format": "int64" }, "paramName": { "type": "string", "description": "Название параметра, для тех, у кого нет ID" }, "option": { "$ref": "#/components/schemas/Option" }, "doubleValue": { "type": "number", "description": "Числовое значение параметра", "format": "double" }, "longValue": { "type": "integer", "description": "Целочисленное значение параметра", "format": "int64" }, "booleanValue": { "type": "boolean", "description": "Булево значение параметра" }, "stringValue": { "type": "string", "description": "Строковое значение параметра" }, "dateValue": { "type": "string", "description": "Значение параметра даты", "format": "date-time" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "unit": { "$ref": "#/components/schemas/Unit" }, "auto": { "type": "boolean", "description": "Автоматически проставленное значение параметра" }, "created": { "type": "integer", "description": "Дата заполнения параметра", "format": "int64" }, "user": { "type": "string", "description": "Пользователь, который заполнил параметр" } }, "description": "Значение параметра" }, "Person": { "required": [ "firstName", "lastName", "position" ], "type": "object", "properties": { "personId": { "type": "integer", "format": "int64", "readOnly": true }, "firstName": { "maxLength": 255, "type": "string", "description": "Имя сотрудника" }, "lastName": { "maxLength": 255, "type": "string", "description": "Фамилия сотрудника" }, "surName": { "maxLength": 255, "type": "string", "description": "Отчество сотрудника" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "position": { "$ref": "#/components/schemas/PersonPosition" }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64", "readOnly": true }, "createdUser": { "type": "string", "description": "Проставляется автоматически. Пользователь создавший сотрудника", "readOnly": true }, "createdDate": { "type": "string", "description": "Проставляется автоматически. Дата создания сотрудника", "format": "date-time", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления сотрудника", "readOnly": true }, "userId": { "type": "integer", "description": "Связь сотрудника с пользователем", "format": "int32", "readOnly": true }, "hasChanges": { "type": "boolean" }, "fullName": { "type": "string", "description": "Полные ФИО", "readOnly": true }, "shortName": { "type": "string", "description": "Фамилия и инициалы", "readOnly": true } }, "description": "Сотрудник" }, "PersonPosition": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор должности. Проставляется автоматически", "format": "int64", "readOnly": true }, "name": { "maxLength": 255, "type": "string", "description": "Название должности" }, "deleted": { "type": "boolean", "description": "Признак удаления должности", "readOnly": true }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "defaultJobId": { "type": "integer", "description": "Работа по умолчанию для должности", "format": "int64" }, "createdUser": { "type": "string", "description": "Пользователь, который создал должность", "readOnly": true }, "createdDate": { "type": "string", "description": "Дата создания должности", "format": "date-time", "readOnly": true } }, "description": "Должность" }, "Product": { "required": [ "name", "organizationId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор товара. Проставляется автоматически", "format": "int64" }, "productType": { "type": "string", "description": "Тип товара", "enum": [ "PRODUCT", "SET", "SERVICE", "DIGITAL" ] }, "name": { "maxLength": 240, "type": "string", "description": "Наименование товара внутреннее" }, "deleted": { "type": "boolean", "description": "Признак удаления товара", "readOnly": true }, "printName": { "maxLength": 240, "type": "string", "description": "Название товара для внешних сервисов. Если не задано, проставляется равным наименованию товара" }, "realSize": { "maxLength": 255, "type": "string", "description": "Российский размер товара для одежды или характеристики для других категорий" }, "vendorSize": { "maxLength": 200, "type": "string", "description": "Размер производителя или характеристики производителя. Не обязательно заполнять" }, "size": { "maxLength": 200, "type": "string", "description": "Размер для одежды или характеристики для внешних сервисов. Должен быть уникальным в рамках цвета" }, "wildberriesImtId": { "type": "integer", "description": "Используется для категорий, у которых не предусмотрен размер", "format": "int64", "readOnly": true }, "wildberriesStockCount": { "type": "integer", "description": "Остатки товара на Вайлдбериз", "format": "int32", "readOnly": true }, "ozonId": { "type": "integer", "description": "Идентификатор товара Озон на сайте. SKU в озон", "format": "int64", "readOnly": true }, "ozonRealFbs": { "type": "boolean", "description": "Признак использования RealFbs для товара", "readOnly": true }, "ozonProductId": { "type": "integer", "description": "Идентификатор товара Озон в кабинете API", "format": "int64", "readOnly": true }, "wildberriesSizeId": { "type": "integer", "description": "Идентификатор размера на Вайлдбериз", "format": "int64", "readOnly": true }, "simalandId": { "type": "integer", "description": "Уникальный идентификатор товара для Simaland", "format": "int64" }, "ozonArticle": { "maxLength": 255, "type": "string", "description": "Уникальный артикул товара для озон. Offer ID в озон" }, "externalArticle": { "maxLength": 255, "type": "string", "description": "Уникальный артикул товара для стороннего сервиса" }, "ozonStockCount": { "type": "integer", "description": "Остаток товара на складах Озон", "format": "int32", "readOnly": true }, "ozonStockBetweenWarehouses": { "type": "integer", "description": "Остаток товара в Озон, которые перемещаются между складами", "format": "int32", "readOnly": true }, "removeFbsStock": { "type": "boolean", "description": "Не выгружать остатки товара на маркетплейсы" }, "purchaseCurrency": { "type": "string", "description": "Валюта закупочной цены товара", "enum": [ "RUB", "USD", "EUR", "AUD", "AZN", "GBP", "AMD", "BYN", "BGN", "BRL", "HUF", "VND", "HKD", "GEL", "DKK", "AED", "EGP", "INR", "IDR", "KZT", "CAD", "QAR", "KGS", "CNY", "MDL", "NZD", "NOK", "PLN", "RON", "XDR", "SGD", "TJS", "THB", "TRY", "TMT", "UZS", "UAH", "CZK", "SEK", "CHF", "RSD", "ZAR", "KRW", "JPY" ] }, "purchasePriceInCurrency": { "type": "number", "description": "Цена закупки в валюте", "format": "double" }, "deliveryCostInCurrency": { "type": "number", "description": "Цена на доставку в валюте", "format": "double" }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64" }, "createdDate": { "type": "string", "description": "Дата создания товара на МП", "format": "date-time", "readOnly": true }, "created": { "type": "string", "description": "Дата создания товара в SelSup", "format": "date-time", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, который создал товар", "readOnly": true }, "sourceIncomeItemId": { "type": "integer", "description": "Идентификатор товара из заказа поставщика по данным которого был создан товар", "format": "int64" }, "sourceProductId": { "type": "integer", "description": "Идентификатор товара, который копировали", "format": "int64" }, "ozonRequiredStock": { "type": "integer", "description": "Расчитанное количество товара, для поставки на склад Озон", "format": "int32", "readOnly": true }, "wildberriesRequiredStock": { "type": "integer", "description": "Расчитанное количество товара, для поставки на склад Wildberries", "format": "int32", "readOnly": true }, "wildberriesProfit": { "type": "number", "description": "Профит с продажи товара на Вайлдбериз по FBM", "format": "double", "readOnly": true }, "wildberriesProfitFbs": { "type": "number", "description": "Профит с продажи товара на Вайлдбериз по FBS", "format": "double", "readOnly": true }, "wildberriesOrderQuantity": { "type": "integer", "description": "Количество заказов по FBO товара на Вайлдбериз за 2 недели", "format": "int32", "readOnly": true }, "wildberriesSupplyingQuantity": { "type": "integer", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам", "format": "int32", "readOnly": true }, "wildberriesQuantityInWayToClient": { "type": "integer", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам к клиенту", "format": "int32", "readOnly": true }, "wildberriesQuantityInWayFromClient": { "type": "integer", "description": "Поставляемое количество товара на Вайлдбериз по FBM заказам от клиента", "format": "int32", "readOnly": true }, "wildberriesSaleQuantity": { "type": "integer", "description": "Продажи товара на Вайлдбериз по FBM за 2 недели", "format": "int32", "readOnly": true }, "wildberriesQuantityInWay": { "type": "integer", "description": "Количество товаров на Вайлдбериз в пути", "format": "int32", "readOnly": true }, "wildberriesNoSale": { "type": "boolean", "description": "Признак неликвидного товара на Вайлдбериз", "readOnly": true }, "lastStockChange": { "type": "string", "description": "Дата последнего изменения стока на Вайлдбериз по FBM", "format": "date-time", "readOnly": true }, "ozonOrderQuantity": { "type": "integer", "description": "Количество заказов товара по FBO на Озон по FBM и FBS за 2 недели", "format": "int32", "readOnly": true }, "ozonSupplyingQuantity": { "type": "integer", "description": "Поставляемое количество товара на Озон по FBM", "format": "int32", "readOnly": true }, "ozonProfit": { "type": "integer", "description": "Чистая маржа продажи товара на Озон по FBM", "format": "int32", "readOnly": true }, "instockQuantity": { "type": "integer", "description": "Остатки товара на складах клиента", "format": "int32", "readOnly": true }, "calculatedInStockQuantity": { "type": "integer", "description": "Рассчитанный остаток", "format": "int32", "readOnly": true }, "ozonFbsSku": { "type": "integer", "description": "Идентификатор товара в Озон по FBS", "format": "int64", "readOnly": true }, "ozonFboSku": { "type": "integer", "description": "Идентификатор товара в Озон по FBO", "format": "int64", "readOnly": true }, "sellerSku": { "type": "string", "description": "Идентификатор товара на Amazon" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "organizationId": { "type": "integer", "description": "Идентификатор организации", "format": "int64" }, "productViewId": { "type": "integer", "description": "Идентификатор цвета", "format": "int64", "readOnly": true }, "view": { "$ref": "#/components/schemas/ProductView" }, "suzId": { "type": "string", "description": "GTIN товара" }, "cisType": { "type": "string", "description": "Тип в национальном каталоге", "enum": [ "UNIT", "BUNDLE", "GROUP", "SET", "ATK" ] }, "notChangedStock": { "type": "integer", "description": "Количество дней, в течении которых не менялся остаток товара", "format": "int32", "readOnly": true }, "nationalCatalogFeedId": { "type": "integer", "description": "Идентификатор создания карточки в национальном каталоге", "format": "int64", "readOnly": true }, "wildberriesStatus": { "type": "string", "description": "Статус создания карточки товара в Вайлдбериз", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "wildberriesMessage": { "type": "string", "description": "Ошибка создания карточки товара в Вайлдбериз", "readOnly": true }, "wildberriesMessageParams": { "type": "string", "description": "JSON параметров ошибки создания карточки товара в Вайлдбериз", "readOnly": true }, "nationalCatalogStatus": { "type": "string", "description": "Статус создания карточки товара в Национальном каталоге", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "nationalCatalogGoodId": { "type": "integer", "description": "Идентификатор товара в национальном каталоге", "format": "int64", "readOnly": true }, "nationalCatalogMessage": { "type": "string", "description": "Ошибка создания карточки товара в Национальном каталоге", "readOnly": true }, "nationalCatalogMessageParams": { "type": "string", "description": "Параметры ошибки создания карточки товара в Национальном каталоге", "readOnly": true }, "ozonStatus": { "type": "string", "description": "Статус создания карточки товара в Озон", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "ozonMessage": { "type": "string", "description": "Ошибка создания карточки товара в Озон", "readOnly": true }, "ozonMessageParams": { "type": "string", "description": "JSON параметры ошибки создания карточки товара в Озон", "readOnly": true }, "ozonTaskId": { "type": "integer", "description": "Идентификатор задания по обновления или созданию карточки в Озон", "format": "int64", "readOnly": true }, "wildberriesFbsOrdersQuantity": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке WB по FBS за 2 недели", "format": "int32", "readOnly": true }, "ozonFbsOrdersQuantity": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке на Ozon по FBS за 2 недели", "format": "int32", "readOnly": true }, "ymarketFbsOrdersQuantity": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке на Яндекс Маркете по FBS за 2 недели", "format": "int32", "readOnly": true }, "totalSupplyingQuantity": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке за 2 недели", "format": "int32", "readOnly": true }, "skuId": { "type": "integer", "description": "Идентификатор единицы хранения товара на складе. Проставляется автоматически", "format": "int64", "readOnly": true }, "sku": { "$ref": "#/components/schemas/Sku" }, "barcodes": { "type": "array", "description": "Штрих-коды товара", "items": { "$ref": "#/components/schemas/ProductBarcode" } }, "params": { "type": "string", "description": "JSON значений параметров для данного размера/характеристик" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "group": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Product" }, "description": "Группа карточек. Используется на списке товаров, чтобы объединить разные размеры в одну строку", "readOnly": true }, "duplicates": { "type": "array", "description": "Дубликаты карточки по остаткам. Отдаются только на списке товаров, если включена галочка Объединять дубликаты", "readOnly": true, "items": { "$ref": "#/components/schemas/Product" } }, "hasChanges": { "type": "boolean", "description": "Признак наличия изменений в товаре и ее нужно обновить при сохранении" }, "ignoreDuplicate": { "type": "boolean", "description": "Признак игнорирования дубликатов при создании" }, "yandexMarketSku": { "type": "integer", "description": "Идентификатор карточки товара на Yandex.Market", "format": "int64", "readOnly": true }, "yandexMarketStockCount": { "type": "integer", "description": "Остаток товара на складах Yandex.Market", "format": "int64", "readOnly": true }, "yandexMarketProductId": { "type": "integer", "description": "Идентификатор карточки товара на Yandex.Market", "format": "int64", "readOnly": true }, "yandexMarketShopSku": { "type": "string", "description": "SKU товара на Yandex.Market" }, "groupId": { "type": "integer", "description": "ID групповой карточки", "format": "int64" }, "yandexMarketStatus": { "type": "string", "description": "Статус создания карточки товара на яндекс маркет", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "yandexMarketMessage": { "type": "string", "description": "Сообщение при ошибке создания карточки товара на яндекс маркет", "readOnly": true }, "yandexMarketMessageParams": { "type": "string", "description": "Параметры сообщения при создании товара в Яндекс.Маркет", "readOnly": true }, "sberArticle": { "type": "string", "description": "Артикул товара на СберМегаМаркет" }, "siteArticle": { "type": "string", "description": "артикул товара на сайте" }, "siteId": { "type": "string", "description": "айди товара на сайте" }, "leroyMerlinArticle": { "type": "string", "description": "Артикул товара на Леруа Мерлен" }, "ebayArticle": { "type": "string", "description": "Артикул товара на Ebay" }, "lamodaArticle": { "type": "string", "description": "Артикул товара на Lamoda" }, "lamodaSku": { "type": "string", "description": "SKU товара на Lamoda" }, "leroyMerlinId": { "type": "string", "description": "Номер карточки на Леруа Мерлен" }, "duplicate": { "type": "boolean", "description": "Признак, что карточка является дубликатом. Отдается не для всех методов", "readOnly": true }, "ozonHasPhoto": { "type": "boolean", "description": "Признак наличия фото на Ozon", "readOnly": true }, "aliexpressSku": { "type": "string", "description": "SKU на Aliexpress" }, "aliexpressStatus": { "type": "string", "description": "Статус создания товара на Aliexpress", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "aliexpressMessage": { "type": "string", "description": "Сообщение при создании товара на Aliexpress", "readOnly": true }, "aliexpressMessageParams": { "type": "string", "description": "Параметры сообщения при создании товара на Aliexpress", "readOnly": true }, "moySkladId": { "type": "string", "description": "ID товара в сервисе Мой Склад", "readOnly": true }, "moySkladType": { "type": "string", "description": "Тип товара в сервисе Мой Склад", "readOnly": true }, "avitoId": { "type": "integer", "description": "ID товара в сервисе Avito", "format": "int64", "readOnly": true }, "moySkladLinkId": { "type": "string", "description": "ID для ссылки на Мой Склад", "readOnly": true }, "moySkladStatus": { "type": "string", "description": "Статус создания карточки товара в МойСклад", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "avitoStatus": { "type": "string", "description": "Статус обьявления на Авито", "readOnly": true, "enum": [ "UNKNOWN", "CREATING", "CREATED", "SUCCESS", "ERROR", "UPDATING", "EXCEPTION", "SIGN", "MODERATION" ] }, "moySkladMessage": { "type": "string", "description": "Ошибка создания карточки товара в МойСклад", "readOnly": true }, "moySkladMessageParams": { "type": "string", "description": "Параметры ошибки создания карточки товара в МойСклад", "readOnly": true }, "oneCId": { "type": "string", "description": "Идентификатор товара в 1С" }, "removeFbsStockOzon": { "type": "boolean", "description": "Не передавать остатки товара по FBS на озон" }, "removeFbsStockWb": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Wildberries" }, "removeFbsStockAli": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Aliepress" }, "removeFbsStockYm": { "type": "boolean", "description": "Не передавать остатки товара по FBS на Яндекс.Маркет" }, "removeFbsStockSber": { "type": "boolean", "description": "Не передавать остатки товара по FBS на СберМегаМаркет" }, "quantity": { "type": "integer", "description": "Количество товара в заказах. Возвращается только в методах income/getProductsFromOrders или wms/findStock", "format": "int32", "readOnly": true }, "incomeQuantity": { "type": "integer", "description": "Количество товара в закупке без разделения по маркетплейсам", "format": "int32" }, "orderMinDate": { "type": "string", "description": "Минимальная дата заказа. Возвращается только в методах income/getProductsFromOrders", "format": "date-time", "readOnly": true }, "expiredDate": { "type": "string", "description": "Cрок годности товара - возвращается только в методах, wms/findStock", "format": "date-time", "readOnly": true }, "productionDate": { "type": "string", "description": "Дата производства", "format": "date-time", "readOnly": true }, "stock": { "type": "integer", "description": "Остаток товара на определенном складе - возвращается только в методах, wms/fetchStock", "format": "int32", "readOnly": true }, "stocks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ProductStock" }, "description": "Остатки товара на складах - возвращается только в методах, wms/fetchStock", "readOnly": true }, "cell": { "$ref": "#/components/schemas/Cell" }, "reserved": { "type": "integer", "description": "Остаток товара на определенном складе - возвращается только в методах, wms/fetchStock", "format": "int32", "readOnly": true }, "calculatedStock": { "type": "integer", "description": "Остаток наборов на определенном складе - возвращается только в методах, wms/fetchStock, product/findProduct, supply/findProductForOrder", "format": "int32", "readOnly": true }, "price": { "type": "number", "description": "Розничная цена товара", "format": "double" }, "updatedPrice": { "type": "number", "description": "Новая общая цена товара со скидкой. Только для методов обновления цены", "format": "double" }, "priceWithoutDiscount": { "type": "number", "description": "Розничная цена товара без учета скидки", "format": "double" }, "updatedPriceWithoutDiscount": { "type": "number", "description": "Измененная розничная цена товара без учета скидки. Принимается только в методах обновления цены", "format": "double" }, "updatedDeliveryCost": { "type": "number", "description": "Измененные прочие расходы товара Принимается только в методах обновления цены", "format": "double" }, "updatedPurchasePrice": { "type": "number", "description": "Измененная закупочная цена товара Принимается только в методах обновления цены", "format": "double" }, "purchasePrice": { "type": "number", "description": "Закупочная цена товара в руб.", "format": "double" }, "isPurchasePriceUpdated": { "type": "boolean", "description": "Признак, была ли изменена закупочная цена" }, "isDeliveryCostUpdated": { "type": "boolean", "description": "Признак, изменения прочих расходов на товар." }, "wholesalePrice": { "type": "number", "description": "Оптовая цена товара", "format": "double" }, "deliveryCost": { "type": "number", "description": "Дополнительные расходы на доставку товара в руб. Добавляются к закупочной цене", "format": "double" }, "ozonAverageExpenses": { "type": "number", "description": "Расходы по продаже товара на Ozon", "format": "double", "readOnly": true }, "wildberriesAverageExpenses": { "type": "number", "description": "Расходы по продаже товара на Wildberries", "format": "double", "readOnly": true }, "yandexMarketAverageExpenses": { "type": "number", "description": "Расходы по продаже товара на ЯМ", "format": "double", "readOnly": true }, "wildberriesPrice": { "type": "number", "description": "Текущая цена товара на Вайлдбериз со скидкой", "format": "double", "readOnly": true }, "wildberriesUpdatedPrice": { "type": "number", "description": "Новая цена товара на Вайлдбериз со скидкиой.Только для методов изменения цены", "format": "double" }, "wildberriesPriceWithoutDiscount": { "type": "number", "description": "Текущая цена товара на Вайлдбериз без скидки", "format": "double", "readOnly": true }, "wildberriesUpdatedPriceWithoutDiscount": { "type": "number", "description": "Новая цена товара на Вайлдбериз без скидки.Только для методов изменения цены", "format": "double" }, "wildberriesSale": { "type": "integer", "description": "Скидка товара на Вайлдбериз", "format": "int32", "readOnly": true }, "aliexpressPrice": { "type": "number", "description": "Текущая цена на Aliexpress со скидкой", "format": "double", "readOnly": true }, "aliexpressPriceWithoutDiscount": { "type": "number", "description": "Текущая цена на Aliexpress без скидки.", "format": "double" }, "aliexpressUpdatedPrice": { "type": "number", "description": "Новая цена со скидкой на Aliexpress. Только для методов обновления цены", "format": "double" }, "aliexpressUpdatedPriceWithoutDiscount": { "type": "number", "description": "Новая цена без скидки на Aliexpress. Только для методов обновления цены", "format": "double" }, "minPrice": { "type": "number", "description": "Минимальная цена товара. Ниже этой цены нельзя выставлять цену на товар.Используется для Ozon при участии товара в акциях", "format": "double" }, "ozonPrice": { "type": "number", "description": "Текущая цена товара на Озон со скидкой", "format": "double", "readOnly": true }, "ozonPromotionPrice": { "type": "number", "description": "Текущая акционная цена товара на Озон", "format": "double", "readOnly": true }, "ozonUpdatedPrice": { "type": "number", "description": "Новая цена товара на Озон со скидкой.Только для методов изменения цены", "format": "double" }, "ozonPriceWithoutDiscount": { "type": "number", "description": "Текущая цена товара на Озон без скидки.", "format": "double", "readOnly": true }, "ozonUpdatedPriceWithoutDiscount": { "type": "number", "description": "Новая цена Озон без скидки.Только для методов изменения цены", "format": "double" }, "ozonAcquiringPercent": { "type": "number", "description": "Максимальная комиссия за эквайринг OZON", "format": "double", "readOnly": true }, "leroyMerlinPrice": { "type": "number", "description": "Текущая цена товара на LeroyMerlin", "format": "double" }, "leroyMerlinUpdatedPrice": { "type": "number", "description": "Новая цена товара на LeroyMerlin.Только для методов изменения цены", "format": "double" }, "avitoPrice": { "type": "number", "description": "Текущая цена товара на Avito", "format": "double" }, "avitoUpdatedPrice": { "type": "number", "description": "Новая цена товара на Avito.Только для методов изменения цены", "format": "double" }, "ozonComisson": { "type": "number", "description": "Комиссия товара на Озон FBM", "format": "double", "readOnly": true }, "sberMegaMarketPrice": { "type": "number", "description": "Текущая цена на СберМегаМаркет со скидкой", "format": "double", "readOnly": true }, "sberMegaMarketUpdatedPrice": { "type": "number", "description": "Новая цена со скидкой на СберМегаМаркет. Только для методов изменения цены", "format": "double" }, "sberMegaMarketSupplyingQuantity": { "type": "integer", "description": "Поставляемое количество товара на СберМегаМаркет по FBM заказам", "format": "int32", "readOnly": true }, "yandexMarketPrice": { "type": "number", "description": "Текущая цена на Яндекс.Маркет со скидкой", "format": "double", "readOnly": true }, "yandexMarketPriceWithoutDiscount": { "type": "number", "description": "Текущая цена на Яндекс.Маркет без скидки", "format": "double", "readOnly": true }, "yandexMarketUpdatedPrice": { "type": "number", "description": "Новая цена со скидкой на Яндекс.Маркет. Только для методов изменения цены", "format": "double" }, "yandexMarketUpdatedPriceWithoutDiscount": { "type": "number", "description": "Новая цена без скидки на Яндекс.Маркет. Только для методов изменения цены", "format": "double" }, "yandexMarketSupplyingQuantity": { "type": "integer", "description": "Поставляемое количество товара на Яндекс.Маркет по FBM заказам", "format": "int32", "readOnly": true }, "oneCArticle": { "maxLength": 255, "type": "string", "description": "Уникальный артикул товара для 1c" }, "salesExpensesOnMpPercent": { "type": "number", "description": "Расходы по продажам на маркетплейсе, %", "format": "double" }, "taxeRate": { "type": "number", "description": "Установленый процент налога на товар, %", "format": "double" }, "desiredMarginalityPercent": { "type": "number", "description": "Желаемый % маржинальности", "format": "double" }, "desiredProfitRub": { "type": "number", "description": "Желаемая прибыль, руб.", "format": "double" }, "additionalCost": { "type": "number", "description": "Доп. расходы на товар без записи в Финансовую аналитику, руб.", "format": "double" }, "sberMegaMarketId": { "type": "integer", "description": "Карточка СберМегаМаркет", "format": "int64" }, "packWidth": { "type": "integer", "description": "Ширина в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы", "format": "int32" }, "packHeight": { "type": "integer", "description": "Высота в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы", "format": "int32" }, "packDepth": { "type": "integer", "description": "Длина/глубина в упаковке мм. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы", "format": "int32" }, "packWeight": { "type": "integer", "description": "Вес в упаковке гр. Имеет больший приоритет, чем значение в модели или категории, отдается на маркетплейсы", "format": "int32" }, "numOfPiecesInBox": { "type": "integer", "description": "Количество штук в коробе", "format": "int32" }, "lastWildberriesSaleDate": { "type": "string", "description": "Дата последней продажи на Wildberries", "format": "date-time" }, "lastWildberriesOrderDate": { "type": "string", "description": "Дата последнего заказа на Wildberries", "format": "date-time" }, "lastOzonSaleDate": { "type": "string", "description": "Дата последней продажи на OZON", "format": "date-time" }, "lastOzonOrderDate": { "type": "string", "description": "Дата последнего заказа на OZON", "format": "date-time" }, "totalOrdersCount": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке по МП OZON + WB", "format": "int32", "readOnly": true }, "totalFbsOrdersCount": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке по FBS за 2 недели", "format": "int32", "readOnly": true }, "wildberriesTotalOrdersCount": { "type": "integer", "description": "Кол-во заказанных товаров на данной карточке по МП WB", "format": "int32", "readOnly": true }, "ignoreFbsWarehouses": { "type": "string", "description": "Список идентификаторов складов маркетплейсов через запятую - на которые не отправлять остатки по FBS" }, "fbsWarehouses": { "type": "string", "description": "Список идентификаторов складов маркетплейсов через запятую - на которые не отправлять остатки по FBS" }, "minFbsStock": { "type": "integer", "description": "Минимальный остаток - если меньше, то ставим 0", "format": "int32" }, "maxFbsStock": { "type": "integer", "description": "Максимальный остаток - если больше, то ставим его", "format": "int32" }, "wildberriesSaleLogistic": { "type": "number", "description": "Логистика WB, руб.", "format": "double" }, "wildberriesReturnLogistic": { "type": "number", "description": "Обратная логистика WB, руб.", "format": "double" }, "wildberriesWarehouseRatio": { "type": "number", "description": "Коэффициент склада WB в %", "format": "double" }, "wildberriesComission": { "type": "number", "description": "Комиссия WB, %", "format": "double" }, "ozonSaleLogistic": { "type": "number", "description": "Логистика Ozon, руб.", "format": "double" }, "ozonReturnLogistic": { "type": "number", "description": "Обратная логистика Ozon, руб.", "format": "double" }, "ozonCommission": { "type": "number", "description": "Комиссия Ozon, %", "format": "double" }, "maxDeliveryToPickupPoint": { "type": "number", "description": "Максимальная стоимость доставки до места выдачи, руб.", "format": "double" }, "ozonPurchasePercent": { "type": "number", "description": "Процент выкупа Ozon, %", "format": "double" }, "wildberriesPurchasePercent": { "type": "number", "description": "Процент выкупа WB, %", "format": "double" }, "minMarginality": { "type": "number", "description": "Настройки репрайсера Min % маржинальности", "format": "double" }, "maxMarginality": { "type": "number", "description": "Настройки репрайсера Max % маржинальности", "format": "double" }, "minProfit": { "type": "number", "description": "Настройки репрайсера Min прибыль, руб.", "format": "double" }, "maxProfit": { "type": "number", "description": "Настройки репрайсера Max прибыль, руб.", "format": "double" }, "minPriceWithDiscount": { "type": "number", "description": "Настройки репрайсера Min цена со скидкой, руб.", "format": "double" }, "maxPriceWithDiscount": { "type": "number", "description": "Настройки репрайсера Max цена со скидкой, руб.", "format": "double" }, "oldWildberriesPriceWithDiscount": { "type": "number", "description": "При установки через репрайсер скидку, заполняется, после удаление скидки, возвращает как основная цена и значение затирается", "format": "double" }, "oldWildberriesSale": { "type": "integer", "description": "Скидка товара на Вайлдбериз до установки новой по репрайсеру, при возврате нужно проставлять null", "format": "int32" }, "wildberriesPromoProfit": { "type": "number", "description": "Расчетный профит по акциям WB нужен для определения какая акция выгодная", "format": "double" }, "wildberriesMarginality": { "type": "number", "description": "Расчетная маржинальность по WB", "format": "double" }, "wildberriesPromoId": { "type": "integer", "description": "Идентификатор акции на ВБ", "format": "int64" }, "oldWildberriesPromoSalePercent": { "type": "number", "description": "Расчетная маржинальность по WB", "format": "double" }, "oldWildberriesPromoPriceWithDiscount": { "type": "number", "description": "Расчетная маржинальность по WB", "format": "double" }, "endWildberriesPriceWithSppConfig": { "type": "number", "description": "Цена для пользователя конечная с СПП. ", "format": "double" }, "ozonFbsCommission": { "type": "number", "description": "Комиссия ОЗОН ФБС ", "format": "double" }, "ozonFboCommission": { "type": "number", "description": "Комиссия ОЗОН ФБО ", "format": "double" }, "wbTotalSalesCount": { "type": "integer", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по ВБ", "format": "int64" }, "ozonTotalSalesCount": { "type": "integer", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по OZON", "format": "int64" }, "sberTotalSalesCount": { "type": "integer", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по SBER", "format": "int64" }, "yandexTotalSalesCount": { "type": "integer", "description": "Общее кол-во продажи - возвраты, начиная с подсчета процента выкупа по YANDEX", "format": "int64" }, "fboStockCount": { "type": "integer", "description": "Остаток ФБО по выбранным складам/регионам", "format": "int64" }, "fbsStockCount": { "type": "integer", "description": "Остаток ФБC для планирования поставок)", "format": "int64" }, "fboSupplyQuantity": { "type": "integer", "description": "Количество поставляемого товара по выбранным складам/регионам", "format": "int64" }, "fboSales": { "type": "integer", "description": "Кол-во продаж FBO по складам/регионам для планирования поставок", "format": "int64" }, "fbsSales": { "type": "integer", "description": "Кол-во продаж FBS по складам/регионам для планирования поставок", "format": "int64" }, "fboOrders": { "type": "integer", "description": "Кол-во заказов FBO по складам/регионам для планирования поставок", "format": "int64" }, "fbsOrders": { "type": "integer", "description": "Кол-во заказов FBS по складам/регионам для планирования поставок", "format": "int64" }, "recommendPlan": { "type": "number", "description": "Кол-во товара для добавления к заказу", "format": "double" }, "skipDaysCount": { "type": "integer", "description": "Кол-во пропущенных дней в учёте планирования поставок", "format": "int32" }, "organizationShortName": { "type": "string" }, "contractorName": { "type": "string" }, "supplyPlanBarcode": { "type": "string" }, "planCorrectionFactor": { "type": "number", "description": "Коэффициент коррекции для планирования поставок. На это значение умножается рассчитанное количество товара для поставки", "format": "double" }, "orderBefore": { "type": "integer", "description": "До какого времени должен быть сделан заказ от 1 до 24", "format": "int32" }, "daysBeforeSupply": { "type": "integer", "description": "Кол-во дней до поставки. Через сколько дней с момента заказа ориентировочно будет поставка товаров", "format": "int32" }, "supplyPlanDays": { "type": "integer", "description": "На сколько дней планировать остаток", "format": "int32" }, "warehouseIdForSupplyReport": { "type": "integer", "description": "Id склада на который нужно поставить рассчитанные товары. Используется только в планировании поставок", "format": "int64", "readOnly": true }, "warehouseNameForSupplyReport": { "type": "string", "description": "Название склада на который нужно поставить рассчитанные товары. Используется только в планировании поставок", "readOnly": true }, "manager": { "type": "string", "description": "Поле менеджера" }, "cellId": { "type": "integer", "format": "int32" }, "percentForParticipationPromoOrAdvertising": { "type": "integer", "description": "Закладываемый % для участия в акциях или рекламе", "format": "int32" }, "selsupLink": { "type": "string" }, "tempId": { "type": "integer", "description": "Временный id используется для быстрого импорта", "format": "int64" }, "category": { "$ref": "#/components/schemas/Category" }, "walmartSku": { "type": "string", "description": "SKU товара на Walmart" }, "walmartId": { "type": "string", "description": "Id товара на Walmart (WPID)" }, "findirTips": { "type": "object", "additionalProperties": { "type": "string", "description": "Советы задачника (тип задачи - текст совета)" }, "description": "Советы задачника (тип задачи - текст совета)" }, "woocomSku": { "type": "string", "description": "SKU товара на WooCommerce" }, "woocomId": { "type": "integer", "description": "Id товара на WooCommerce", "format": "int64" }, "commissions": { "type": "string", "description": "JSON с комиссиями из разных маркетплейсов" }, "calculatedInstockQuantity": { "type": "integer", "format": "int32", "writeOnly": true }, "anyArticle": { "type": "string" }, "anyLink": { "type": "string" }, "site": { "type": "string" }, "emptyBarcodes": { "type": "boolean" } }, "description": "Товар - уникальный с точки зрения подтребительских свойств товар.", "readOnly": true }, "ProductBarcode": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "barcode": { "type": "string" }, "organizationId": { "type": "integer", "description": "Организация, если client.barcodeUniqForOrg = false, то проставляется 0. Поле включено в уникальный ключ", "format": "int64" }, "clientId": { "type": "integer", "format": "int64" }, "productId": { "type": "integer", "format": "int64" }, "useInWildberries": { "type": "boolean", "description": "Применим ли данный штрих-код для Вайлдбериз" }, "useInOzon": { "type": "boolean", "description": "Применим ли данный штрих-код для Озон" }, "useInYandexMarket": { "type": "boolean", "description": "Применим ли данный штрих-код для Yandex.Market" }, "useInAliexpress": { "type": "boolean", "description": "Применим ли данный штрих-код для Aliexpress" }, "useInSberMegamarket": { "type": "boolean", "description": "Применим ли данный штрих-код для Sber.MegaMarket" }, "format": { "type": "string" } }, "description": "Штрих-код товара. У товара может быть несколько штрих-кодов, некоторые из них могут получаться и использовать только для определенных маркетплейсов" }, "ProductCode": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор кода маркировки", "format": "int64" }, "code": { "type": "string", "description": "Длинный код маркировки товара, содержащий штрих-код, серию и другую информацию" }, "productId": { "type": "integer", "description": "Карточка товара на которую был выпущен код маркировки", "format": "int64" }, "product": { "$ref": "#/components/schemas/Product" }, "suzProductId": { "type": "string", "description": "GTIN на товар из заказа СУЗ в рамках которого был выпущен данный код маркировки" }, "createdDate": { "type": "string", "format": "date-time" }, "orderId": { "type": "integer", "description": "Идентификатор заказа в котором получался данный код маркировки", "format": "int64" }, "supplyOrderId": { "type": "integer", "description": "Идентификатор заказа в котором отгружен данный код маркировки", "format": "int64" }, "createdUser": { "type": "string" }, "crptApiError": { "type": "string", "description": "Текст ошибки при работе с API Честного знака" }, "status": { "type": "string", "description": "Статус кода маркировки", "enum": [ "CREATED", "PRINTED", "CIRCULATION", "TURNOVER", "TRANSFERRED", "RETIRED", "WRITTEN_OFF", "WITHDRAWN", "INVALID", "EMITTED" ] }, "clientId": { "type": "integer", "format": "int64" }, "hash": { "type": "integer", "description": "Хэш от уникальной части кода маркировки для быстрого поиска кода", "format": "int32" }, "organizationId": { "type": "integer", "format": "int64" }, "documentId": { "type": "integer", "format": "int32" }, "owner": { "type": "string" }, "primaryDocumentType": { "type": "string", "enum": [ "RECEIPT", "CORRECTION_RECEIPT", "CONSIGNMENT_NOTE", "UTD", "CUSTOMS_DECLARATION", "DESTRUCTION_ACT", "OTHER", "RETAIL" ] }, "primaryDocumentNumber": { "type": "string" }, "primaryDocumentDate": { "type": "string" }, "primaryDocumentCustomName": { "type": "string" }, "emissionType": { "type": "string", "enum": [ "LOCAL", "FOREIGN", "REMAINS", "CROSSBORDER", "REMARK", "COMMISSION", "AGGREGATION" ] }, "packageType": { "type": "string", "enum": [ "UNIT", "BUNDLE", "GROUP", "SET", "ATK" ] }, "salePrice": { "type": "number", "format": "double" }, "orderService": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "orderNumber": { "type": "string" }, "orderDate": { "type": "string", "format": "date-time" }, "categoryClass": { "type": "string", "description": "Группы категорий Честного знака", "enum": [ "SHOES", "LIGHT", "DRUGS", "CAMERA", "TYRES", "MILK", "WATER", "TOBACCO", "FURS", "BEER", "BICYCLES", "PERFUMES", "ELECTRONIC", "OTHER", "NONE", "FOOD", "WHEELCHAIRS", "OTP", "NCP", "BIO", "ANTISEPTIC", "NABEER", "SOFTDRINKS", "PETFOOD", "SEAFOOD", "MEAT", "TOYS", "TITAN", "RADIO", "OPTIC_FIBER", "VEGETABLE_OIL", "CONSERVE", "VETPHARMA", "CHEMISTRY", "AUTOFLUIDS", "GROCERY", "BOOKS", "CONSTRUCTION", "FIRE", "HEATER", "CABLERAW", "POLYMER", "SWEETS" ] }, "applyStatus": { "type": "string", "enum": [ "NONE", "NOT_REQUIRED", "SCANNED", "SUCCESS" ] }, "boxId": { "type": "integer", "format": "int64" }, "box": { "$ref": "#/components/schemas/Box" }, "applyStatusId": { "$ref": "#/components/schemas/ProductCode" } }, "description": "Код маркировки товара в Честном Знаке" }, "ProductImage": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор изображения. Проставляется автоматически.", "format": "int64", "readOnly": true }, "url": { "type": "string", "description": "Ссылка на файл изображения", "readOnly": true }, "position": { "type": "integer", "description": "Позиция изображения. Используется для выдачи по порядку на маркетплейсы и для отображения в интерфейсе", "format": "int32" }, "productViewId": { "type": "integer", "description": "Связь с цветом", "format": "int64", "readOnly": true }, "wildberriesImgUUID": { "type": "string", "description": "Связь с идентификатором изображения WB. Сейчас не используется", "readOnly": true }, "services": { "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, "clientId": { "type": "integer", "format": "int64" } }, "description": "Изображение товара", "readOnly": true }, "ProductModel": { "required": [ "article", "brandId", "categoryId", "manufacturerId", "organizationId", "views" ], "type": "object", "properties": { "article": { "type": "string", "description": "Уникальный артикул модели" }, "organizationId": { "type": "integer", "description": "Организация для товара", "format": "int64" }, "category": { "$ref": "#/components/schemas/Category" }, "categoryId": { "type": "integer", "description": "Идентификатор категории товара", "format": "int32", "writeOnly": true }, "manufacturer": { "$ref": "#/components/schemas/Manufacturer" }, "manufacturerId": { "type": "integer", "description": "Идентификатор производителя товара", "format": "int32", "writeOnly": true }, "brand": { "$ref": "#/components/schemas/Brand" }, "brandId": { "type": "integer", "description": "Идентификатор бренда для товара", "format": "int32", "writeOnly": true }, "id": { "type": "integer", "description": "Идентификатор модели. Проставляется автоматически", "format": "int64" }, "name": { "maxLength": 200, "type": "string", "description": "Название модели внутренее" }, "promoName": { "maxLength": 200, "type": "string", "description": "Название модели для продвижения товара. Используется в качестве названия на Wildberries" }, "title": { "maxLength": 255, "type": "string", "description": "Название модели для печати и автоматического формирования названий товаров" }, "wildberriesImtId": { "type": "integer", "description": "Идентификатор карточки товара Wildberries", "format": "int64", "readOnly": true }, "description": { "maxLength": 60000, "type": "string", "description": "Описание товара" }, "gender": { "type": "string", "description": "Пол", "enum": [ "MALE", "BOYS", "FEMALE", "GIRLS", "UNISEX", "KIDS", "CHILDREN" ] }, "packWidth": { "type": "integer", "description": "Ширина упаковки товара в мм", "format": "int32" }, "packHeight": { "type": "integer", "description": "Высота упаковки товара в мм", "format": "int32" }, "packDepth": { "type": "integer", "description": "Глубина упаковки товара в мм", "format": "int32" }, "packWeight": { "type": "integer", "description": "Вес упаковки товара в гр", "format": "int32" }, "season": { "type": "string", "description": "Сезон товара. Используется для фильтрации товара в заказах поставщикам", "enum": [ "ANY", "WINTER", "SUMMER", "SPRING", "AUTUMN", "SPRING_AUTUMN" ] }, "materials": { "type": "string", "description": "Состав товара, нужен для одежды и обуви" }, "laundry": { "type": "string", "description": "Правила ухода за вещами для одежды и обуви. Через запятую необходимо перечислить возможные значения" }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления модели", "readOnly": true }, "vat": { "type": "string", "description": "НДС", "enum": [ "NONE", "COMMON", "HALF", "VAT_0", "VAT_5", "VAT_7", "VAT_12", "VAT_18" ] }, "createdDate": { "type": "string", "description": "Дата создания модели", "format": "date-time", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, создавший модель", "readOnly": true }, "countryId": { "type": "integer", "description": "Страна производства товара. По умолчанию проставляется из производителя", "format": "int32" }, "countryName": { "type": "string", "description": "Название страны производства", "readOnly": true }, "keywords": { "type": "string", "description": "Ключевые слова для поиска" }, "favourite": { "type": "boolean", "description": "Пометка товара избранным для фильтрации" }, "params": { "type": "string", "description": "JSON со списком значений параметров для модели" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "sourceModelId": { "type": "integer", "description": "Модель из которой была создана данная модель как дубликат карточки", "format": "int64" }, "additionalInfo": { "type": "string", "description": "Дополнительная информация о товаре" }, "createIndex": { "type": "integer", "description": "Индекс создания карточки - для ограничения бесплатного тарифа", "format": "int32", "readOnly": true }, "bulk": { "type": "boolean", "description": "Признак сборки товара по штрих-кодам, безуникальных кодов" }, "oneCId": { "type": "string", "description": "Идентификатор товара в 1С" }, "site": { "type": "string", "description": "Адрес сайта" }, "shelfLife": { "type": "integer", "description": "Срок годности в единице измерения", "format": "int32" }, "shelfLifeUnit": { "type": "string", "description": "Срок годности в единице измерения", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "shelfLifeComment": { "type": "string", "description": "Комментарий срока годности" }, "lifeTime": { "type": "integer", "description": "Срок службы в единице измерения", "format": "int32" }, "lifeTimeUnit": { "type": "string", "description": "Срок службы в единице измерения", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "lifeTimeComment": { "type": "string", "description": "Комментарий срока службы" }, "modelGuarantee": { "type": "integer", "description": "Гарантийный срок в единице измерения", "format": "int32" }, "modelGuaranteeUnit": { "type": "string", "description": "Единица гарантийного срока", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ] }, "modelGuaranteeComment": { "type": "string", "description": "Комментарий гарантийного срока" }, "hasChanges": { "type": "boolean", "description": "Признак изменения информации о модели и необходимости его обновить", "writeOnly": true }, "price": { "type": "number", "description": "Розничная цена товара. Прибавляется к закупочной цене. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "deliveryCost": { "type": "number", "description": "Стоимость доставки товара. Прибавляется к закупочной цене. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "wholesalePrice": { "type": "number", "description": "Потовая цена товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "purchasePrice": { "type": "number", "description": "Закупочная цена товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "purchaseCurrency": { "type": "string", "description": "Валюта закупочной цены товара. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "writeOnly": true, "enum": [ "RUB", "USD", "EUR", "AUD", "AZN", "GBP", "AMD", "BYN", "BGN", "BRL", "HUF", "VND", "HKD", "GEL", "DKK", "AED", "EGP", "INR", "IDR", "KZT", "CAD", "QAR", "KGS", "CNY", "MDL", "NZD", "NOK", "PLN", "RON", "XDR", "SGD", "TJS", "THB", "TRY", "TMT", "UZS", "UAH", "CZK", "SEK", "CHF", "RSD", "ZAR", "KRW", "JPY" ] }, "deliveryCostInCurrency": { "type": "number", "description": "Прочие расходы в валюте. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "purchasePriceInCurrency": { "type": "number", "description": "Закупочная цена товара в валюье. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "priceWithoutDiscount": { "type": "number", "description": "Цена без скидки. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "double", "writeOnly": true }, "views": { "type": "array", "description": "Список цветов модели", "writeOnly": true, "items": { "$ref": "#/components/schemas/ProductView" } }, "services": { "type": "array", "description": "Список сервисов в которых создать карточки товара", "writeOnly": true, "items": { "type": "string", "description": "Сервис", "writeOnly": true, "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, "contractors": { "type": "array", "description": "Список поставщиков товара", "writeOnly": true, "items": { "$ref": "#/components/schemas/Contractor" } }, "sourceIncomeItemId": { "type": "integer", "description": "Товар из заказа поставщика, из которого была создана модель. Используется только при создании модели из заказа поставщика, в самой моделе не хранится", "format": "int64", "writeOnly": true }, "costPrice": { "type": "number", "description": "Себестоимость считается автоматически по формуле: закупочная цена + дополнительные расходы на товар, поэтому Вам нужно заполнить эти параметры или просто закупочную цену", "format": "double", "writeOnly": true }, "aliexpressGroupId": { "type": "string", "description": "Идентификатор группы по которому можно посмотерть статус создания/обновления", "readOnly": true }, "aliexpressId": { "type": "string", "description": "Карточка aliexpress", "readOnly": true }, "simpleImport": { "type": "boolean", "description": "Показатель что карточка создана с помощью быстрого импорта" }, "selectedProducts": { "uniqueItems": true, "type": "array", "description": "Используется при обновлении модели для выборочной отправки на МП", "items": { "type": "integer", "description": "Используется при обновлении модели для выборочной отправки на МП", "format": "int64" } } }, "description": "Модель товара - объединяет товары, различающиеся цветом и некоторыми характеристиками (например размер в одежде)", "readOnly": true }, "ProductStock": { "type": "object", "properties": { "stock": { "type": "integer", "format": "int32" }, "cell": { "$ref": "#/components/schemas/Cell" }, "reserved": { "type": "integer", "format": "int32" }, "calculatedStock": { "type": "integer", "format": "int32" }, "expiredDate": { "type": "string", "format": "date-time" } }, "description": "Остатки товара на складах - возвращается только в методах, wms/fetchStock", "readOnly": true }, "ProductVideo": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор Видео. Проставляется автоматически.", "format": "int64", "readOnly": true }, "url": { "type": "string", "description": "Ссылка на файл", "readOnly": true }, "position": { "type": "integer", "description": "Позиция видео. Используется для выдачи по порядку на маркетплейсы и для отображения в интерфейсе", "format": "int32" }, "productViewId": { "type": "integer", "description": "Связь с цветом", "format": "int64", "readOnly": true }, "productId": { "type": "integer", "description": "Связь с размером", "format": "int64", "readOnly": true }, "videoUrls": { "type": "string", "description": "Ссылка на видео", "readOnly": true }, "services": { "uniqueItems": true, "type": "array", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } } }, "description": "Видео товара" }, "ProductView": { "required": [ "sizes" ], "type": "object", "properties": { "color": { "type": "string", "description": "Артикул цвета" }, "wbArticle": { "type": "string", "description": "Артикул карточки Wildberries" }, "id": { "type": "integer", "description": "Идентификатор цвета. Проставляется автоматически", "format": "int64" }, "images": { "type": "array", "description": "Список изображений товара", "items": { "$ref": "#/components/schemas/ProductImage" } }, "videos": { "type": "array", "description": "Список видео товара", "items": { "$ref": "#/components/schemas/ProductVideo" } }, "productModelId": { "type": "integer", "description": "Идентификатор модели", "format": "int64", "readOnly": true }, "model": { "$ref": "#/components/schemas/ProductModel" }, "actual": { "type": "boolean", "description": "Актуальность цвета - нужно ли его показывать в заказах поставщикам" }, "mainImage": { "$ref": "#/components/schemas/ProductImage" }, "mainImageId": { "type": "integer", "format": "int64" }, "mainImageUrl": { "type": "string", "description": "Ссылка на основное изображение на маркетплейсе", "readOnly": true }, "imageUrls": { "type": "string", "description": "Ссылка на изображения", "readOnly": true }, "image360Urls": { "type": "string", "description": "Ссылка на изображения 360", "readOnly": true }, "wildberriesId": { "type": "integer", "description": "Числовой идентификатор номенклатуры Wildberries, nmId", "format": "int64" }, "createdDate": { "type": "string", "description": "Дата создания цвета", "format": "date-time", "readOnly": true }, "createdUser": { "type": "string", "description": "Пользователь, создавший цвет", "readOnly": true }, "versionId": { "type": "integer", "description": "Поле нужно передавать при изменении,для предотвращения одновременной перезаписи", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64", "readOnly": true }, "deleted": { "type": "boolean", "description": "Признак удаления цвета", "readOnly": true }, "keywords": { "type": "string", "description": "Ключевые слова - сейчас не используется, перенесены в модель" }, "wildberriesRating": { "type": "number", "description": "Рейтинг карточки на Вайлдбериз", "format": "double", "readOnly": true }, "wildberriesFeedbacks": { "type": "integer", "description": "Количество отзывов на карточке на Вайлдбериз", "format": "int32", "readOnly": true }, "wildberriesCardDoesNotOpen": { "type": "boolean", "description": "Признак, что карточка не открывается на Вайлдбериз", "readOnly": true }, "wildberriesHasPhoto": { "type": "boolean", "description": "Признак наличия фото на Wildberries", "readOnly": true }, "organizationId": { "type": "integer", "description": "Организация карточки", "format": "int64", "readOnly": true }, "params": { "type": "string", "description": "JSON со значениями параметров цвета" }, "values": { "type": "array", "description": "Значения параметров карточки. Отдаются при запросе модели, если передать params=true", "items": { "$ref": "#/components/schemas/ParamValue" } }, "viewSourceId": { "type": "integer", "description": "Оригинал цвета по SKU", "format": "int64", "readOnly": true }, "sizes": { "type": "array", "description": "Список размеров для цвета", "writeOnly": true, "items": { "$ref": "#/components/schemas/Product" } }, "hasChanges": { "type": "boolean", "description": "Признак изменения информации о цвете и необходимости его обновить", "writeOnly": true }, "viewWbArticle": { "$ref": "#/components/schemas/ProductView" }, "viewVersionId": { "type": "integer", "format": "int64", "writeOnly": true } }, "description": "Цвет товара", "readOnly": true }, "Region": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "countryId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "regionId": { "$ref": "#/components/schemas/Region" } } }, "Sku": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "product": { "$ref": "#/components/schemas/Product" }, "productId": { "type": "integer", "format": "int64" } }, "description": "Stock Keeping Unit - Единица хранения товара на складе. Может быть связана с несколькими карточками товаров Product.id. При первом создании товара SKU создается автоматически, далее можно привязать несколько товаров - имеющих разный бренд/организацию на маркетплейсах к одному SKU.", "readOnly": true }, "Supply": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "name": { "type": "string", "description": "Название поставки" }, "type": { "type": "string", "description": "Тип поставки - со своего склада или на склад маркетплейса", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "boxType": { "type": "string", "description": "Тип короба поставки - у разных маркетплейсов разные требования к отгрузке некоторых товаров", "enum": [ "DEFAULT", "MONO", "MONO_PALLET", "SUPERSEIF", "QR", "FBS" ] }, "totalQuantity": { "type": "integer", "format": "int64" }, "status": { "type": "string", "description": "Статус поставки", "enum": [ "CREATED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdUser": { "type": "string" }, "warehouseId": { "type": "integer", "description": "Склад на который поставляется товар", "format": "int64" }, "deliveryDate": { "type": "string", "description": "Дата отгрузки товара на маркетплейс", "format": "date-time" }, "clientId": { "type": "integer", "format": "int64" }, "organizationId": { "type": "integer", "description": "Организация для которой создана поставка", "format": "int64" }, "deleted": { "type": "boolean", "description": "Поставка удаленная" }, "externalId": { "type": "string", "description": "Внешний номер поставки на маркетплейсе" }, "deliveryMethod": { "type": "integer", "description": "Метод доставки (в основном для озон)", "format": "int64" }, "deliveryMethodName": { "type": "integer", "description": "Название метода доставки (в основном для озон)", "format": "int64" }, "serviceWarehouseId": { "type": "string", "description": "Склад на который поставляется товар" }, "versionId": { "type": "integer", "description": "Поле используется для предотвращения паралельного изменения поставки и затирания данных", "format": "int64" }, "labelPath": { "type": "string", "description": "Путь к QR поставки", "readOnly": true }, "labelUrl": { "type": "string", "description": "Ссылка на QR поставки", "readOnly": true }, "orderId": { "type": "integer", "description": "Заказ из которого создается поставка", "format": "int64" }, "orders": { "type": "array", "description": "Список заказов этой поставки", "items": { "$ref": "#/components/schemas/Order" } }, "deliveries": { "type": "array", "description": "Список машин и данных водителей, которые доставляют поставку", "items": { "$ref": "#/components/schemas/SupplyDelivery" } }, "moySkladDemandId": { "type": "string", "description": "ID отгрузки в Мой склад для объединенных поставок" }, "supplyId": { "type": "integer", "format": "int64", "writeOnly": true } }, "description": "Поставка товаров на склад маркетплейса. Состоит из нескольких заказов, которые отгружаются в определенную дату", "readOnly": true }, "SupplyDelivery": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "supplyId": { "type": "integer", "format": "int64" }, "driver": { "$ref": "#/components/schemas/Driver" }, "driverId": { "type": "integer", "format": "int64" }, "placeCount": { "type": "integer", "format": "int32" }, "placeUnit": { "type": "string", "enum": [ "BOX", "PALLET" ] } }, "description": "Список машин и данных водителей, которые доставляют поставку" }, "Tnved": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор кода ТНВЭД без нулей в начале", "format": "int64" }, "name": { "type": "string", "description": "Название кода ТНВЭД" }, "deleted": { "type": "boolean" }, "type": { "type": "string", "description": "Уровень кода ТНВЭД", "enum": [ "SECTION", "GROUP", "PRODUCT", "MAIN" ] }, "categoryClass": { "type": "string", "description": "Группы категорий Честного знака", "enum": [ "SHOES", "LIGHT", "DRUGS", "CAMERA", "TYRES", "MILK", "WATER", "TOBACCO", "FURS", "BEER", "BICYCLES", "PERFUMES", "ELECTRONIC", "OTHER", "NONE", "FOOD", "WHEELCHAIRS", "OTP", "NCP", "BIO", "ANTISEPTIC", "NABEER", "SOFTDRINKS", "PETFOOD", "SEAFOOD", "MEAT", "TOYS", "TITAN", "RADIO", "OPTIC_FIBER", "VEGETABLE_OIL", "CONSERVE", "VETPHARMA", "CHEMISTRY", "AUTOFLUIDS", "GROCERY", "BOOKS", "CONSTRUCTION", "FIRE", "HEATER", "CABLERAW", "POLYMER", "SWEETS" ] }, "parentId": { "type": "integer", "description": "Родительский ТНВЭД", "format": "int64" }, "keywords": { "type": "string", "description": "Ключевые слова для кода ТНВЭД" }, "description": { "type": "string", "description": "Описание кода ТНВЭД" }, "paramsTnvedId": { "type": "integer", "description": "Определяет категорию (или ТНВЭД) национального каталога с помощью которого брать параметры. Несколько ТНВЭД могут ссылаться на одну и ту же категорию национального каталога", "format": "int64" }, "isInParam": { "type": "boolean", "description": "Означает что ТНВЭД есть в параметре Вайлдбериз - их нужно выбирать в приоритете" }, "certification": { "type": "string", "description": "Необходимость сертификации товаров с этим ТНВЭД" }, "code": { "type": "string" }, "parentCode": { "type": "string" } }, "description": "Код ТНВЭД" }, "Unit": { "type": "object", "properties": { "name": { "type": "string", "description": "Название единицы измерения" }, "measureId": { "type": "integer", "description": "Мера параметра", "format": "int32" }, "id": { "type": "integer", "format": "int32" } }, "description": "Единица измерения" }, "WildberriesType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Название" }, "published": { "type": "boolean", "description": "Опубликованность предмета Вайлдбериз" }, "hasSize": { "type": "boolean", "description": "Атрибут, указывающий наличие размера" }, "monoBoxMinQuantity": { "type": "integer", "format": "int32" }, "monoType": { "type": "string", "enum": [ "ALWAYS", "NEVER", "MONO_IF_MIN_PRICE" ] }, "monoMinPrice": { "type": "integer", "format": "int32" }, "hasParent": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "wildberriesId": { "type": "integer", "description": "Идентификатор предмета на Вайлдбериз", "format": "int64" }, "lastSyncDate": { "type": "string", "description": "Дата последней синхронизации предмета с Вайлдбериз", "format": "date-time" }, "notChangedDays": { "type": "integer", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются", "format": "int32" }, "commission": { "type": "number", "description": "Комиссия для товаров данного предмета в Вайлдбериз по FBM", "format": "double" }, "fbsCommission": { "type": "number", "description": "Комиссия для товаров данного предмета в Вайлдбериз по FBS", "format": "double" }, "fbwCommission": { "type": "number", "description": "Комиссия по тарифу FBW", "format": "double" }, "dbsCommission": { "type": "number", "description": "Комиссия по тарифу DBS", "format": "double" }, "edbsCommission": { "type": "number", "description": "Комиссия по тарифу EDBS", "format": "double" }, "cAndCCommission": { "type": "number", "description": "Комиссия по тарифу C&C", "format": "double" }, "bookingCommission": { "type": "number", "description": "Комиссия за бронирование", "format": "double" }, "logisticPrice": { "type": "integer", "description": "Стоимость доставки товара к клиенту на Вайлдбериз", "format": "int32" }, "storagePrice": { "type": "number", "description": "Стоимость хранения товара на складе Вайлдбериз за штуку в день", "format": "double" }, "acceptancePrice": { "type": "number", "description": "Стоимость приемки товара на складе Вайлдбериз за штуку", "format": "double" }, "needDimensions": { "type": "boolean", "description": "Атрибут обязательности габаритов товара, тк стоимость хранения рассчитывается на основе габаритов" }, "candCCommission": { "type": "number", "format": "double" } }, "description": "Предмет Вайлдбериз" }, "WmsItem": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID остатка", "format": "int64" }, "status": { "type": "string", "description": "Статус единицы хранения товара на складе", "enum": [ "CREATED", "IN_STOCK", "LOST", "RESERVED", "SUPPLIED", "REMOVED", "SALE", "REFUND", "INCOME_MARKETPLACE" ] }, "sku": { "$ref": "#/components/schemas/Sku" }, "skuId": { "type": "integer", "description": "Связь с SKU и карточкой товара", "format": "int64" }, "salePrice": { "type": "number", "description": "Сумма продаж товара", "format": "double" }, "purchasePrice": { "type": "number", "description": "Закупочная цена товара, берется из приемки на склад", "format": "double" }, "otherExpenses": { "type": "number", "description": "Дополнительные расходы на доставку товара. Добавляются к закупочной цене", "format": "double" }, "number": { "type": "integer", "description": "Человекочитабельный номер товара на складе - используется для быстрого поиска товара в ячейке. Уникальный в рамках клиента", "format": "int32" }, "barcode": { "type": "string", "description": "Уникальный в рамках клиента штрих-код единицы хранения товара" }, "incomeOrderId": { "type": "integer", "description": "Заказ по которому было поступление этого товара", "format": "int64" }, "productId": { "type": "integer", "description": "Идентификатор товара - этикетка которого напечатана. Не использовать как связь с товаром, тк связь идет через skuId у Product", "format": "int64" }, "incomeOrderProductId": { "type": "integer", "description": "Товар из заказа по которому было поступление этого товара", "format": "int64" }, "supplyOrderProductId": { "type": "integer", "description": "Товар в заказе, по которому товар убыл со стока", "format": "int64" }, "productCode": { "$ref": "#/components/schemas/ProductCode" }, "createdDate": { "type": "string", "description": "Дата создания остатка", "format": "date-time" }, "updatedDate": { "type": "string", "description": "Дата изменения остатка", "format": "date-time" }, "expiredDate": { "type": "string", "description": "Срок годности товара", "format": "date-time" }, "putUserId": { "type": "integer", "description": "Идентификатор пользователя, который разместил на складе этот товар", "format": "int32" }, "putDate": { "type": "string", "description": "Дата, когда товар был размещен на складе", "format": "date-time" }, "takeUserId": { "type": "integer", "description": "Идентификатор пользователя, который собрал товар для заказа или отметил его потерянным", "format": "int32" }, "takeDate": { "type": "string", "description": "Дата, когда товар собрали или отметили потерянным", "format": "date-time" }, "cell": { "$ref": "#/components/schemas/Cell" }, "cellId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int64" }, "lastInventoryId": { "type": "integer", "description": "Идентификатор последней инвентаризации", "format": "int32" }, "modifyDate": { "type": "string", "format": "date-time" }, "gtd": { "type": "string" }, "rnpt": { "type": "string" }, "quantity": { "type": "integer", "description": "Общее количетво товара при использовании количественного метода хранения", "format": "int32" }, "calculatedQuantity": { "type": "integer", "description": "Подсчитанные остатки товаров для комплектов, на основе других товаров", "format": "int32" }, "collectQuantity": { "type": "integer", "format": "int32" }, "isSet": { "type": "boolean" }, "supplied": { "type": "integer", "description": "Количетво отгруженного товара при использовании количественного метода хранения", "format": "int32" }, "reserved": { "type": "integer", "description": "Количетво зарезервированного товара при использовании количественного метода хранения", "format": "int32" }, "markConfirmed": { "type": "boolean", "description": "Признак, что маркировка передана на маркетплейс успешно" }, "availableQuantity": { "type": "integer", "format": "int32" } }, "description": "Остаток товара на складе для ведения партионного учета или учета каждой единицы товара. Поддерживаются две схемы хранения - когда каждой штуке даже одного и того же товара соответствует Уникальный код. Вторая схема хранения остатков - когда в остатке прописывается количество товара в одной ячейке хранения или с разными датами приемки на склад. По остатку можно посмотреть всю историю движения товара. В остатке хранится закупочная цена и дополнительные расходы на товар, серийные номера, дата хранения и связь с маркировкой Честный знак (для схемы работы с Уникальными кодами)." }, "YandexMarkerBuyerInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "id покупателя" }, "firstName": { "type": "string", "description": "Имя покупателя" }, "lastName": { "type": "string", "description": "Фамилия покупателя" }, "email": { "type": "string", "description": "Почта покупателя" }, "phone": { "type": "string", "description": "Тел покупателя" } }, "description": "Информация о покупателе Yandex.Market. При получении информации о заказе по id" }, "YandexMarketCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Название категории" }, "published": { "type": "boolean" }, "parentId": { "type": "integer", "format": "int64" }, "isLeaf": { "type": "boolean", "description": "Признак листовой категории, в которой могут находиться товары" }, "lastSyncDate": { "type": "string", "description": "Дата последней синхронизации категории с Озон", "format": "date-time" }, "notChangedDays": { "type": "integer", "description": "Количество дней, в течение которых данные категории не менялась. Используется для того, чтобы сократить обновление категорий, которые не меняются", "format": "int32" } }, "description": "Категория Яндекс.Маркета" }, "SupplyCheck": { "type": "object", "properties": { "common": { "type": "integer", "format": "int32" }, "collected": { "type": "integer", "format": "int32" }, "notCollected": { "type": "integer", "format": "int32" }, "linking": { "type": "integer", "format": "int32" }, "shouldRemove": { "type": "integer", "format": "int32" } } }, "CollectOrderDTO": { "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductDTO" } } } }, "ProductDTO": { "type": "object", "properties": { "orderProductId": { "type": "integer", "format": "int64" }, "gtd": { "type": "array", "items": { "type": "string" } } } }, "OrderDelivery": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "deliveryInvoiceNumber": { "type": "string" } } }, "TmsTask": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор задачи", "format": "int64", "readOnly": true }, "status": { "type": "string", "description": "Текущий статус задачи", "readOnly": true, "enum": [ "CREATED", "RUNNING", "FINISHED", "ERROR", "RESTARTING", "INTERRUPTING", "INTERRUPTED", "STOPPED", "EXCEPTION" ] }, "type": { "type": "string", "description": "Тип задачи", "readOnly": true, "enum": [ "WILDBERRIES_CREATE_CARD", "NATIONAL_CATALOG_CREATE_CARD", "OZON_CREATE_CARD", "OZON_CARDS_IMPORT", "IMPORT_FBS_ORDERS", "UPLOAD_PHOTOGRAPHY", "WILDBERRIES_UPDATE_PRICE", "WILDBERRIES_CARD_IMPORT", "WILDBERRIES_CARD_UPDATE", "SELSUP_STOCKS", "REFRESH_PHOTOGRAPHY", "SUPPLYING_QUANTITY_TASK", "EXPORT_PRICE", "OZON_UPDATE_PRICE", "WILDBERRIES_FILE_TASK", "YANDEX_MARKET_CARD_CREATE", "OZON_CARD_UPDATE_TASK", "OZON_IMPORT_STAT_TASK", "WILDBERRIES_PROFIT_STAT_TASK", "ALIEXPRESS_CREATE_CARD_TASK", "ALIEXPRESS_UPDATE_CARD_TASK", "PRICES_IMPORT_TASK", "WILDBERRIES_PRICES_TASK", "YANDEX_MARKET_CARD_IMPORT", "STOCKS_UPDATE", "WILDBERRIES_STOCKS_IMPORT_TASK", "WILDBERRIES_ORDERS_AND_SALES_TASK", "WILDBERRIES_INCOMES_IMPORT_TASK", "OZON_STOCKS_IMPORT_TASK", "TURNOVER_DOCUMENTS_TASK", "INTRODUCE_WMS_ITEMS_TASK", "PRODUCTS_FILE_TASK", "MODELS_FILE_TASK", "UPDATE_PRODUCT_CODES_TASK", "INTRODUCE_CODES_TASK", "PRODUCTS_IMPORT_TASK", "PRICES_FILE_TASK", "YANDEX_MARKET_UPDATE_PRICE_TASK", "IMPORT_STOCKS_TASK", "MOY_SKLAD_EXPORT_ORDERS", "MERGE_PRODUCTS_TASK", "PRODUCTS_WILDBERRIES_EXCEL_IMPORT_TASK", "MOY_SKLAD_CREATE_CARD", "IMPORT_FBO_STOCKS_FROM_FILE", "CREATE_WMS_ITEMS", "MOY_SKLAD_CARDS_IMPORT", "PROMOTION_FILE", "TOCHKA_INIT_STATEMENT", "TOCHKA_IMPORT_TRANSACTIONS", "PRODUCT_ANALYTICS_FILE_TASK", "PROMOTION_RESET_FILE", "MOY_SKLAD_IMPORT_ORDERS", "FINANCE_REPORT_FILE_TASK", "YML_FILE_EXPORT", "PRODUCT_BALANCE_REPORT_FILE_TASK", "CURRENT_PRODUCT_BALANCE_FILE_TASK", "SBER_IMPORT_TRANSACTIONS", "MATCH_UNREGISTERED_PROFIT_REPORT_TASK", "UPDATE_AVERAGE_SERVICE_EXPENSES_TASK", "YANDEX_MARKET_ORDER_IMPORT_STAT_TASK", "ABC_REPORT_FILE_TASK", "MODEL_CONTRACTORS_IMPORT", "MODEL_CONTRACTORS_EXPORT", "BANK_TRANSACTION_IMPORT_FILE_TASK", "YML_IMPORT_TASK", "SALES_DYNAMIC_REPORT_FILE_TASK", "UPDATE_FBS_ORDERS", "EXPORT_TRANSACTION_IN_EXCEL_FILE_TASK", "IMPORT_TRANSACTION_FROM_EXCEL_FILE_TASK", "EXPORT_PROFIT_REPORT_FILE_TASK", "IMPORT_PROFIT_REPORT_FROM_EXCEL_FILE_TASK", "IMPORT_REALIZATION_REPORT_TASK", "STOCK_RECONCILIATION", "ORDER_REPORT_FILE_TASK", "GET_WB_FBO_ORDER_FROM_PROFIT_REPORT_TASK", "TO_QUANTITY_STORAGE_METHOD", "APPLY_RECONCILIATION", "OZON_IMPORT_FBO_ORDERS_TASK", "UPDATE_PURCHASE_PRICE_IN_PROFIT_REPORT_TASK", "FBS_LABELS", "MERGE_PRODUCT_STOCKS", "CREATE_ORDER_FROM_FILE", "ALIEXPRESS_CARD_IMPORT", "PRICE_LIST_IMPORT", "WB_STOCK_REPORT_FILE", "CONTRACTORS_REPORT_FILE", "PRODUCTS_SBER_MEGA_MARKET_EXCEL_IMPORT_TASK", "EXPORT_PROBLEMATIC_PRODUCT_REPORT", "PLAN_SUPPLY_REPORT_TASK", "PLAN_FACT_SALES_REPORT_FILE", "IMPORT_PLAN_SALES_FROM_EXCEL_FILE_TASK", "EXPORT_PLAN_SALES_EXCEL_FILE_TASK", "ORDERS_TO_BUY_FILE_TASK", "MERGE_PRICE_ON_OTHER_MP_TASK", "MATCH_PRODUCT_LAST_OPERATION_DATE_TASK", "PROBLEMATIC_PRODUCT_PRICE_FILE_TASK", "CATEGORIES_IMPORT_EXCEL_TASK", "AVITO_CARD_IMPORT", "UPDATE_OLD_WB_ORDER_STATUSES_TASK", "PRESTA_SHOP_IMPORT_TASK", "PRODUCTS_AVITO_EXCEL_IMPORT_TASK", "FBO_STOCK_RECONCILIATION_TASK", "APPLY_FBO_RECONCILIATION_TASK", "EXPORT_REPRICE_PRODUCT_CONFIG_TASK", "IMPORT_REPRICE_PRODUCT_CONFIG_TASK", "OZON_CASH_FLOW_STATEMENT_IMPORT_TASK", "IMPORT_PROMOTION_STRATEGY_FILE_TASK", "UPDATE_ORDER_DELIVERY_INFO_TASK", "BILLING_OPERATION_TASK", "SET_PURCHASE_PERCENT_TASK", "REMOVE_PRODUCT_IMAGES_TASK", "STRUCTURE_TURNOVER_TASK", "OZON_NEW_UPDATE_PRICE", "REPLACE_PRODUCT_IMAGE_TASK", "UPDATE_OZON_PROMOTION_DATA_TASK", "WILDBERRIES_IMPORT_CAMPAIGN_TASK", "WILDBERRIES_STORAGE_REPORT_TASK", "WEBASYST_LINK_ARTICLE_TASK", "DELIVERY_SERVICE_LABELS", "HAND_ON_PULSE_FILE_TASK", "ITEMS_INCOME_EXCEL_TASK", "UPDATE_SETS_EXCEL_TASK", "DELETE_PROFIT_REPORTS_BY_FILE_HISTORY_IDS_TASK", "EXPORT_PRODUCT_SETS_TASK", "AMAZON_CARD_IMPORT", "IMPORT_ACCEPTED_PRODUCTS_TASK", "ADD_ORDER_PRODUCT_FROM_FILE_TASK", "EXPORT_ITEM_HISTORY_FILE_TASK", "WILDBERRIES_IMPORT_CAMPAIGN_BY_EXCEL_TASK", "REMOVE_CLIENT_ORGANIZATION", "EBAY_CARD_IMPORT_TASK", "PRODUCTS_IMPORT_FROM_ORGANIZATION_TASK", "IMPORT_FBO_ORDERS", "LAMODA_CARD_IMPORT", "UPDATE_WB_PROMOTION_DATA_TASK", "IMPORT_RETURNS_REPORT_TASK", "UPDATE_PROMOTION_DATA_TASK", "RESTORE_CLIENT_ORGANIZATION", "LEROY_MERLIN_CARD_IMPORT", "YANDEX_MARKET_STOCKS_IMPORT_TASK", "WILDBERRIES_IMPORT_NM_REPORT_TASK", "ORDER_ANALYTICS_FILE_TASK", "CLIENT_DATABASE_MOVE_TASK", "FAST_CARD_IMPORT", "EXPORT_PRODUCT_CODE", "INSALES_CARD_IMPORT_TASK", "REMOVE_PRODUCT_VIDEOS_TASK", "UPDATE_CARDS_TASK", "FIND_UNPROFITABLE_PRODUCTS_TASK", "FIND_UNPURCHASED_PRODUCTS_TASK", "WALMART_CARD_IMPORT", "PRODUCT_GROUPS_TASK", "CONTRACTOR_ARTICLE_EXPORT_TASK", "CONTRACTOR_ARTICLE_IMPORT_TASK", "CURRENCY_CONVERSION_TASK", "UPDATE_SUPPLY_PLAN_REPORT_TASK", "EXPORT_SUPPLY_PLAN_REPORT_FILE_TASK", "CHECK_STOCK_ORDER", "PHOTOGRAPHY_EXCEL", "PREPARE_FINDIR_DATA_TASK", "CARD_SPLITTING_TASK", "EXPORT_IMAGE_UPDATES_TEMPLATE_TASK", "IMPORT_IMAGE_UPDATES_TASK", "PREPARE_PRODUCT_HAND_ON_PULSE_TASK", "UPDATE_OZON_AVERAGE_DELIVERY_TIME", "UPDATE_COMMISSIONS_TASK", "WOOCOMMERCE_CARD_IMPORT", "UPDATE_FBS_STOCKS_HISTORY" ] }, "name": { "type": "string", "description": "Данные задачи в json - могут быть пустыми" }, "clientId": { "type": "integer", "format": "int64" }, "entityId": { "type": "integer", "description": "Сущность, к которой относится задача", "format": "int64" }, "progress": { "type": "integer", "description": "Прогресс выполнения задачи в процентах", "format": "int32" }, "processedQuantity": { "type": "integer", "description": "Количество обработанных записей задачи", "format": "int32" }, "organizationId": { "type": "integer", "description": "Организация задачи, может быть 0, если не зависит от организации", "format": "int64" }, "priority": { "type": "integer", "description": "Приоритет задачи - чем выше тем быстрее задача запустится", "format": "int32" }, "properties": { "type": "string", "description": "Параметры задачи" }, "message": { "type": "string", "description": "Сообщение с результатом выполнения задачи" }, "messageParams": { "type": "string", "description": "Параметры сообщения с результатом выполнения задачи" }, "createdDate": { "type": "string", "description": "Дата добавления задачи в очередь", "format": "date-time" }, "startDate": { "type": "string", "description": "Дата запуска задачи", "format": "date-time" }, "finishDate": { "type": "string", "description": "Дата завершения задачи", "format": "date-time" }, "url": { "type": "string", "description": "Ссылка на скачивание файла с результатом задачи" }, "inputFileUrl": { "type": "string", "description": "Ссылка на загруженный файл" }, "retryNumber": { "type": "integer", "description": "Счётчик перезапуска задачи.", "format": "int32" }, "userId": { "type": "integer", "description": "Пользователь запустивший задачу", "format": "int32" }, "retryDate": { "type": "string", "description": "Запланированная дата перезапуска", "format": "date-time" }, "debug": { "type": "boolean", "description": "Запуск задачи в режиме отладки с большим логированием" }, "forcedStart": { "type": "boolean", "description": "Ручной запуск задачи" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "lang": { "type": "string", "description": "Язык на котором сейчас запущена таска" } }, "description": "Фоновая задача SelSup. Возвращается в разных методах, которые можно выполнять асинхронно. Далее можно проверять статус задачи, вызывая метод /task/getTask?id=" }, "MarkForSetParameters": { "type": "object", "properties": { "marks": { "type": "array", "description": "Коды маркировки", "items": { "type": "string", "description": "Коды маркировки" } }, "orderProductCollectSetId": { "type": "integer", "description": "Идентификатор сборки товара из заказа", "format": "int64" }, "base64": { "type": "boolean", "description": "Маркировка закодирована в base64" } }, "description": "Параметры" }, "OrderProductCollect": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "order": { "$ref": "#/components/schemas/Order" }, "orderId": { "type": "integer", "format": "int64" }, "sets": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollectSet" } }, "status": { "type": "string", "description": "Статус резерва остатка, UNKNOWN означает, что либо резерв взят, если присвоен itemId, либо резерва вообще не произошло. COLLECTED - резерв списан был по данной позиции. CANCELED - позиции не было на складе при этом она зарезервировалась и нет замены. REFUND - остаток был возвращен на склад при возврате. ", "enum": [ "UNKNOWN", "COLLECTED", "CANCELED", "REFUND" ] }, "orderProduct": { "$ref": "#/components/schemas/OrderProduct" }, "orderProductId": { "type": "integer", "format": "int64" }, "productCodeId": { "type": "integer", "format": "int64" }, "quantity": { "type": "integer", "description": "Надо поддержать возможность указывать количество в OrderProductCollect. Сейчас на каждую единицу создается отдельный OrderProductCollect", "format": "int32" }, "wmsItem": { "$ref": "#/components/schemas/WmsItem" }, "itemId": { "type": "integer", "format": "int64" }, "collectOrderTaskId": { "type": "integer", "description": "Сборочное задание, к которому относится заказ", "format": "int64" }, "clientId": { "type": "integer", "description": "Идентификатор клиента", "format": "int64" }, "collectTaskPosition": { "type": "integer", "description": "Позиция товара в сборочном задании", "format": "int32" }, "userId": { "type": "integer", "description": "Пользователь который взял задания", "format": "int32" }, "isSet": { "type": "boolean", "description": "Признак того, что зарезервированный остаток собран как комплект из составных частей. В этом случае остатки списываются с составных частей, а не с самого товара и делаются дополнительные записи в таблицу OrderProductCollectSet" }, "gtd": { "type": "string" }, "markConfirmed": { "type": "boolean", "description": "Признак, что маркировка передана на маркетплейс успешно" }, "itemIdToReserve": { "type": "integer", "format": "int64" }, "expirationDate": { "type": "string", "description": "Годен до", "format": "date" }, "product": { "$ref": "#/components/schemas/Product" } }, "description": "Позиция товара в заказе на сборку для резерва и списания остатка. Определяет с каких остатков произойдет резерв и списание остатка путем присвоения itemId. Если itemId присвоен, значит с указанного остатка был произведен резерв и количество свободного остатка уменьшилось. Поле quantity сделано для позиций в которых много остатков, например десятся или сотни, чтобы не создавать много единичных записей OrderProductCollect на каждую штуку. В случае использования маркировки хранит так же связь, какой код маркировки был отгружен в конкретной позиции" }, "OrderProductCollectSet": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "item": { "$ref": "#/components/schemas/WmsItem" }, "itemId": { "type": "integer", "format": "int64" }, "quantity": { "type": "integer", "description": "Сколько остатка было зарезервировано с остатка itemId", "format": "int32" }, "orderProductCollectId": { "type": "integer", "format": "int64" }, "product": { "$ref": "#/components/schemas/Product" }, "productCodeIds": { "type": "string" } }, "description": "Резерв позиций из заказа за счет составных частей. Если в товаре присутствует комплект, остатки под него резервируются из составных частей и в данной таблице хранится информация о том, для какой позиции были взяты какие остатки с составных частей комплекта. В позиции orderProductCollectId будет обязательно стоять IsSet" }, "OrderFilter": { "type": "object", "properties": { "count": { "type": "boolean", "description": "Возвратить в ответе общее количество записей" }, "sortBy": { "type": "string", "description": "Поле для сортировки", "enum": [ "ID", "CREATEDDATE", "ORDERCREATED", "CREATED", "CREATEDUSER", "STATUS", "SERVICE", "TYPE", "BOXTYPE", "NAME", "ORGANIZATIONID", "WAREHOUSE", "INVOICENUMBER", "EXTERNALORDERID", "QUEUE", "SUPPLYID", "CLOSEDATE", "STARTCOLLECTDATE", "CLOSEUSERID", "USERID", "PRICE", "PRODUCT", "COLLECTORDERTASKID", "DELIVERYDATE", "MARKINGSTATUS", "QUANTITY", "DATE", "SERVICEWAREHOUSEID" ] }, "ascending": { "type": "boolean", "description": "Порядок сортировки - по возрастанию?. Работает только при получении списка." }, "actual": { "type": "boolean", "description": "Отображать только актуальные заказы - не закрытые?" }, "type": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "serviceWarehouseId": { "type": "string", "description": "Внешний номер склада" }, "externalOrderId": { "type": "string", "description": "Внешний номер заказа" }, "invoiceNumber": { "type": "integer", "description": "ID Номера счета", "format": "int64" }, "article": { "type": "string", "description": "Фильтр по артикулу модели товара в заказе" }, "product": { "type": "string", "description": "Фильтр по названию товара в заказе" }, "organizations": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "items": { "type": "integer", "description": "Фильтр по ID организации. Можно передавать несколько значений organizations=123&organizations=345", "format": "int64" } }, "query": { "type": "string", "description": "Поисковый запрос для фильтрации заказов по номеру или названию" }, "userId": { "type": "integer", "description": "ID пользователя который брал на сборку заказ", "format": "int32" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "status": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "statuses": { "type": "array", "description": "Фильтр по статусам заказа. Можно передавать несколько значений statuses=CREATED&statuses=PACKING", "items": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] } }, "withoutSupply": { "type": "boolean", "description": "Фильтр по заказам не прикрепленным к поставке?" }, "orderProductId": { "type": "integer", "description": "Фильтр по ID позиции в заказе", "format": "int64" }, "productId": { "type": "integer", "description": "Фильтр по ID товара из заказа", "format": "int64" }, "hasCollectTask": { "type": "boolean", "description": "Фильтр по наличию у заказа сборочного задания?" }, "organizationId": { "type": "integer", "description": "Фильтр по ID организации заказа", "format": "int64" }, "updateInService": { "type": "boolean", "description": "Заказы, которые стоят в очереди на изменение статуса на маркетплейсе?" }, "hasServiceError": { "type": "boolean", "description": "Заказы с ошибкой обновления статуса на маркетплейсе?" }, "noLabel": { "type": "boolean", "description": "Фильтрует заказы без этикетки?" }, "noMsOrder": { "type": "boolean", "description": "Фильтрует по заказам не созданным в Моем складе?" }, "noMsDemand": { "type": "boolean", "description": "Фильтрует по заказам с несозданными отгрузками в Моем складе?" }, "ids": { "uniqueItems": true, "type": "array", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "items": { "type": "integer", "description": "ID заказов. Можно передавать несколько значений ids=123&ids=345", "format": "int64" } }, "supplyId": { "type": "integer", "description": "ID поставки, в которой отгружается заказ", "format": "int64" }, "notCollected": { "type": "boolean", "description": "Заказы, которые не собирались через SelSup?" }, "dbs": { "type": "boolean", "description": "DBS заказы?" }, "express": { "type": "boolean", "description": "Express заказы?" }, "fbs": { "type": "boolean", "description": "FBS заказы?" }, "noWarehouse": { "type": "boolean", "description": "Заказы без склада?" }, "closeDate": { "type": "string", "description": "Фильтр по дате сборки заказа - конкретный день" }, "modifiedDate": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе начиная с этой даты", "format": "date-time" }, "modifiedDateTo": { "type": "string", "description": "Фильтр по дате изменения заказа - статуса или любой информации о заказе до этой даты", "format": "date-time" }, "incomeId": { "type": "integer", "description": "ID закупки из которого создан заказ", "format": "int64" }, "bindingOrderId": { "type": "integer", "description": "ID заказа, которому делаем возврат", "format": "int64" }, "closeDateFrom": { "type": "string", "description": "Фильтр по дате сборки заказа от - ISO", "format": "date-time" }, "closeDateTo": { "type": "string", "description": "Фильтр по дате сборки заказа до - ISO", "format": "date-time" }, "orderDate": { "type": "string", "description": "Фильтр по дате заказа" }, "deliveryDate": { "type": "string", "description": "Фильтр по дате доставки заказа" }, "deliveryDateFrom": { "type": "string", "description": "Фильтр по дате доставки заказа от" }, "deliveryDateTo": { "type": "string", "description": "Фильтр по дате доставки заказа до" }, "forMoySklad": { "type": "boolean", "description": "Для создания в МойСклад?" }, "warehouseId": { "type": "integer", "description": "Фильтр по ID склада, с которого отгружается заказ", "format": "int64" }, "warehouseIds": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "items": { "type": "integer", "description": "Фильтр по ID складам, с которого отгружается заказ. Можно передавать несколько значений warehouseIds=123&warehouseIds=345", "format": "int64" } }, "dateFrom": { "type": "string", "description": "Фильтр по дате заказа - от", "format": "date-time" }, "dateTo": { "type": "string", "description": "Фильтр по дате заказа - до", "format": "date-time" }, "timeZone": { "type": "integer", "description": "ID часового пояса клиента по UTC в часах, например 3", "format": "int32" }, "markingStatus": { "type": "string", "description": "Фильтр по статусу в честном знаке", "enum": [ "UNKNOWN", "CARDS_SEND", "CARDS_CREATED", "SUZ_ORDERS_CREATED", "MARKS_RECEIVED", "CARDS_SIGNED", "DOCUMENT_CREATED", "SUCCESS", "NO_NEED_MARKING" ] }, "deleted": { "type": "boolean", "description": "Показать удаленные заказы?" }, "collectLabel": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" }, "sortOrdersByDate": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать сборочную этикетку для \"умной ленты\"?" }, "sortBySku": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости использовать в сортировке данные о товарах объединенных по SKU?" }, "notGroupByOrganization": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все организации сортируются одним списком?" }, "notGroupByService": { "type": "boolean", "description": "Только для печати в PDF. Признак того, что все маркетплейсы сортируются одним списком?" }, "productLabel": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать этикетку товара в ленте?" }, "servicesForLabel": { "type": "array", "description": "Сервисы для которых нужна печать в PDF", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, "infoLabel": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать информационную этикетку для ленты заказов?" }, "grouped": { "type": "boolean", "description": "Отдает сгруппированные позиции из заказов. Только для выгрузки в Excel?" }, "replaceSetByComponent": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты?" }, "replaceSetsByComponentsIncome": { "type": "boolean", "description": "Заменяет в заказах комплекты на компоненты в файле закупки?" }, "collectDeliveryLabel": { "type": "boolean", "description": "Только для печати в PDF. Признак необходимости распечатать накладную службы доставки для \"умной ленты\"?" }, "shippingServicesForLabel": { "type": "array", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "items": { "type": "string", "description": "Сервисы доставки для которых нужна печать накладной в PDF", "enum": [ "CDEK", "OWN_DELIVERY", "POST", "BOXBERRY", "DPD", "YANDEX", "DOSTAVISTA", "DELLIN", "PEC" ] } }, "orderId": { "type": "integer", "description": "ID заказа", "format": "int64" }, "hasVideoFixation": { "type": "boolean", "description": "Идентификатор была ли видео фиксация?" }, "withProducts": { "type": "boolean", "description": "Признак, что заказы необходимо отдать c товарами?" }, "passageIds": { "uniqueItems": true, "type": "array", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "items": { "type": "integer", "description": "Фильтр по ID проходов. Можно передавать несколько значений passageIds=123&passageIds=345", "format": "int64" } }, "withContractor": { "type": "boolean", "description": "Включить информацию о поставщиках в выгрузку?" } } }, "DeliveryMethod": { "type": "object", "properties": { "delivery_method_id": { "type": "integer", "description": "Идентификатор способа доставки.", "format": "int64" }, "delivery_method_name": { "type": "string", "description": "Название способа доставки." }, "tpl_provider": { "type": "string", "description": "Служба доставки." }, "tpl_provider_id": { "type": "integer", "description": "Идентификатор службы доставки.", "format": "int64" }, "warehouse_name": { "type": "string", "description": "Название склада." }, "warehouse_id": { "type": "integer", "description": "Идентификатор склада", "format": "int64" }, "has_entrusted_acceptance": { "type": "boolean" } } }, "UserStatRequest": { "type": "object", "properties": { "period": { "type": "string", "description": "Период агрегации", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MONTH_3", "MONTH_6", "END_OF_TARIFF", "MONTH_7", "MONTH_14", "YEAR_2" ] }, "dateFrom": { "type": "string", "description": "Дата начала отчета", "format": "date-time" }, "dateTo": { "type": "string", "description": "Дата окончания отчета", "format": "date-time" }, "services": { "type": "array", "description": "Список маркетплейсов для которых отдать данные", "items": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] } }, "categories": { "type": "array", "description": "Фильтр категорий для которых отдать данные", "items": { "type": "integer", "description": "Фильтр категорий для которых отдать данные", "format": "int64" } }, "brands": { "type": "array", "description": "Фильтр брендов для которых отдать данные", "items": { "type": "integer", "description": "Фильтр брендов для которых отдать данные", "format": "int64" } }, "clientOrganizationId": { "type": "integer", "description": "Идентификатор организации, для которой отдать данные", "format": "int64" }, "organizations": { "uniqueItems": true, "type": "array", "description": "Идентификаторы организаций клиента", "items": { "type": "integer", "description": "Идентификаторы организаций клиента", "format": "int64" } }, "ids": { "type": "array", "description": "Список идентификаторов", "items": { "type": "integer", "description": "Список идентификаторов", "format": "int64" } }, "type": { "type": "string", "description": "Тип заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] }, "types": { "uniqueItems": true, "type": "array", "description": "Типы заказа", "items": { "type": "string", "description": "Типы заказа", "enum": [ "FBM", "FBS", "INCOME", "RETAIL", "WHOLESALE", "FBO", "MOVEMENT", "WRITE_OFF", "PRODUCTION" ] } }, "status": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "timeZone": { "type": "integer", "description": "Часовой пояс клиента по UTC", "format": "int32" }, "previousDateFrom": { "type": "string", "description": "Дата начала периода для сравнения", "format": "date-time" } } }, "ProductStats": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "CollectTask": { "type": "object", "properties": { "order": { "$ref": "#/components/schemas/Order" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } } }, "AddExpirationDateRequest": { "type": "object", "properties": { "orderId": { "type": "integer", "description": "Годен до", "format": "int64" }, "productCollectIdToDate": { "type": "object", "additionalProperties": { "type": "string", "description": "Идентификаторы сборки товара из заказа и их сроки годности", "format": "date" }, "description": "Идентификаторы сборки товара из заказа и их сроки годности" } } }, "ChangeStockWarehouseDTO": { "type": "object", "properties": { "orderId": { "type": "integer", "format": "int64" }, "warehouseId": { "type": "integer", "format": "int64" } } }, "FindResponseOrder": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/Order" } }, "total": { "type": "integer", "description": "Общее количество найденных записей. Возвращается только, когда count = true", "format": "int32" }, "page": { "type": "integer", "description": "Номер запрошенной страницы", "format": "int32" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "description": "Показатель пустой закупочной цены", "format": "int64" } } }, "OrderCounter": { "type": "object", "properties": { "organizationId": { "type": "integer", "format": "int64" }, "deliveryDate": { "type": "string" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "status": { "type": "string", "description": "Статус заказа", "enum": [ "CREATED", "REVOKING", "REVOKED", "ORDER_CREATED", "CARDS_CREATED", "BOX_BARCODES", "IMAGES_UPLOADED", "INVOICE_UPLOADED", "READY_TO_SUPPLY", "SUPPLIED", "FINISHED", "COLLECTED", "SEND", "DELIVERY", "REFUND", "COLLECTING", "PACKING", "PAYMENT_REQUIRED", "CANCELED", "CONTROVERSIAL", "OVERDUE", "READY_FOR_PICKUP", "WAITING_SUPPLY", "PICK_UP_REFUND", "REFUND_RECEIVED", "DELETED", "RESTORE", "PRODUCTION_CONFIRMED" ] }, "quantity": { "type": "integer", "format": "int32" }, "noLabel": { "type": "integer", "format": "int32" }, "warehouseId": { "type": "integer", "format": "int64" } } }, "CollectOrderTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "service": { "type": "string", "description": "Сервис", "enum": [ "NONE", "WILDBERRIES", "OZON", "YANDEX_MARKET", "FAMILIYA", "NATIONAL_CATALOG", "ALIEXPRESS", "OTHER", "MOY_SKLAD", "SBER_MEGA_MARKET", "CISLINK", "ONE_C", "AVITO", "LEROY_MERLIN", "DETMIR", "KAZAN_EXPRESS", "EVOTOR", "WEBASYST", "AMAZON", "EBAY", "SIMALAND", "INSALES", "LAMODA", "OZON_PERFORMANCE", "WALMART", "GOOGLE", "YANDEX_DISC", "EMAIL", "WOOCOMMERCE" ] }, "deliverDate": { "type": "string", "description": "Дата доставки заказа - заказы на разные даты доставки не могут попадать в одно сборочное задание, это всегда будут разные задания и мы не создаем сборочные задания не на сегодняшний день, тк оно может отмениться." }, "finished": { "type": "boolean", "description": "Признак того, что задание закрыто. Проставляется если все товары в задании собираются или вызывается метод закрытия сборочного задания" }, "clientId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "description": "Пользователь, который взял задание. Может быть пустым, если задание еще никто не взял", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "orderId": { "type": "integer", "description": "Идентификатор заказа", "format": "int64" }, "products": { "type": "array", "description": "Список позиций из заказов в задании для сборки", "items": { "$ref": "#/components/schemas/OrderProductCollect" } } }, "description": "Сборочное задание по заказам. Сборочные задания формируются на заказ, если: 1)У него есть этикетка 2)Если у заказа есть уникальный код, который под него зарезервирован" }, "FindResponseCollectOrderTask": { "type": "object", "properties": { "rows": { "type": "array", "description": "Строки с результатом поиска", "items": { "$ref": "#/components/schemas/CollectOrderTask" } }, "total": { "type": "integer", "description": "Общее количество найденных записей. Возвращается только, когда count = true", "format": "int32" }, "page": { "type": "integer", "description": "Номер запрошенной страницы", "format": "int32" }, "hasNextPage": { "type": "boolean", "description": "Есть ли следующая страница" }, "emptyPurchase": { "type": "integer", "description": "Показатель пустой закупочной цены", "format": "int64" } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "name": "Authorization", "in": "header" } } } }