{ "openapi": "3.0.0", "info": { "title": "Uzum market seller openapi", "version": "1.0.0" }, "servers": [ { "url": "https://api-seller.uzum.uz/api/seller-openapi/", "description": "OpenAPI для продавцов UZUM MARKET" } ], "security": [ { "TokenAuth": [] } ], "tags": [ { "name": "FBO Invoice", "description": "Получение списка накладных поставки" }, { "name": "Return Invoice", "description": "Получение списка накладных возврата" }, { "name": "Product", "description": "Получение остатков SKU/информации о товарах и изменение цен, работа с этикетками" }, { "name": "Finance", "description": "Получение списка продаж/заказов" }, { "name": "Работа с заказами FBS/DBS", "description": "Получение информации по заказам, подтверждение, отмена, передача в доставку, выдача, возврат, идентификаторы, этикетки" }, { "name": "FBS Invoice", "description": "Работа с накладными, актами поставки, пунктами приема" }, { "name": "Stocks", "description": "Получение и обновление остатков SKU по FBS" }, { "name": "Shop", "description": "Получение информации по магазинам" } ], "paths": { "/v1/product/shop/{shopId}": { "get": { "summary": "Получение SKU по ID магазина", "description": "Этот метод позволяет получить список товаров и остатков, доступных в указанном магазине.", "operationId": "getShopProductsByShopId", "tags": [ "Product" ], "parameters": [ { "name": "searchQuery", "description": "Запрос для поиска товаров по названию или описанию.", "in": "query", "required": false, "schema": { "type": "string", "default": "" } }, { "name": "sortBy", "description": "Критерий сортировки товаров. Доступные варианты: DEFAULT, ORDERS, PRICE, ID, ROI, CONVERSION, LEFTOVERS, CREATED_AND_TITLE.", "in": "query", "required": false, "schema": { "type": "string", "default": "DEFAULT", "enum": [ "DEFAULT", "ORDERS", "PRICE", "ID", "ROI", "CONVERSION", "LEFTOVERS", "CREATED_AND_TITLE" ] } }, { "name": "order", "description": "Направление сортировки: ASC (по возрастанию) или DESC (по убыванию).", "in": "query", "required": false, "schema": { "type": "string", "default": "ASC", "enum": [ "ASC", "DESC" ] } }, { "name": "size", "description": "Количество товаров, возвращаемых в одном запросе.", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "description": "Номер страницы для постраничного просмотра товаров.", "in": "query", "required": true, "schema": { "minimum": 0, "type": "integer", "format": "int32" } }, { "name": "shopId", "description": "ID магазина, для которого необходимо получить товары.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "productRank", "description": "Категория товара, которую нужно отобразить. Возможные значения: A, B, C, N, D.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "A", "B", "C", "N", "D" ] } }, { "name": "filter", "description": "Фильтр для отображения товаров. Доступные значения: ALL, ACTIVE, INACTIVE, WARNING, WITH_SKU, ARCHIVE, DEFECTED, WITHOUT_REQUIRED_FILTERS.", "in": "query", "required": false, "schema": { "type": "string", "default": "ALL", "enum": [ "ALL", "ACTIVE", "INACTIVE", "WARNING", "WITH_SKU", "ARCHIVE", "DEFECTED", "WITHOUT_REQUIRED_FILTERS" ] } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/AllProducts" } } } } } } }, "/v1/product/{shopId}/sendPriceData": { "post": { "summary": "Изменение цен SKU", "description": "Этот метод позволяет менять цены SKU.", "operationId": "saveProductPriceData", "tags": [ "Product" ], "parameters": [ { "name": "shopId", "description": "ID магазина, для которого необходимо изменить цены SKU.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPriceData" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } } } } } }, "/v1/shop/{shopId}/invoice": { "get": { "summary": "Получение накладных поставки по ID магазина", "description": "Этот метод позволяет получить список накладных поставки для указанного магазина.", "operationId": "getShopInvoicesByShopId", "tags": [ "FBO Invoice" ], "parameters": [ { "name": "shopId", "description": "ID магазина, для которого необходимо получить список накладных поставки.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "size", "description": "Количество записей на странице (постраничный просмотр).", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "description": "Номер страницы для постраничного просмотра накладных поставки.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceInList" } } } } } } } }, "/v1/shop/{shopId}/invoice/products": { "get": { "summary": "Получение состава накладной", "description": "Этот метод позволяет получить список товаров входящих в накладные", "operationId": "getShopInvoiceProductsByShopId", "tags": [ "FBO Invoice" ], "parameters": [ { "name": "invoiceId", "description": "ID накладной, для которой необходимо получить содержимое", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shopId", "description": "ID магазина, для которого необходимо получить список накладных возврата.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductForInvoiceDto" } } } } } } } }, "/v1/shop/{shopId}/return": { "get": { "summary": "Получение накладных возврата", "description": "Этот метод позволяет получить список накладных возврата.", "operationId": "getShopReturnsByShopId", "tags": [ "Return Invoice" ], "parameters": [ { "name": "shopId", "description": "ID магазина, для которого необходимо получить список накладных возврата.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "description": "Номер страницы для постраничного просмотра накладных поставки.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "description": "Количество записей на странице (постраничный просмотр).", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SellerReturnLite" } } } } } } }, "/v1/shop/{shopId}/return/{returnId}": { "get": { "summary": "Получение состава накладной возврата", "description": "Этот метод позволяет получить список товаров входящих в накладные возврата", "operationId": "getShopReturnByShopIdAndReturnId", "tags": [ "Return Invoice" ], "parameters": [ { "name": "returnId", "description": "ID накладной возврата, для которой необходимо получить содержимое", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shopId", "description": "ID магазина, для которого необходимо получить список накладных возврата.", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerReturnDto" } } } } } } }, "/v1/finance/orders": { "get": { "summary": "Получение списка заказов.", "description": "Этот метод позволяет получить список продаж.", "operationId": "getFinanceOrders", "tags": [ "Finance" ], "parameters": [ { "name": "page", "description": "Номер страницы для постраничного просмотра накладных поставки.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "description": "Количество записей на странице (постраничный просмотр).", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "group", "description": "Группировать заказы или нет. В зависимости от состояния этого флага, будет возвращаться то или иное наполнения поля orderItems. >\nЕсли флаг true: вернется `ProductGroupedSellerItem`\nЕсли флаг false: вернется `SellerOrderItemDto`", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "dateFrom", "description": "Дата, с которой необходимо показывать заказы", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dateTo", "description": "Дата, с которой необходимо показывать заказы", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "statuses", "description": "Статусы заказов (к выводу средств (TO_WITHDRAW), в обработке (PROCESSING), отменен (CANCELED), частично отменен( PARTIALLY_CANCELLED))", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "TO_WITHDRAW", "PROCESSING", "CANCELED", "PARTIALLY_CANCELLED" ] } } }, { "name": "shopIds", "description": "Список магазинов, для которых необходимо показывать заказы", "in": "query", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/FinanceOrderItemsDto" } } } }, "400": { "description": "Bad request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/fbs/order/{orderId}": { "get": { "summary": "Получение информации о заказе", "description": "Возвращает информацию о заказе продавца по идентификатору.", "operationId": "getFbsOrderByOrderId", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа продавца." } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrderDto" } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/fbs/order/{orderId}/confirm": { "post": { "summary": "Подтверждение заказа", "description": "Подтверждает заказ продавца.", "operationId": "confirmFbsOrder", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа, который необходимо подтвердить." } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrderDto" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: неподходящий статус для подтверждения; - `seller-order-03`: истек срок подтверждения.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/fbs/order/{orderId}/cancel": { "post": { "summary": "Отмена заказа", "description": "Отменяет заказ продавца.", "operationId": "cancelFbsOrder", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа, который необходимо отменить." } ], "requestBody": { "required": true, "description": "Данные для отмены заказа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerOrderCancelRq" } } } }, "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseVoid" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: неподходящий статус для отмены; - `seller-order-12`: недопустимая причина отмены; - `seller-order-13`: заказ уже отменен.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/fbs/order/{orderId}/identifier": { "post": { "summary": "Привязка идентификаторов к товарам заказа", "description": "Пакетно привязывает идентификаторы к позициям заказа продавца.", "operationId": "updateFbsOrderIdentifiers", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа, для позиций которого привязываются идентификаторы." } ], "requestBody": { "required": true, "description": "Список позиций заказа и значений идентификаторов для каждой позиции.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderIdentifiersRq" } } } }, "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseListIdentifierInfo" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: неподходящий статус заказа для привязки идентификатора; - `seller-order-05`: у позиции заказа не задан тип идентификатора; - `seller-order-06`: передано слишком много идентификаторов; - `seller-order-07`: невалидное значение идентификатора; - `seller-order-08`: идентификатор принадлежит другому SKU; - `seller-order-09`: не указан тип идентификатора; - `seller-order-10`: непредвиденная ошибка от WMS; - `seller-order-11`: сервис идентификаторов недоступен, повторите позже; - `seller-order-36`: позиция заказа не найдена.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/dbs/order/{orderId}/delivering": { "post": { "summary": "Передача DBS-заказа в доставку", "description": "Переводит DBS-заказ в статус DELIVERING.", "operationId": "deliveringDbsOrder", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа, который необходимо перевести в доставку." } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrderDto" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: неподходящий статус (разрешено только для PACKING); - `seller-order-03`: истёк срок доставки; - `seller-order-15`: не заполнены идентификаторы; - `fbs-18-invalid-order-type`: разрешено только для DBS-заказов.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/dbs/order/{orderId}/completed": { "post": { "summary": "Подтверждение выдачи DBS-заказа", "description": "Переводит DBS-заказ в статус COMPLETED после выдачи покупателю.", "operationId": "completedDbsOrder", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор выдаваемого заказа." }, { "name": "issueCode", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Код выдачи заказа (если требуется подтверждение покупателя)." } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrderDto" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: неподходящий статус (разрешено только для DELIVERING); - `seller-order-03`: истёк срок доставки; - `fbs-18-invalid-order-type`: разрешено только для DBS-заказов; - `seller-order-37`: код подтверждения заказа не найден; - `seller-order-38`: неверный код подтверждения; - `seller-order-39`: неверный код подтверждения, повторите попытку позже.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/dbs/order/{orderId}/refund": { "post": { "summary": "Создание возврата по DBS-заказу", "description": "Создаёт возврат по выданному DBS-заказу.", "operationId": "refundDbsOrder", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Идентификатор заказа, по которому создаётся возврат." } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseVoid" } } } }, "400": { "description": "Ошибки выполнения: - `seller-order-01`: заказ не найден; - `seller-order-02`: разрешено только для статуса COMPLETED; - `seller-order-13`: заказ уже на стадии возврата или отменён.", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/fbs/order/return-reasons": { "get": { "summary": "Получение причин возврата", "description": "Возвращает список причин возврата для заказов.", "operationId": "getFbsReturnReasons", "tags": [ "Работа с заказами FBS/DBS" ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseReturnReasonsDto" } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v3/fbs/sku/stocks": { "get": { "summary": "Получение остатков по SKU (постранично)", "description": "Возвращает доступные для обновления остатки FBS и DBS SKU.\nПоддерживает два режима постраничной выдачи:\npage - по номеру страницы, выдача по убыванию skuId;\nskuIdFrom - по курсору, выдача по возрастанию skuId.\nКурсорный режим не зависит от глубины листания и рекомендуется для полного обхода каталога.\nОдновременная передача page и skuIdFrom запрещена.", "operationId": "listFbsSkuStocks", "tags": [ "Stocks" ], "parameters": [ { "name": "page", "description": "Номер страницы для постраничного просмотра остатков SKU (начиная с 0). Не сочетается с skuIdFrom.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0, "minimum": 0 } }, { "name": "size", "description": "Количество записей на странице (1-100).", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 50, "minimum": 1, "maximum": 100 } }, { "name": "skuIdFrom", "description": "Курсор: вернуть SKU со skuId строго больше указанного, для первой страницы 0. Включает курсорный режим, выдача идет по возрастанию skuId, page не применяется. Курсор следующей страницы - skuId последнего элемента ответа; обход завершен, когда вернулось меньше size записей.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "minimum": 0 } } ], "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerFbsSkuStockUpdateDtoV2" } } } }, "400": { "description": "illegal-argument-001: Ошибка валидации параметров запроса (page/size/skuIdFrom)\nfbs-12-illegal-argument: page и skuIdFrom переданы одновременно", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "403": { "description": "fbs-2-seller-access-denied: У селлера нет доступа, необходимы права 'SKU_READ'\nstorage-service-04: Селлер заблокирован", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "500": { "description": "Internal server error", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v2/fbs/sku/stocks": { "get": { "summary": "Получение остатков по SKU (устарело)", "description": "Устарело: используйте GET /v3/fbs/sku/stocks с пагинацией. Возвращает доступные для обновления остатки FBS и DBS SKU.", "operationId": "downloadFbsSkuStocks", "deprecated": true, "tags": [ "Stocks" ], "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerFbsSkuStockUpdateDtoV2" } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "403": { "description": "fbs-2-seller-access-denied: У селлера нет доступа, необходимы права 'SKU_READ'\nstorage-service-04: Селлер заблокирован", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "500": { "description": "Internal server error", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } }, "post": { "summary": "Обновление остатков по SKU", "description": "Обновляет FBS и DBS остатки по переданным товарам.", "operationId": "uploadSkuAmounts", "tags": [ "Stocks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SkuStockUpdateApiRequestDto" } } }, "required": true, "description": "Данные для обновления остатков SKU." }, "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseVoid" } } } }, "400": { "description": "Возможные коды ошибок: \nstorage-service-05 - ошибка валидации; \nstorage-service-09 - ошибка при обновлени остатка; \n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "403": { "description": "fbs-2-seller-access-denied У селлера нет доступа к переданным товарам, необходимы права 'SKU_UPDATE'\nstorage-service-04 селлер заблокирован", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "500": { "description": "Internal server error", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/shops": { "get": { "summary": "Получение списка собственных магазинов.", "operationId": "getOwnedShops", "tags": [ "Shop" ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationDto" } } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } } }, "/v1/finance/expenses": { "get": { "summary": "Получение списка расходов продавца.", "operationId": "getFinanceExpenses", "tags": [ "Finance" ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "description": "Номер страницы для постраничного вывода данных." }, { "name": "size", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 }, "description": "Количество элементов на странице." }, { "name": "shopId", "in": "query", "description": "Идентификатор магазина для выборки данных.", "required": false, "deprecated": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shopIds", "in": "query", "description": "Список идентификаторов магазинов для выборки данных.", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "dateFrom", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Начальная дата для фильтрации расходов." }, { "name": "dateTo", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" }, "description": "Конечная дата для фильтрации расходов." }, { "name": "sources", "in": "query", "required": false, "description": "Источники, по которым фильтруются расходы.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerPaymentInfoDtoList" } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/invoice": { "get": { "summary": "Получение списка накладных", "operationId": "getSellerInvoice", "tags": [ "FBO Invoice" ], "parameters": [ { "name": "size", "description": "Количество накладных на странице (максимум 50).", "in": "query", "required": false, "schema": { "maximum": 50, "minimum": 0, "type": "integer", "format": "int32", "default": 50 } }, { "name": "page", "description": "Номер страницы для получения данных (начинается с 0).", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceWithSkuListDto" } } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v1/return": { "get": { "summary": "Получение возвратов продавца", "operationId": "getSellerReturn", "tags": [ "Return Invoice" ], "parameters": [ { "name": "returnId", "description": "Идентификатор возврата. Если пустой, возвращаются все возвраты для sellerId.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "description": "Номер страницы для получения данных (начинается с 0).", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "description": "Количество возвратов на странице (максимум 50).", "in": "query", "required": false, "schema": { "maximum": 50, "minimum": 0, "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellerReturnDto" } } } } }, "400": { "description": "Bad Request", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseObject" } } } } } } }, "/v2/fbs/orders": { "get": { "summary": "Получение заказов продавца", "description": "Возвращает заказы продавца по статусу.", "operationId": "getFbsOrdersV2", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "shopIds", "description": "Массив идентификаторов магазинов, для которых нужно получить заказы.", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "status", "description": "Статус заказов, которые нужно получить.", "in": "query", "required": false, "schema": { "type": "string", "default": "CREATED", "enum": [ "CREATED", "PACKING", "PENDING_DELIVERY", "DELIVERING", "DELIVERED", "ACCEPTED_AT_DP", "DELIVERED_TO_CUSTOMER_DELIVERY_POINT", "COMPLETED", "CANCELED", "PENDING_CANCELLATION", "RETURNED" ] } }, { "name": "scheme", "description": "Тип заказа. Если ничего не передать, вернутся и FBS и DBS", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "FBS", "DBS" ] } }, { "name": "dateFrom", "description": "Дата, с которой необходимо показывать заказы", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dateTo", "description": "Дата, по которую необходимо показывать заказы", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "description": "Номер страницы для получения данных (начинается с 0)", "in": "query", "required": false, "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "size", "description": "Количество возвратов на странице (максимум 50).", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrdersDto" } } } }, "400": { "description": "seller-order-12 - dateTo is before dateFrom", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrdersDto" } } } } } } }, "/v2/fbs/orders/count": { "get": { "summary": "Получить количество заказов", "description": "Возвращает количество заказов FBS в зависимости от указанных фильтров — например, по статусу, магазину и диапазону дат.", "operationId": "getOrderCountV2", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "shopIds", "description": "Массив идентификаторов магазинов.", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "status", "description": "Статус заказов, по которому нужно отфильтровать. По умолчанию — CREATED (создан).", "in": "query", "required": false, "schema": { "type": "string", "default": "CREATED", "enum": [ "CREATED", "PACKING", "PENDING_DELIVERY", "DELIVERING", "DELIVERED", "ACCEPTED_AT_DP", "DELIVERED_TO_CUSTOMER_DELIVERY_POINT", "COMPLETED", "CANCELED", "PENDING_CANCELLATION", "RETURNED" ] } }, { "name": "dateFrom", "description": "Начальная дата для фильтрации заказов.", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "dateTo", "description": "", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseLong" } } } }, "400": { "description": "seller-order-12 - dateTo is before dateFrom", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseLong" } } } } } } }, "/v1/fbs/order/{orderId}/labels/print": { "get": { "summary": "Получить этикетку для FBS заказа", "description": "Печатает этикетку для FBS заказа", "operationId": "fbsPrintLabel", "tags": [ "Работа с заказами FBS/DBS" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "size", "in": "query", "description": "Размер этикетки: LARGE (58x40mm) или BIG ( 43x25mm)", "required": true, "schema": { "type": "string", "default": "LARGE", "enum": [ "LARGE", "BIG" ] } } ], "responses": { "400": { "description": "Possible error codes:
\nseller-order-01 - Seller order not found,
\nseller-order-14 - Label service unavailable, try later,
\nseller-order-15 - Customer order identifiers are missing", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseSellerOrderLabelDto" } } } } } } }, "/v1/fbs/invoice": { "get": { "summary": "Получить все накладные для FBS заказа", "description": "Получить все накладные для FBS заказа", "operationId": "getFbsInvoices_1", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "statuses", "in": "query", "description": "Статус заказа", "required": true, "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FbsInvoiceStatus" } } }, { "name": "size", "in": "query", "description": "Кол-во записей на странице", "required": false, "schema": { "maximum": 20, "type": "integer", "format": "int32", "default": 20 } }, { "name": "page", "in": "query", "description": "Номер страницы", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseListFbsInvoiceDto" } } } }, "404": { "description": "fbs-invoice-01 - Накладная не найдена", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } }, "post": { "summary": "Создание накладной", "description": "Создание накладной", "operationId": "create", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" } } }, "required": true }, "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "400": { "description": "Коды ошибок:
\nseller-order-14 - Пункт приема Не найден
\nseller-order-23 - Таймслот недоступен
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseFbsInvoiceDto" } } } } } } }, "/v1/fbs/invoice/{invoiceId}": { "get": { "summary": "Получить накладную по идентифкатору", "description": "Return fbs invoice", "operationId": "getFbsInvoice_byId", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор накладной", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseFbsInvoiceDto" } } } }, "404": { "description": "fbs-invoice-01 - Накладная не найдена", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } } } } }, "/v1/fbs/invoice/{invoiceId}/orders": { "get": { "summary": "Получить FBS заказы по идентификатору накладной", "description": "Получить FBS заказы по идентификатору накладной", "operationId": "getFbsOrdersByInvoiceId", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор накладной", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseListFbsOrdersWithItemsDto" } } } } } } }, "/v1/fbs/invoice/{invoiceId}/closing-documents": { "get": { "summary": "Печать акта приемки", "description": "Печать акта приемки", "operationId": "getFbsInvoiceClosingDocuments", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "description": "Идентификатор накладной", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Коды ошибок:
\nseller-order-19 - Накладная не найдена
\nseller-order-16 - Неподходящий статус накладной
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseFbsInvoiceDocumentDto" } } } } } } }, "/v1/fbs/invoice/{invoiceId}/update-content": { "post": { "summary": "Изменение состава накладной", "description": "Изменение состава накладной", "operationId": "updateFbsInvoice", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContentInvoiceDto" } } }, "required": true }, "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "400": { "description": "Коды ошибок:
\nseller-order-23 - Таймслот недоступен
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Коды ошибок:
\nfbs-invoice-01 - Накладная не найдена
\nfbs-21-invoice-item-not-found - Позиция накладной не найдена
\nfbs-23-seller-order-status-wrong - Не найден заказ в таком статусе
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseUpdateResultDto" } } } } } } }, "/v1/fbs/invoice/{invoiceId}/cancel": { "post": { "summary": "Отмена накладной", "description": "Отмена накладной", "operationId": "fbsInvoiceCancel", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "description": "Идентификатор накладной", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "400": { "description": "Коды ошибок:
\nseller-order-23 - Таймслот недоступен
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "404": { "description": "Коды ошибок:
\nfbs-invoice-01 - Накладная не найдена
\n", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseCancelResultDto" } } } } } } }, "/v1/fbs/invoice/dop/time-slot": { "get": { "summary": "Возвращает доступные тайм-слоты от текущего времени до минимальной даты «доставить до» среди переданных заказов, где оставшаяся емкость >= количеству заказов в списке", "description": "Возвращает доступные тайм-слоты от текущего времени до минимальной даты «доставить до» среди переданных заказов, где оставшаяся емкость >= количеству заказов в списке", "operationId": "getFbsInvoiceTimeSlots", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "dopId", "in": "query", "description": "Идентификатор drop off point", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sellerOrderIds", "in": "query", "description": "Список идентификаторов заказов", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "400": { "description": "Коды ошибок:
\nseller-order-14 - Пункт приема Не найден
\nfbs-20-incompatible-dimensional-groups - Не совместимы габаритные группы
\nfbs-19-time-is-up - Время доставки вышло
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseTimeSlotListDto" } } } } } }, "post": { "summary": "Обновление пункта приема и таймслота", "description": "Обновление пункта приема и таймслота", "operationId": "updateDropOffPointAndTimeSlot", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" } } }, "required": true }, "responses": { "403": { "description": "fbs-2-seller-access-denied - У продавца нет доступа", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "400": { "description": "Коды ошибок:
\nseller-order-04 - Позиция накладной не найдена
\nseller-order-19 - Накладная не найдена
\nseller-order-23 - Таймслот недоступен
\n", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseFbsInvoiceDto" } } } } } } }, "/v1/fbs/invoice/dop/drop-off-points": { "get": { "summary": "Возвращаем доступные пункты приема подходящие по габаритным группам, у которых есть хотя бы один таймслот раньше чем самая ранняя дата \"доставить до\", с оставшейся емкостью больше чем кол-во заказов в списке", "description": "Возвращаем доступные пункты приема подходящие по габаритным группам, у которых есть хотя бы один таймслот раньше чем самая ранняя дата \"доставить до\", с оставшейся емкостью больше чем кол-во заказов в списке", "operationId": "getFbsInvoiceDropOffPoints", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "customerOrderIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "Accept-Language", "in": "header", "description": "Язык локализации. Поддерживаемые языки: ru, uz. По умолчанию: uz", "required": false, "schema": { "type": "string", "enum": [ "ru", "uz" ], "default": "uz" } } ], "responses": { "200": { "description": "Success", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseInvoiceDropOffPointDtoList" } } } } } } }, "/v1/fbs/invoice/{invoiceId}/print": { "get": { "summary": "Печать акта поставки", "description": "Печать акта поставки", "operationId": "printFbsInvoice", "tags": [ "FBS Invoice" ], "parameters": [ { "name": "invoiceId", "in": "path", "description": "Идентификатор акта поставки", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponseFbsInvoiceDocumentDto" } } } } } } }, "/v1/product/barcodes/types": { "get": { "summary": "Справочник размеров (типов) этикеток", "description": "Возвращает доступные размеры этикеток. Полученный id передаётся как barcodeTypeId при печати этикеток SKU.", "operationId": "getBarcodeTypes", "tags": [ "Product" ], "responses": { "200": { "description": "Список доступных типов этикеток", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BarcodeTypes" } } } } } } }, "/v1/product/shop/{shopId}/barcodes/print": { "post": { "summary": "Печать этикеток SKU", "description": "Возвращает PDF с этикетками для переданных SKU. Ограничения: не более 100 SKU и не более 100 штук каждого SKU. Доступные размеры — GET /v1/product/barcodes/types.", "operationId": "printProductBarcodes", "tags": [ "Product" ], "parameters": [ { "name": "shopId", "in": "path", "description": "Идентификатор магазина", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProductBarcodesRq" } } } }, "responses": { "400": { "description": "Ошибка валидации (больше 100 SKU или больше 100 штук каждого SKU)", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GenericResponse" } } } }, "200": { "description": "PDF с этикетками SKU", "headers": { "x-ratelimit-remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "x-ratelimit-replenish-rate": { "$ref": "#/components/headers/X-RateLimit-Replenish-Rate" }, "x-ratelimit-burst-capacity": { "$ref": "#/components/headers/X-RateLimit-Burst-Capacity" }, "x-ratelimit-requested-tokens": { "$ref": "#/components/headers/X-RateLimit-Requested-Tokens" }, "x-ratelimit-limit-per-day": { "$ref": "#/components/headers/X-RateLimit-Limit-Per-Day" }, "x-ratelimit-remaining-per-day": { "$ref": "#/components/headers/X-RateLimit-Remaining-Per-Day" } }, "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } } } } } }, "components": { "securitySchemes": { "TokenAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Токен авторизации без префикса Bearer" } }, "headers": { "X-RateLimit-Remaining": { "description": "Оставшееся количество запросов на ближайшую секунду", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Replenish-Rate": { "description": "Скорость пополнения лимита запросов", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Burst-Capacity": { "description": "Максимальное количество запросов, которые могут быть выполнены за одну секунду", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Requested-Tokens": { "description": "Количество токенов, запрашиваемых за текущий запрос", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Limit-Per-Day": { "description": "Лимит запросов в день", "schema": { "type": "integer", "format": "int32" } }, "X-RateLimit-Remaining-Per-Day": { "description": "Оставшееся количество запросов в день", "schema": { "type": "integer", "format": "int32" } } }, "schemas": { "ProductBarcodeGenerationData": { "type": "object", "required": [ "skuId", "amount", "barcodeTypeId" ], "properties": { "skuId": { "type": "integer", "format": "int64", "description": "Идентификатор SKU" }, "amount": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 100, "description": "Количество этикеток данного SKU (не более 100)" }, "barcodeTypeId": { "type": "integer", "format": "int64", "description": "Идентификатор размера этикетки из справочника /v1/product/barcodes/types" } } }, "GetProductBarcodesRq": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "minItems": 1, "maxItems": 100, "description": "Список SKU для печати (не более 100)", "items": { "$ref": "#/components/schemas/ProductBarcodeGenerationData" } } } }, "BarcodeType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор размера этикетки (используется как barcodeTypeId)" }, "title": { "type": "string", "description": "Название размера этикетки" }, "printType": { "type": "string", "description": "Тип печати" } } }, "BarcodeTypes": { "type": "object", "properties": { "barcodeLabelTypes": { "type": "array", "description": "Доступные размеры (типы) этикеток", "items": { "$ref": "#/components/schemas/BarcodeType" } } } }, "CancelResultDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор накладной", "format": "int64", "example": 100 } }, "description": "Результат отмены накладной" }, "GenericResponseCancelResultDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/CancelResultDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "CancelInvoiceDto": { "required": [ "invoiceId", "sellerId" ], "type": "object", "properties": { "sellerId": { "type": "integer", "description": "Идентификатор продавца", "format": "int64" }, "invoiceId": { "type": "integer", "description": "Идентификатор накладной", "format": "int64" } }, "description": "Идентификаторы для отмены накладной" }, "UpdateResultDto": { "required": [ "customerOrderId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ИД Накладной", "format": "int64", "example": 100 }, "customerOrderId": { "type": "integer", "description": "ИД заказа", "format": "int64", "example": 1001 } }, "description": "Результат изменения состава накладной" }, "GenericResponseUpdateResultDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/UpdateResultDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "UpdateContentInvoiceDto": { "required": [ "customerOrderId", "invoiceId", "sellerId" ], "type": "object", "properties": { "sellerId": { "type": "integer", "description": "ИД продавца", "format": "int64" }, "invoiceId": { "type": "integer", "description": "ИД накладной", "format": "int64" }, "customerOrderId": { "type": "integer", "description": "ИД заказа", "format": "int64" }, "idempotencyKey": { "type": "string", "description": "Ключ идемпотентности" } }, "description": "Идентификаторы для изменения состава накладной" }, "InvoiceRequest": { "required": [ "dropOffPointUuid", "orderIds", "sellerId", "timeSlotUuid" ], "type": "object", "properties": { "orderIds": { "type": "array", "description": "Список идентификаторов заказов", "items": { "type": "integer", "description": "Список идентификаторов заказов", "format": "int64" } }, "dropOffPointUuid": { "type": "string", "description": "Идентификатор пункта доставки", "format": "uuid" }, "timeSlotUuid": { "type": "string", "description": "Идентификатор слота времени", "format": "uuid" }, "sellerId": { "type": "integer", "description": "Идентификатор юридического лица", "format": "int64" }, "idempotencyKey": { "type": "string", "description": "Ключ идемпотентности" } }, "description": "Create fbs invoice request body" }, "FbsInvoiceDocumentDto": { "required": [ "document" ], "type": "object", "properties": { "document": { "type": "string", "description": "Накладная в pdf в Base64", "format": "byte" } }, "description": "Document" }, "GenericResponseFbsInvoiceDocumentDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/FbsInvoiceDocumentDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "TimeSlotListDto": { "type": "object", "properties": { "timeSlots": { "type": "array", "description": "Список тайм-слотов", "items": { "$ref": "#/components/schemas/TimeSlotDto" } } }, "description": "Полученные тайм-слоты" }, "GenericResponseTimeSlotListDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/TimeSlotListDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "LocalTime": { "type": "object", "properties": { "hour": { "type": "integer", "format": "int32" }, "minute": { "type": "integer", "format": "int32" }, "second": { "type": "integer", "format": "int32" }, "nano": { "type": "integer", "format": "int32" } } }, "DropOffType": { "type": "string", "description": "Тип пункта доставки", "example": "ISSUE_POINT", "enum": [ "UNKNOWN", "STOCK", "ISSUE_POINT", "UZ_POST", "UCELL", "NOT_UZUM", "PHOTO_STUDIO", "CROSS_DOCK", "DROP_OFF_POINT", "SORT_CENTER", "FRANCHISE" ] }, "WorkingTime": { "type": "object", "properties": { "open": { "$ref": "#/components/schemas/LocalTime" }, "close": { "$ref": "#/components/schemas/LocalTime" } }, "description": "Часы работы пункта выдачи возвратов", "example": { "open": "09:00", "close": "18:00" } }, "InvoiceDropOffPointDto": { "type": "object", "properties": { "dimensionalGroupIsLarge": { "type": "boolean", "description": "Признак, что габаритная группа является крупной", "example": true }, "workingHours": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/WorkingTime" }, "description": "Часы работы пункта приема для каждого дня недели (ключ — день недели)", "example": { "MONDAY": { "start": "09:00", "end": "18:00" }, "TUESDAY": { "start": "09:00", "end": "18:00" } } }, "latitude": { "type": "number", "description": "Широта пункта приема", "format": "double", "example": 40.712776 }, "longitude": { "type": "number", "description": "Долгота пункта приема", "format": "double", "example": -74.005974 }, "uuid": { "type": "string", "description": "Идентификатор пункта приема", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "address": { "type": "string", "description": "Адрес пункта приема", "example": "г. Ташкент, Сергелийский район, массив Куйлюк, ул. Ханабад 2/1" }, "type": { "$ref": "#/components/schemas/DropOffType" } }, "description": "Пункт приема" }, "InvoiceDropOffPointDtoList": { "type": "object", "properties": { "dropOffPoints": { "type": "array", "description": "Список пунктов приема", "items": { "$ref": "#/components/schemas/InvoiceDropOffPointDto" } } }, "description": "Подходящие пункты приема" }, "GenericResponseInvoiceDropOffPointDtoList": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/InvoiceDropOffPointDtoList" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "FbsInvoiceItemStatus": { "type": "string", "description": "Статус накладной", "enum": [ "NOT_ACCEPTED", "ACCEPTED", "IN_PROGRESS", "CANCELLED" ] }, "FbsInvoiceOrderItemDto": { "required": [ "amount", "barcode", "orderId", "price", "skuTitle", "title" ], "type": "object", "properties": { "orderId": { "type": "integer", "description": "Идентификатор заказа", "format": "int64" }, "barcode": { "type": "string", "description": "SKU баркод" }, "skuTitle": { "type": "string", "description": "Наименование SKU" }, "sellerSkuCode": { "type": "string", "description": "Идентификатор SKU селлера. Отсутствует, если селлер не задал код для этого SKU" }, "title": { "type": "string", "description": "Наименовани" }, "amount": { "type": "integer", "description": "Кол-во", "format": "int32" }, "price": { "type": "integer", "description": "Цена", "format": "int64" }, "skuId": { "type": "integer", "description": "идентификаторс SKU", "format": "int64" }, "photo": { "$ref": "#/components/schemas/PhotoDto" }, "status": { "$ref": "#/components/schemas/FbsInvoiceItemStatus" }, "deliverUntil": { "type": "string", "description": "Дата до которой селлер должен сдать заказ", "format": "date-time" } }, "description": "Список элементов заказов" }, "FbsOrdersWithItemsDto": { "required": [ "fullPrice", "items", "orderId" ], "type": "object", "properties": { "orderId": { "type": "integer", "description": "Накладная", "format": "int64" }, "fullPrice": { "type": "integer", "description": "Сумма заказа", "format": "int64" }, "items": { "type": "array", "description": "Список элементов заказов", "items": { "$ref": "#/components/schemas/FbsInvoiceOrderItemDto" } } }, "description": "Response payload" }, "GenericResponseListFbsOrdersWithItemsDto": { "type": "object", "properties": { "payload": { "type": "array", "description": "Response payload", "items": { "$ref": "#/components/schemas/FbsOrdersWithItemsDto" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "GenericResponseFbsInvoiceDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/FbsInvoiceDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "ColorizedTextContainerDtoFbsInvoiceStatus": { "type": "object", "properties": { "text": { "type": "string" }, "color": { "type": "string" }, "value": { "$ref": "#/components/schemas/FbsInvoiceStatus" } }, "description": "Статус" }, "FbsInvoiceEttnStatus": { "type": "string", "description": "Статус ЭТТН", "enum": [ "CREATED", "CORRECT", "INCORRECT", "ETTN_ID_VALID", "ETTN_ID_INVALID", "DELETED" ] }, "FbsInvoiceEttnDto": { "required": [ "ettnId", "isEditable", "status", "warningFlag" ], "type": "object", "properties": { "ettnId": { "type": "string", "description": "ЭТТН" }, "isEditable": { "type": "boolean", "description": "Возможность редактирования ЭТТН" }, "status": { "$ref": "#/components/schemas/FbsInvoiceEttnStatus" }, "slaEttnUpdate": { "type": "string", "description": "Время, до которого необходимо обновить ЭТТН", "format": "date-time" }, "warningFlag": { "type": "boolean", "description": "Флаг \"Осталось меньше 24 часов до начала таймслота\"" }, "lastUpdatedAt": { "type": "string", "description": "Время последнего обновления ЭТТН селлером", "format": "date-time" } }, "description": "ЭТТН" }, "FbsInvoiceDto": { "required": [ "acceptanceStartedDate", "acceptedDate", "acceptedPrice", "dateCreated", "dateUpdated", "dropOffPoint", "fullPrice", "id", "number", "numberAcceptedOrders", "numberOrders", "status", "stock", "timeSlot" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор накладной", "format": "int64" }, "number": { "type": "integer", "description": "Номер накладной, расчитывается по формуле: 120000000000 + идентификатор", "format": "int64" }, "status": { "$ref": "#/components/schemas/ColorizedTextContainerDtoFbsInvoiceStatus" }, "fullPrice": { "type": "integer", "description": "Сумма всех заказов", "format": "int64" }, "acceptedPrice": { "type": "integer", "description": "Сумма всех принятых заказов", "format": "int64" }, "numberOrders": { "type": "integer", "description": "Количество заказов", "format": "int64" }, "numberAcceptedOrders": { "type": "integer", "description": "Количество принятых заказов", "format": "int64" }, "stock": { "$ref": "#/components/schemas/StockDto" }, "dateCreated": { "type": "string", "description": "Дата создания", "format": "date-time" }, "dateUpdated": { "type": "string", "description": "Дата обновления", "format": "date-time" }, "acceptanceStartedDate": { "type": "string", "description": "Дата начала обработки на складе", "format": "date-time" }, "acceptedDate": { "type": "string", "description": "Дата принятия на складе", "format": "date-time" }, "timeSlot": { "$ref": "#/components/schemas/TimeSlotDto" }, "dropOffPoint": { "$ref": "#/components/schemas/DropOffPointShortDto" }, "ettn": { "$ref": "#/components/schemas/FbsInvoiceEttnDto" } }, "description": "Response payload" }, "GenericResponseListFbsInvoiceDto": { "type": "object", "properties": { "payload": { "type": "array", "description": "Response payload", "items": { "$ref": "#/components/schemas/FbsInvoiceDto" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "FbsInvoiceStatus": { "type": "string", "enum": [ "CREATED", "ACCEPTANCE_IN_PROGRESS", "CANCELLED", "ACCEPTED" ] }, "GenericResponseObject": { "type": "object", "properties": { "payload": { "type": "object", "description": "Данные ответа, содержит информацию об объекте, возвращаемом сервисом." }, "errors": { "type": "array", "description": "Список ошибок, если запрос не был успешно выполнен.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Время формирования ответа, формат даты и времени." }, "trace": { "type": "string", "description": "Трассировка для отладки ошибок." }, "error": { "type": "string", "description": "Сообщение об ошибке, если оно имеется.", "readOnly": true, "example": "null" } } }, "GenericResponseVoid": { "type": "object", "properties": { "payload": { "type": "object", "description": "Response payload" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "ApiErrorResponse": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Код ошибки, который может помочь в определении причины." }, "message": { "type": "string", "description": "Сообщение об ошибке, предназначенное для отображения пользователю." }, "detailMessage": { "type": "string", "deprecated": true, "description": "Более подробное сообщение об ошибке. Возможно, устарело и больше не используется." }, "payload": { "type": "object", "description": "Дополнительные данные, связанные с ошибкой." } } }, "AllProducts": { "type": "object", "properties": { "productList": { "type": "array", "description": "Список всех продуктов, доступных в магазине.", "items": { "$ref": "#/components/schemas/SellerProductCard" } }, "totalProductsAmount": { "type": "integer", "format": "int32", "description": "Общее количество доступных продуктов." } } }, "SellerProductCard": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор продукта." }, "category": { "type": "string", "description": "Категория, к которой принадлежит продукт." }, "rating": { "type": "string", "description": "Рейтинг продукта, выраженный числом или символом." }, "status": { "$ref": "#/components/schemas/ProductStatus" }, "moderationStatus": { "$ref": "#/components/schemas/ProductModerationStatus" }, "commission": { "type": "number", "description": "Процент комиссии за продажу продукта. Возможно устарело и заменено на 'commissionDto'.", "format": "double", "deprecated": true }, "commissionDto": { "$ref": "#/components/schemas/Commission" }, "skuList": { "type": "array", "description": "Список SKU, связанных с продуктом.", "items": { "$ref": "#/components/schemas/SkuForTable" } }, "skuTitle": { "type": "string", "description": "Название SKU продукта." }, "image": { "type": "string", "description": "URL изображения продукта." }, "previewImg": { "type": "string", "description": "URL предпросмотра изображения продукта." }, "title": { "type": "string", "description": "Название продукта." }, "quantityActive": { "type": "integer", "format": "int32", "description": "Количество активных единиц продукта на складе." }, "quantityFbs": { "type": "integer", "format": "int32", "description": "Количество единиц, доступных в режиме FBS (Fulfillment by Seller)." } } }, "Commission": { "type": "object", "description": "Детали комиссии, взимаемой за продукт, включая минимальную и максимальную ставку.", "properties": { "minCommission": { "type": "number", "format": "double", "description": "Минимальная ставка комиссии, взимаемая с продавца за продажу продукта." }, "maxCommission": { "type": "number", "format": "double", "description": "Максимальная ставка комиссии, взимаемая с продавца за продажу продукта." } } }, "VolumeDiscount": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор объема скидки." }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор продукта, на который распространяется скидка." }, "dateCreated": { "type": "string", "format": "date-time", "description": "Дата создания записи скидки." }, "dateUpdated": { "type": "string", "format": "date-time", "description": "Дата последнего обновления записи скидки." }, "dateStart": { "type": "string", "format": "date-time", "description": "Дата начала действия скидки." }, "active": { "type": "boolean", "description": "Показывает, активна ли скидка в настоящее время." }, "parameters": { "$ref": "#/components/schemas/VolumeDiscountParameters" } } }, "SkuForTable": { "type": "object", "properties": { "skuTitle": { "type": "string", "description": "Название SKU (единицы хранения) товара." }, "skuFullTitle": { "type": "string", "description": "Полное название SKU товара, включающее все детали." }, "productTitle": { "type": "string", "description": "Название продукта, к которому относится SKU." }, "skuId": { "type": "integer", "description": "Уникальный идентификатор SKU товара.", "format": "int64" }, "quantityCreated": { "type": "integer", "description": "Общее количество созданных единиц SKU.", "format": "int32" }, "quantityActive": { "type": "integer", "description": "Количество активных единиц SKU на складе.", "format": "int32" }, "quantityFbs": { "type": "integer", "description": "Количество единиц SKU, доступных в режиме FBS (Fulfillment by Seller).", "format": "int32" }, "quantityAdditional": { "type": "integer", "description": "Дополнительное количество SKU, которое может быть задействовано при необходимости.", "format": "int32" }, "quantityOnPhotoStudio": { "type": "integer", "description": "Количество SKU, находящихся в фотостудии для съемки.", "format": "int32" }, "quantityArchived": { "type": "integer", "description": "Количество архивированных SKU.", "format": "int32" }, "quantitySold": { "type": "integer", "description": "Общее количество проданных SKU.", "format": "int32" }, "quantityReturned": { "type": "integer", "description": "Количество возвращенных покупателем SKU.", "format": "int32" }, "quantityMissing": { "type": "integer", "description": "Количество недостающих SKU (параметр устарел).", "format": "int32" }, "quantityDefected": { "type": "integer", "description": "Количество дефектных SKU.", "format": "int32" }, "quantityPending": { "type": "integer", "description": "Количество SKU в ожидании обработки или отправки.", "format": "int32" }, "returnedPercentage": { "type": "number", "description": "Процент возвращенных SKU относительно общего количества проданных.", "format": "double" }, "barcode": { "type": "integer", "description": "Штрих-код SKU для идентификации.", "format": "int64" }, "archived": { "type": "boolean", "description": "Показывает, находится ли SKU в архиве." }, "commission": { "type": "number", "description": "Комиссия, связанная с продажей данного SKU.", "format": "double" }, "characteristics": { "type": "string", "description": "Описание характеристик SKU, может включать основные атрибуты." }, "purchasePrice": { "type": "integer", "description": "Цена закупки данного SKU.", "format": "int64" }, "price": { "type": "integer", "description": "Цена продажи SKU.", "format": "int64" }, "blockingReason": { "type": "string", "description": "Причина блокировки SKU, если оно заблокировано." }, "skuBlockReason": { "$ref": "#/components/schemas/SkuBlockReason" }, "blocked": { "type": "boolean", "description": "Показывает, заблокировано ли SKU." }, "rankInfo": { "$ref": "#/components/schemas/ProductRank" }, "article": { "type": "string", "description": "Артикул SKU, используемый для идентификации продукта продавцом." }, "turnover": { "type": "number", "description": "Оборот по данному SKU в денежном выражении.", "format": "double" }, "dimensionalGroup": { "type": "string", "description": "Габаритная группа SKU, указывающая его размер или вес." }, "paidStorageDimensionalGroup": { "description": "Габаритная группа для оплачиваемого хранения SKU.", "allOf": [ { "$ref": "#/components/schemas/DimensionalGroup" } ] }, "paidStoragePriceItem": { "type": "integer", "description": "Стоимость единицы хранения для SKU в оплачиваемом режиме.", "format": "int64" }, "paidStorageAmount": { "type": "integer", "description": "Общая стоимость хранения SKU в оплачиваемом режиме.", "format": "int64" }, "actualDimensionalGroup": { "description": "Фактическая габаритная группа SKU.", "allOf": [ { "$ref": "#/components/schemas/DimensionalGroup" } ] }, "hasStudioPhoto": { "type": "boolean", "description": "Показывает, есть ли у SKU студийное фото." }, "avgdsales": { "type": "number", "description": "Среднее количество продаж данного SKU в день.", "format": "double" }, "avgdquantity": { "type": "number", "description": "Среднее количество активных единиц SKU в день.", "format": "double" }, "pstorage": { "type": "boolean", "description": "Показывает, находится ли SKU на платном складе хранения." }, "previewImage": { "type": "string", "description": "Ссылка на фото превью товара" }, "ikpu": { "type": "string", "description": "Идентификационный код продукции и услуг для Узбекистана, представлен в виде набора символов (чисел)" }, "sellerItemCode": { "type": "string", "description": "Идентификатор селлера" } } }, "ProductRank": { "type": "object", "description": "Информация о ранге продукта, включая его позицию на рынке.", "properties": { "rank": { "type": "string", "description": "Ранг продукта, представляющий его классификацию по уровню популярности или качества.", "enum": [ "A", "B", "C", "N", "D" ] }, "rankValue": { "type": "string", "description": "Числовое значение ранга, характеризующее позицию продукта." }, "dateUpdated": { "type": "string", "description": "Дата последнего обновления информации о ранге.", "format": "date-time" } } }, "NewYearStatus": { "type": "object", "properties": { "title": { "type": "string", "description": "Название статуса на Новый Год, например, 'Подтверждено'." }, "color": { "type": "string", "description": "Цвет, связанный с новогодним статусом, например, 'зелёный' для подтвержденных продуктов." }, "value": { "type": "string", "description": "Значение новогоднего статуса, показывающее, подтвержден ли продукт на Новый Год.", "enum": [ "NONE", "CONFIRMED", "PROPOSED", "REJECTED" ] } } }, "ProductStatus": { "type": "object", "description": "Статус продукта, показывающий текущее состояние товара.", "properties": { "id": { "type": "integer", "format": "int32", "description": "Уникальный идентификатор статуса продукта." }, "title": { "type": "string", "description": "Название статуса продукта, например, 'Готов к отправке'." }, "value": { "type": "string", "enum": [ "NO_SKU", "IN_STOCK", "READY_TO_SEND", "SENT", "RUN_OUT", "BLOCKED", "SKU_BLOCKED", "ARCHIVED", "DELETED", "PERM_BANNED", "NOT_READY_TO_SEND" ], "description": "Значение статуса, указывающее текущее состояние продукта." }, "description": { "type": "string", "description": "Описание статуса, объясняющее его значение для продавца." }, "color": { "type": "string", "description": "Цвет, ассоциированный с данным статусом для визуальной индикации." }, "additional": { "type": "array", "description": "Дополнительные статусы продукта, например, временные состояния.", "items": { "$ref": "#/components/schemas/ProductAdditionalStatus" } } } }, "ProductAdditionalStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Уникальный идентификатор дополнительного статуса продукта." }, "title": { "type": "string", "description": "Название дополнительного статуса." }, "description": { "type": "string", "description": "Описание дополнительного статуса, объясняющее его значение." }, "color": { "type": "string", "description": "Цвет, ассоциированный с дополнительным статусом, для визуальной индикации." }, "icon": { "type": "string", "description": "Иконка, отображаемая для дополнительного статуса." } } }, "ProductModerationStatus": { "type": "object", "description": "Статус модерации, указывающий, прошел ли продукт проверку.", "properties": { "title": { "type": "string", "description": "Название статуса модерации, например, 'На модерации'." }, "color": { "type": "string", "description": "Цвет, связанный со статусом модерации, для визуального отображения." }, "value": { "type": "string", "enum": [ "NOT_MODERATED", "MODERATED", "ON_MODERATION", "HAS_COMPLAINTS", "ON_PREMODERATION", "PERM_BANNED" ], "description": "Значение статуса модерации, показывающее текущий этап модерации продукта." }, "hasAnySkuBlocked": { "type": "boolean", "description": "Показывает, был ли заблокирован какой-либо SKU из данного продукта." } } }, "VolumeDiscountParameters": { "type": "object", "description": "Параметры, определяющие правила объема скидки, включая тип и пороги скидок.", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "STEP", "SIMPLE_POLYNOMIAL", "SIMPLE_POLYNOMIAL_CONVEX" ], "description": "Тип скидки по объему, например, пошаговая (STEP) или полиномиальная (SIMPLE_POLYNOMIAL)." }, "maxAmount": { "type": "integer", "format": "int32", "description": "Максимальный объем для предоставления скидки." }, "minDiscount": { "type": "number", "format": "double", "description": "Минимальная скидка, применяемая при достижении определенного объема." }, "minAmount": { "type": "integer", "format": "int32", "description": "Минимальный объем для предоставления скидки." }, "maxDiscount": { "type": "number", "format": "double", "description": "Максимальная скидка, применяемая при достижении максимального объема." } }, "discriminator": { "propertyName": "type", "mapping": { "STEP": "#/components/schemas/StepVolumeDiscountParameters", "SIMPLE_POLYNOMIAL": "#/components/schemas/SimplePolynomialVolumeDiscountParameters", "SIMPLE_POLYNOMIAL_CONVEX": "#/components/schemas/SimplePolynomialVolumeDiscountParameters" } } }, "SimplePolynomialVolumeDiscountParameters": { "required": [ "degree", "maxAmount", "maxDiscount", "minAmount", "minDiscount", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/VolumeDiscountParameters" }, { "type": "object", "properties": { "degree": { "type": "number", "format": "double", "description": "Степень полинома, определяющая форму кривой скидки." }, "minAmount": { "type": "integer", "format": "int32", "description": "Минимальный объем для полиномиальной скидки, не менее 1." }, "maxAmount": { "type": "integer", "format": "int32", "description": "Максимальный объем для полиномиальной скидки, не менее 2." } } } ] }, "StepVolumeDiscountParameters": { "required": [ "steps", "type" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/VolumeDiscountParameters" }, { "type": "object", "properties": { "steps": { "type": "object", "description": "Шаги скидок, где ключами являются объемы, а значениями — проценты скидки.", "additionalProperties": { "type": "number", "format": "double" } } } } ] }, "SkuBlockReason": { "type": "object", "description": "Детали причины блокировки SKU, если оно заблокировано.", "properties": { "title": { "type": "string", "description": "Название причины блокировки SKU." }, "message": { "type": "string", "description": "Сообщение с деталями причины блокировки." }, "date": { "type": "string", "format": "date-time", "description": "Дата, когда SKU был заблокирован." } } }, "DimensionalGroup": { "type": "object", "properties": { "group": { "type": "string", "enum": [ "SMALL", "MEDIUM", "LARGE", "UNKNOWN" ], "description": "Категория размера товара, например, малая, средняя или большая." }, "title": { "type": "string", "description": "Название категории размера." } } }, "InvoiceInList": { "type": "object", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор накладной.", "format": "int64" }, "invoiceNumber": { "type": "integer", "description": "Номер накладной, используемый для идентификации.", "format": "int64" }, "deliveryCertificate": { "type": "string", "description": "Сертификат поставки, подтверждающий доставку." }, "dateCreated": { "type": "string", "description": "Дата создания накладной." }, "status": { "type": "string", "description": "Статус накладной (устарело, используйте invoiceStatus).", "deprecated": true }, "invoiceStatus": { "$ref": "#/components/schemas/InvoiceStatus" }, "fullPrice": { "type": "integer", "description": "Полная стоимость всех товаров в накладной.", "format": "int64" }, "timeSlotReservation": { "description": "Зарезервированный временной интервал для доставки или получения товаров по накладной.", "allOf": [ { "$ref": "#/components/schemas/TimeSlotReservation" } ] }, "totalAccepted": { "type": "integer", "description": "Общее количество товаров, принятых по накладной.", "format": "int32" }, "totalToStock": { "type": "integer", "description": "Общее количество товаров, которые должны быть добавлены на склад по накладной.", "format": "int32" }, "remainingAmountOfUpdates": { "type": "integer", "description": "Оставшееся количество возможных обновлений по накладной.", "format": "int32" }, "dateAccepted": { "type": "string", "description": "Дата, когда накладная была принята.", "format": "date-time" }, "expressAcceptanceDate": { "type": "string", "description": "Дата ускоренного принятия накладной, если применимо.", "format": "date-time" }, "stock": { "description": "Информация о складе, связанном с накладной.", "allOf": [ { "$ref": "#/components/schemas/Stock" } ] }, "externalNumber": { "type": "string", "description": "Внешний номер накладной, используемый для идентификации вне системы." } } }, "InvoiceStatus": { "type": "object", "description": "Статус накладной с более детальной информацией.", "properties": { "text": { "type": "string", "description": "Текстовое описание статуса накладной, например, 'В обработке'." }, "color": { "type": "string", "description": "Цвет, соответствующий текущему статусу накладной, для визуального отображения." }, "value": { "type": "string", "description": "Ключевое значение статуса, например, 'ACCEPTED' или 'PENDING'." } } }, "Stock": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор склада." }, "externalId": { "type": "string", "description": "Внешний идентификатор склада, используемый в других системах." }, "title": { "type": "string", "description": "Название склада." }, "address": { "type": "string", "description": "Адрес, по которому находится склад." }, "timeFrom": { "type": "string", "description": "Время начала работы склада." }, "timeTo": { "type": "string", "description": "Время окончания работы склада." }, "poolSource": { "type": "string", "description": "Источник складского пула, если применимо." }, "dimensionalGroups": { "type": "array", "description": "Список габаритных групп, которые склад поддерживает для хранения товаров.", "items": { "$ref": "#/components/schemas/DimensionalGroup" } } } }, "TimeSlotReservation": { "type": "object", "description": "Модель резервации временного интервала.", "properties": { "id": { "type": "integer", "description": "Идентификатор резервации.", "format": "int64", "example": 1 }, "timeSlots": { "type": "array", "description": "Reserved time slots", "items": { "$ref": "#/components/schemas/TimeSlot" } }, "status": { "type": "string", "description": "Статус резервации, например, 'RESERVED' или 'CANCELED'.", "example": "RESERVED", "enum": [ "RESERVED", "CANCELED" ] }, "timeFrom": { "type": "string", "format": "date-time", "description": "Начало зарезервированного временного интервала." }, "timeTo": { "type": "string", "format": "date-time", "description": "Окончание зарезервированного временного интервала." } } }, "TimeSlot": { "type": "object", "properties": { "timeFrom": { "type": "string", "description": "Модель временного слота.", "format": "date-time" }, "timeTo": { "type": "string", "description": "Конец временного слота.", "format": "date-time" } }, "description": "Модель временного слота." }, "SellerReturnLite": { "type": "object", "description": "Основная информация о возврате продавца.", "required": [ "externalNumber", "type" ], "properties": { "id": { "type": "integer", "description": "Идентификатор возврата.", "format": "int64" }, "dateCreated": { "type": "string", "description": "Дата создания возврата.", "format": "date-time" }, "status": { "type": "string", "description": "Статус возврата, например, 'COMPLETED' или 'PENDING'." }, "stock": { "description": "Информация о складе, на который возвращается товар.", "allOf": [ { "$ref": "#/components/schemas/Stock" } ] }, "timeSlotReservation": { "description": "Зарезервированный временной интервал для возврата.", "allOf": [ { "$ref": "#/components/schemas/TimeSlotReservation" } ] }, "paidStorage": { "$ref": "#/components/schemas/PaidStorageSellerReturn" }, "executionDate": { "type": "string", "description": "Дата исполнения возврата в зависимости от его статуса (COMPLETED, CANCELED и т.д.).", "format": "date-time" }, "assembledDate": { "type": "string", "description": "Дата сборки возврата.", "format": "date-time" }, "completedDate": { "type": "string", "description": "Дата завершения возврата, если он выполнен.", "format": "date-time" }, "canceledDate": { "type": "string", "description": "Дата отмены возврата, если он был отменен.", "format": "date-time" }, "externalNumber": { "type": "string", "description": "Электронный номер товаросопроводительного документа." }, "type": { "type": "string", "description": "Тип возврата: 'DEFECTED' для дефектного товара, 'RETURN' для обычного возврата, 'FBS' для доставки продавцом.", "enum": [ "DEFECTED", "RETURN", "FBS" ] } } }, "PaidStorageSellerReturn": { "type": "object", "description": "Информация об оплачиваемом хранении для возвращенного товара.", "required": [ "startDate", "status" ], "properties": { "startDate": { "type": "string", "description": "Дата начала платного хранения", "format": "date-time" }, "endDate": { "type": "string", "description": "Фактическая дата окончания платного хранения", "format": "date-time" }, "status": { "type": "string", "description": "Статус платного хранения, например, 'PENDING', 'ACTIVE', 'COMPLETED', или 'EXPIRED'.", "example": "PENDING", "enum": [ "PENDING", "ACTIVE", "COMPLETED", "EXPIRED" ] } } }, "SendPriceData": { "type": "object", "properties": { "productId": { "type": "integer", "format": "int64", "description": "Идентификатор продукта" }, "skuList": { "type": "array", "description": "Список SKU, связанных с ценой", "items": { "$ref": "#/components/schemas/NewPriceSku" } } } }, "NewPriceSku": { "required": [ "skuId" ], "type": "object", "properties": { "fullPrice": { "maximum": 999999000, "minimum": 1, "type": "integer", "format": "int64", "description": "Полная цена SKU" }, "sellPrice": { "maximum": 999999000, "minimum": 1, "type": "integer", "format": "int64", "description": "Цена продажи SKU" }, "skuId": { "type": "integer", "format": "int64", "description": "Идентификатор SKU" }, "skuTitle": { "type": "string", "description": "Название SKU" } } }, "FinanceOrderItemsDto": { "type": "object", "properties": { "orderItems": { "type": "array", "description": "Список элементов заказа для финансовых расчетов", "items": { "$ref": "#/components/schemas/FinanceItemEntity" } }, "totalElements": { "type": "integer", "format": "int32", "description": "Общее количество элементов" } } }, "FinanceItemEntity": { "type": "object", "description": "Базовый объект финансового элемента" }, "SellerOrderItemDto": { "allOf": [ { "$ref": "#/components/schemas/FinanceItemEntity" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Идентификатор элемента заказа" }, "status": { "type": "string", "enum": [ "TO_WITHDRAW", "PROCESSING", "CANCELED", "PARTIALLY_CANCELLED" ], "description": "Статус элемента заказа" }, "date": { "type": "integer", "format": "int64", "description": "Время в формате Unix Epoch в миллисекундах (пример: 1727427283895)" }, "orderId": { "type": "integer", "format": "int64", "description": "Идентификатор заказа" }, "skuTitle": { "type": "string", "description": "Название SKU" }, "sellerSkuCode": { "type": "string", "description": "Идентификатор SKU селлера. Отсутствует, если селлер не задал код для этого SKU" }, "productId": { "type": "integer", "format": "int64", "description": "Идентификатор продукта" }, "productImage": { "$ref": "#/components/schemas/ProductImageDto" }, "shopId": { "type": "integer", "description": "Идентификатор магазина", "format": "int64" }, "dateIssued": { "type": "integer", "description": "Время в формате Unix Epoch в миллисекундах (пример: 1727427283895)", "format": "int64" }, "sellerPrice": { "type": "integer", "description": "Цена продавца", "format": "int64" }, "amount": { "type": "integer", "description": "Количество" }, "amountReturns": { "type": "integer", "description": "Количество возвратов" }, "commission": { "type": "integer", "description": "Комиссия", "format": "int64" }, "sellerProfit": { "type": "integer", "description": "Прибыль продавца", "format": "int64" }, "purchasePrice": { "type": "integer", "description": "Цена закупки", "format": "int64" }, "logisticDeliveryFee": { "type": "integer", "description": "Стоимость логистики", "format": "int64" }, "cancelled": { "type": "integer", "description": "Количество отмен", "format": "int64" }, "withdrawnProfit": { "type": "integer", "description": "Прибыль после вычета", "format": "int64" }, "returnCause": { "type": "string", "description": "Причина возврата" }, "comment": { "type": "string", "description": "Комментарий" }, "skuCharValue": { "type": "string", "description": "Значение характеристики SKU" }, "skuCharTitle": { "type": "string", "description": "Название характеристики SKU" }, "productTitle": { "type": "string", "description": "Название продукта" } } } ] }, "ProductImageDto": { "type": "object", "description": "Изображение продукта", "properties": { "photo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PhotoDto" } }, "photoKey": { "type": "string", "description": "Уникальный ключ изображения" }, "color": { "type": "string", "description": "Цвет изображения, может быть null", "nullable": true }, "hasVerticalPhoto": { "type": "boolean", "description": "Имеет ли изображение вертикальную ориентацию" } } }, "PhotoDto": { "type": "object", "properties": { "high": { "type": "string", "format": "uri", "description": "URL высокого качества изображения" }, "low": { "type": "string", "format": "uri", "description": "URL низкого качества изображения" } } }, "ProductGroupedSellerItem": { "allOf": [ { "$ref": "#/components/schemas/FinanceItemEntity" }, { "type": "object", "properties": { "productId": { "type": "integer", "format": "int64", "description": "Идентификатор продукта" }, "shopId": { "type": "integer", "format": "int64", "description": "Идентификатор магазина" }, "productTitle": { "type": "string", "description": "Название продукта" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SkuGroupedSellerItemDto" }, "description": "Список элементов SKU, сгруппированных по продукту" } } } ] }, "SkuGroupedSellerItemDto": { "type": "object", "properties": { "skuTitle": { "type": "string", "description": "Название SKU" }, "skuId": { "type": "integer", "description": "Идентификатор SKU", "format": "int64" }, "productId": { "type": "integer", "description": "Идентификатор продукта", "format": "int64" }, "shopId": { "type": "integer", "description": "Идентификатор магазина", "format": "int64" }, "productTitle": { "type": "string", "description": "Название продукта" }, "image": { "$ref": "#/components/schemas/PhotoDto" }, "amount": { "type": "integer", "description": "Количество единиц продукта" }, "amountReturns": { "type": "integer", "description": "Количество возвратов" }, "characteristics": { "type": "array", "description": "Характеристики SKU", "items": { "type": "string" } }, "sellPrice": { "type": "integer", "format": "int64", "description": "Цена продажи SKU" }, "purchasePrice": { "type": "integer", "format": "int64", "description": "Цена закупки SKU" }, "sellerDiscountAmount": { "type": "integer", "description": "Сумма скидки продавца", "format": "int64" }, "sellerProfit": { "type": "integer", "description": "Прибыль продавца", "format": "int64" }, "commission": { "type": "integer", "description": "Комиссия за продажу", "format": "int64" }, "withdrawnProfit": { "type": "integer", "description": "Сумма изъятой прибыли", "format": "int64" }, "logisticDeliveryFee": { "type": "integer", "description": "Плата за логистику", "format": "int64" }, "returnCause": { "type": "string", "description": "Причина возврата товара" } } }, "GenericResponseSellerReturnDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/SellerReturnDto" }, "errors": { "type": "array", "description": "Список ошибок, возникших при выполнении запроса", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "description": "Метка времени, когда был сгенерирован ответ", "format": "date-time" }, "trace": { "type": "string", "description": "Информация для отладки" }, "error": { "type": "string", "description": "Сообщение об ошибке, если оно присутствует", "readOnly": true, "example": "null" } } }, "SellerReturnDto": { "type": "object", "description": "Содержит основные сведения о возврате продавца", "required": [ "countAllowedChange", "externalNumber", "maxCountAllowedChange", "totalAmount", "totalPackedAmount", "type" ], "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор возврата", "format": "int64" }, "dateCreated": { "type": "string", "description": "Дата создания возврата", "format": "date-time" }, "status": { "type": "string", "description": "Текущий статус возврата" }, "stock": { "description": "Сведения о складе, на который возвращается товар", "allOf": [ { "$ref": "#/components/schemas/StockDto" } ] }, "timeSlotReservation": { "description": "Зарезервированный временной интервал для возврата", "allOf": [ { "$ref": "#/components/schemas/TimeSlotReservationDto" } ] }, "paidStorage": { "description": "Информация о платном хранении для возврата", "allOf": [ { "$ref": "#/components/schemas/PaidStorageSellerReturnDto" } ] }, "executionDate": { "type": "string", "description": "Дата исполнения возврата в зависимости от его статуса (например, завершено или отменено)", "format": "date-time" }, "assembledDate": { "type": "string", "description": "Дата сборки возвращенного товара", "format": "date-time" }, "completedDate": { "type": "string", "description": "Дата завершения возврата", "format": "date-time" }, "canceledDate": { "type": "string", "description": "Дата отмены возврата", "format": "date-time" }, "externalNumber": { "type": "string", "description": "Электронный номер накладной на возврат" }, "type": { "type": "string", "description": "Тип возврата: 'FBS' - Fulfilled by Seller, 'DEFECTED' - Дефектный товар, 'RETURN' - Стандартный возврат", "enum": [ "DEFECTED", "RETURN", "FBS" ] }, "returnItems": { "type": "array", "description": "Список предметов, возвращенных по этому возврату", "uniqueItems": true, "items": { "$ref": "#/components/schemas/SellerReturnItemDto" } }, "totalAmount": { "type": "integer", "description": "Общее количество возвращенных товаров", "format": "int32" }, "totalPackedAmount": { "type": "integer", "description": "Общее количество упакованных товаров для возврата", "format": "int32" }, "countAllowedChange": { "type": "integer", "description": "Допустимое количество изменений временного интервала", "format": "int32" }, "maxCountAllowedChange": { "type": "integer", "description": "Максимальное количество разрешенных изменений временного интервала", "format": "int32" } } }, "StockDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор склада" }, "externalId": { "type": "string", "description": "Внешний идентификатор склада" }, "title": { "type": "string", "description": "Название склада" }, "address": { "type": "string", "description": "Адрес склада" }, "timeFrom": { "type": "string", "description": "Время начала работы склада" }, "timeTo": { "type": "string", "description": "Время окончания работы склада" }, "poolSource": { "type": "string", "description": "Источник складских запасов" }, "dimensionalGroups": { "type": "array", "description": "Список размерных групп, поддерживаемых складом", "items": { "$ref": "#/components/schemas/DimensionalGroupDto" } } } }, "DimensionalGroupDto": { "type": "object", "properties": { "group": { "type": "string", "enum": [ "SMALL", "MEDIUM", "LARGE", "UNKNOWN" ], "description": "Группа размеров: малый, средний, большой или неизвестный" }, "title": { "type": "string", "description": "Название размерной группы" } } }, "TimeSlotReservationDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор резервации временного интервала", "format": "int64", "example": 1 }, "timeSlots": { "type": "array", "description": "Зарезервированные временные интервалы", "items": { "$ref": "#/components/schemas/TimeSlotDto" } }, "status": { "type": "string", "description": "Статус резервации, например, RESERVED или CANCELED", "example": "RESERVED", "enum": [ "RESERVED", "CANCELED" ] }, "timeFrom": { "type": "string", "format": "date-time", "description": "Начало зарезервированного временного интервала" }, "timeTo": { "type": "string", "format": "date-time", "description": "Окончание зарезервированного временного интервала" } }, "description": "Модель для резервации временного интервала" }, "TimeSlotDto": { "type": "object", "properties": { "timeFrom": { "type": "string", "description": "Время начала временного интервала", "format": "date-time" }, "timeTo": { "type": "string", "description": "Время окончания временного интервала", "format": "date-time" } }, "description": "Модель временного интервала" }, "PaidStorageSellerReturnDto": { "required": [ "startDate", "status" ], "type": "object", "properties": { "startDate": { "type": "string", "description": "Дата начала платного хранения", "format": "date-time" }, "endDate": { "type": "string", "description": "Фактическая дата окончания платного хранения", "format": "date-time" }, "status": { "type": "string", "description": "Текущий статус платного хранения, например, PENDING, ACTIVE, COMPLETED, EXPIRED", "example": "PENDING", "enum": [ "PENDING", "ACTIVE", "COMPLETED", "EXPIRED" ] } }, "description": "Информация о платном хранении для возврата" }, "SellerReturnItemDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор элемента возврата" }, "skuId": { "type": "integer", "format": "int64", "description": "Идентификатор SKU" }, "amount": { "type": "integer", "format": "int32", "description": "Количество возвращаемых единиц" }, "packedAmount": { "type": "integer", "format": "int32", "description": "Количество упакованных единиц для возврата" }, "skuTitle": { "type": "string", "description": "Название SKU" }, "productTitle": { "type": "string", "description": "Название продукта" }, "purchasePrice": { "type": "integer", "format": "int64", "description": "Цена закупки единицы продукта" } } }, "ProductForInvoiceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор продукта для счета-фактуры" }, "skuTitle": { "type": "string", "description": "Название SKU продукта" }, "productTitle": { "type": "string", "description": "Название продукта" }, "quantityToStock": { "type": "integer", "format": "int32", "description": "Количество единиц на складе" }, "quantityAccepted": { "type": "integer", "format": "int32", "description": "Количество принятых единиц" }, "purchasePrice": { "type": "integer", "format": "int64", "description": "Цена закупки единицы продукта" }, "skuForInvoiceDtoList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SkuForInvoiceDto" }, "description": "Список SKU, связанных с продуктом для счета-фактуры" } } }, "SkuForInvoiceDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор SKU для счета-фактуры" }, "skuTitle": { "type": "string", "description": "Название SKU" }, "quantityToStock": { "type": "integer", "format": "int32", "description": "Количество SKU на складе" }, "quantityAccepted": { "type": "integer", "format": "int32", "description": "Количество принятых SKU" }, "purchasePrice": { "type": "integer", "format": "int64", "description": "Цена закупки SKU" } } }, "GenericResponseSellerFbsSkuStockUpdateDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/SellerFbsSkuStockUpdateDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "GenericResponseSellerFbsSkuStockUpdateDtoV2": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/SkuStockUpdateApiResponseDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "SkuStockUpdateApiResponseDto": { "type": "object", "properties": { "skuAmountList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SkuAmountApiResponseDto" } } } }, "SkuStockUpdateApiRequestDto": { "type": "object", "properties": { "skuAmountList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RestSellerSkuFbsAmountDto" } } } }, "SellerFbsSkuStockUpdateDto": { "type": "object", "properties": { "skuAmountList": { "maxItems": 2147483647, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RestSellerSkuFbsAmountDto" } } } }, "SkuAmountApiResponseDto": { "type": "object", "description": "REST реализация DTO по обновлению остатков FBS/DBS", "properties": { "skuId": { "type": "integer", "description": "skuId, для обновления необязательное поле", "format": "int64" }, "skuTitle": { "type": "string", "description": "skuTitle, для обновления необязательное поле" }, "productTitle": { "type": "string", "description": "productTitle, для обновления необязательное поле" }, "barcode": { "type": "string", "description": "ШК ску на стороне маркета, обязательное поле для обновления, должно быть уникальным" }, "amount": { "type": "integer", "description": "Остатки FBS для SKU", "format": "int32" }, "fbsAllowed": { "type": "boolean", "description": "Разрешено ли продавать по FBS" }, "dbsAllowed": { "type": "boolean", "description": "Разрешено ли продавать по DBS" }, "fbsLinked": { "type": "boolean", "description": "Привязка SKU к FBS схеме" }, "dbsLinked": { "type": "boolean", "description": "Привязка SKU к DBS схеме" }, "sellerSkuCode": { "type": "string", "description": "для обновления необязательное поле, идентификатор СКУ селлера" } } }, "SkuAmountApiRequestDto": { "type": "object", "description": "REST реализация DTO по обновлению остатков FBS", "required": [ "amount", "barcode" ], "properties": { "skuId": { "type": "integer", "description": "skuId, для обновления необязательное поле", "format": "int64" }, "skuTitle": { "type": "string", "description": "skuTitle, для обновления необязательное поле" }, "productTitle": { "type": "string", "description": "productTitle, для обновления необязательное поле" }, "barcode": { "type": "string", "description": "ШК ску на стороне маркета, обязательное поле для обновления, должно быть уникальным" }, "amount": { "type": "integer", "description": "Остатки FBS для SKU", "format": "int32" }, "barcodeLong": { "type": "integer", "format": "int64" } } }, "RestSellerSkuFbsAmountDto": { "type": "object", "description": "REST реализация DTO по обновлению остатков FBS и DBS", "required": [ "amount", "barcode", "amount" ], "properties": { "skuId": { "type": "integer", "description": "skuId, для обновления необязательное поле", "format": "int64" }, "skuTitle": { "type": "string", "description": "skuTitle, для обновления необязательное поле" }, "productTitle": { "type": "string", "description": "productTitle, для обновления необязательное поле" }, "barcode": { "type": "string", "description": "ШК ску на стороне маркета, обязательное поле для обновления, должно быть уникальным" }, "amount": { "type": "integer", "description": "Остатки FBS для SKU", "format": "int32" }, "fbsLinked": { "type": "boolean", "description": "Привязка SKU к FBS схеме" }, "dbsLinked": { "type": "boolean", "description": "Привязка SKU к DBS схеме" } } }, "GenericResponseSellerOrdersDto": { "type": "object", "description": "Общий ответ, содержащий информацию о заказах продавца.", "properties": { "payload": { "$ref": "#/components/schemas/SellerOrdersDto" }, "errors": { "type": "array", "description": "Список ошибок, возникших при обработке запроса.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Метка времени ответа." }, "trace": { "type": "string", "description": "Трассировочная информация для отладки." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Описание ошибки, если она произошла." } } }, "SellerOrdersDto": { "type": "object", "description": "Информация о заказах продавца.", "properties": { "orders": { "type": "array", "description": "Список заказов.", "items": { "$ref": "#/components/schemas/SellerOrderDto" } }, "totalAmount": { "type": "integer", "description": "Общее количество заказов.", "format": "int64" } } }, "SellerOrderDto": { "type": "object", "description": "Подробная информация о заказе продавца.", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор заказа.", "format": "int64" }, "status": { "type": "string", "description": "Статус заказа.", "enum": [ "CREATED", "PACKING", "DELIVERED", "DELIVERED_TO_CUSTOMER_DELIVERY_POINT", "COMPLETED", "CANCELED", "PENDING_CANCELLATION", "RETURNED" ] }, "dateCreated": { "type": "string", "description": "Дата создания заказа.", "format": "date-time" }, "acceptUntil": { "type": "string", "description": "Дата, до которой заказ может быть принят.", "format": "date-time" }, "deliverUntil": { "type": "string", "description": "Дата, до которой заказ должен быть доставлен.", "format": "date-time" }, "deliveringDate": { "type": "string", "description": "Дата перехода заказа в статус DELIVERING", "format": "date-time" }, "deliveryDate": { "type": "string", "description": "Дата фактической доставки заказа.", "format": "date-time" }, "acceptedDate": { "type": "string", "description": "Дата принятия заказа продавцом.", "format": "date-time" }, "deliveredToDeliveryPointDate": { "type": "string", "description": "Дата доставки заказа в пункт доставки.", "format": "date-time" }, "completedDate": { "type": "string", "description": "Дата завершения заказа.", "format": "date-time" }, "dateCancelled": { "type": "string", "description": "Дата отмены заказа.", "format": "date-time" }, "returnDate": { "type": "string", "description": "Дата возврата заказа.", "format": "date-time" }, "cancelReason": { "type": "string", "description": "Причина отмены заказа." }, "identifierRequired": { "type": "boolean", "description": "Требуется ли идентификатор для обработки заказа." }, "price": { "type": "integer", "description": "Стоимость заказа.", "format": "int64" }, "shopId": { "type": "integer", "description": "Идентификатор магазина, связанного с заказом.", "format": "int64" }, "stock": { "description": "Информация о складе, связанном с заказом.", "allOf": [ { "$ref": "#/components/schemas/StockDto" } ] }, "orderItems": { "type": "array", "description": "Список товаров в заказе.", "items": { "$ref": "#/components/schemas/SellerOrderItemDto" } }, "place": { "type": "string", "description": "Информация о месте обработки заказа." }, "invoiceNumber": { "type": "integer", "description": "Номер накладной", "format": "int64" }, "timeSlot": { "$ref": "#/components/schemas/TimeSlotDto", "description": "Интервал времени, выделенный для отгрузки заказа." }, "dropOffPoint": { "$ref": "#/components/schemas/DropOffPointShortDto", "description": "Краткая информация о пункте сдачи заказа." }, "scheme": { "type": "string", "description": "Тип заказа", "enum": [ "FBS", "DBS", "FBO" ] }, "deliveryInfo": { "$ref": "#/components/schemas/SellerOrderDeliveryInfoDto", "description": "Информация о доставке заказа." } } }, "DropOffPointShortDto": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Идентификатор пункта приема", "format": "uuid", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "address": { "type": "string", "description": "Адрес пункта приема", "example": "г. Ташкент, Сергелийский район, массив Куйлюк, ул. Ханабад 2/1" }, "type": { "type": "string", "description": "Тип пункта доставки", "example": "ISSUE_POINT", "enum": [ "UNKNOWN", "STOCK", "ISSUE_POINT", "UZ_POST", "UCELL", "NOT_UZUM", "PHOTO_STUDIO", "CROSS_DOCK", "DROP_OFF_POINT", "SORT_CENTER" ] } }, "description": "Пункт приема" }, "SellerOrderDeliveryInfoDto": { "required": [ "customerFullname", "customerPhone", "deliveryAddress" ], "type": "object", "properties": { "deliveryAddress": { "type": "string", "description": "Адрес покупателя" }, "customerFullname": { "type": "string", "description": "ФИО покупателя" }, "customerPhone": { "type": "string", "description": "Номер телефона покупателя" }, "deliveryComment": { "type": "string", "description": "Комментарий покупателя" } }, "description": "Данные о доставке заказа" }, "GenericResponseSellerOrderDto": { "type": "object", "description": "Общий ответ, содержащий информацию о конкретном заказе продавца.", "properties": { "payload": { "$ref": "#/components/schemas/SellerOrderDto" }, "errors": { "type": "array", "description": "Список ошибок.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Метка времени ответа." }, "trace": { "type": "string", "description": "Трассировочная информация для отладки." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Описание ошибки, если она произошла." } } }, "SellerOrderCancelRq": { "type": "object", "description": "Запрос для отмены заказа.", "required": [ "reason" ], "properties": { "reason": { "type": "string", "description": "Причина отмены заказа.", "enum": [ "OUT_OF_STOCK", "OUT_OF_PACKAGE", "OUT_OF_TIME", "OTHER", "ACCEPTANCE_TIME_EXPIRED", "DELIVERY_TIME_EXPIRED", "RETURNED_BY_CUSTOMER", "CANCELED_BY_CUSTOMER", "MARKET_REASON" ] }, "comment": { "type": "string", "description": "Комментарий к отмене заказа." } } }, "UpdateOrderIdentifiersRq": { "type": "object", "description": "Запрос на пакетную привязку идентификаторов к позициям заказа.", "required": [ "items" ], "properties": { "items": { "type": "array", "description": "Список позиций заказа с привязываемыми идентификаторами. Не должен быть пустым; позиции не должны повторяться.", "items": { "$ref": "#/components/schemas/UpdateIdentifierRq" } } } }, "UpdateIdentifierRq": { "type": "object", "description": "Привязка набора идентификаторов к одной позиции заказа.", "required": [ "orderItemId" ], "properties": { "orderItemId": { "type": "integer", "format": "int64", "description": "Идентификатор позиции заказа." }, "values": { "type": "array", "description": "Список значений идентификаторов. Значения не должны повторяться.", "items": { "type": "string" } } } }, "IdentifierInfo": { "type": "object", "description": "Информация об идентификаторах позиции заказа.", "properties": { "type": { "type": "string", "description": "Тип идентификатора (IMEI, ASL_BELGISI)." }, "required": { "type": "boolean", "description": "Обязателен ли идентификатор для данной позиции." }, "values": { "type": "array", "description": "Привязанные значения идентификаторов.", "items": { "type": "string" } } } }, "GenericResponseListIdentifierInfo": { "type": "object", "description": "Общий ответ со списком информации об идентификаторах позиций заказа.", "properties": { "payload": { "type": "array", "description": "Список информации об идентификаторах по позициям заказа.", "items": { "$ref": "#/components/schemas/IdentifierInfo" } }, "errors": { "type": "array", "description": "Список ошибок.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Метка времени ответа." }, "trace": { "type": "string", "description": "Трассировочная информация для отладки." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Описание ошибки, если она произошла." } } }, "GenericResponseReturnReasonsDto": { "type": "object", "description": "Общий ответ с информацией о причинах возврата.", "properties": { "payload": { "$ref": "#/components/schemas/ReturnReasonsDto" }, "errors": { "type": "array", "description": "Список ошибок.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Метка времени ответа." }, "trace": { "type": "string", "description": "Трассировочная информация для отладки." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Описание ошибки, если она произошла." } } }, "ReturnReasonsDto": { "type": "object", "description": "Список причин возврата.", "properties": { "reasons": { "type": "array", "description": "Список причин возврата.", "items": { "$ref": "#/components/schemas/ReturnReasonDto" } } } }, "ReturnReasonDto": { "description": "Детальная информация о причине возврата.", "type": "object", "properties": { "reason": { "type": "string", "description": "Причина возврата.", "enum": [ "OUT_OF_STOCK", "OUT_OF_PACKAGE", "OUT_OF_TIME", "OTHER", "ACCEPTANCE_TIME_EXPIRED", "DELIVERY_TIME_EXPIRED", "RETURNED_BY_CUSTOMER", "CANCELED_BY_CUSTOMER", "MARKET_REASON" ] } } }, "OrganizationDto": { "type": "object", "description": "Информация по магазину", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор магазина", "format": "int64" }, "name": { "type": "string", "description": "Название магазина" } } }, "GenericResponseSellerPaymentInfoDtoList": { "type": "object", "description": "Список информации о платежах продавца.", "properties": { "payload": { "$ref": "#/components/schemas/SellerPaymentInfoDtoList" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" }, "description": "Список ошибок, возникших во время обработки запроса." }, "timestamp": { "type": "string", "format": "date-time", "description": "Временная метка, указывающая время выполнения запроса." }, "trace": { "type": "string", "description": "Идентификатор трассировки для отладки." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Код ошибки, если запрос завершился с ошибкой." } } }, "SellerPaymentInfoDtoList": { "type": "object", "description": "Список информации о платежах продавца.", "properties": { "payments": { "type": "array", "items": { "$ref": "#/components/schemas/SellerPaymentDto" }, "description": "Массив объектов, содержащих данные о платежах продавца." } } }, "SellerPaymentDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "Уникальный идентификатор платежа." }, "dateCreated": { "type": "string", "format": "date-time", "description": "Дата и время создания записи о платеже." }, "dateUpdated": { "type": "string", "format": "date-time", "description": "Дата и время последнего обновления записи о платеже." }, "name": { "type": "string", "description": "Название платежа или его описание." }, "source": { "type": "string", "description": "Источник, из которого был инициирован платеж." }, "shopId": { "type": "integer", "format": "int64", "description": "Идентификатор магазина, связанного с платежом." }, "sellerId": { "type": "integer", "format": "int64", "description": "Идентификатор продавца, связанного с платежом." }, "paymentPrice": { "type": "integer", "format": "int64", "description": "Сумма платежа." }, "amount": { "type": "integer", "format": "int32", "description": "Количество единиц, связанных с платежом." }, "status": { "type": "string", "description": "Статус платежа: CREATED - создан, REFUNDED - возвращен, CONFIRMED - подтвержден, CANCELED - отменен.", "enum": [ "CREATED", "REFUNDED", "CONFIRMED", "CANCELED" ] }, "externalId": { "type": "string", "description": "Внешний идентификатор платежа." }, "code": { "type": "string", "description": "Код, связанный с платежом." }, "dateService": { "type": "string", "format": "date-time", "description": "Дата и время оказания услуги, связанной с платежом." }, "type": { "type": "string", "description": "Тип платежа: OUTCOME - исходящий платеж, INCOME - входящий платеж.", "enum": [ "OUTCOME", "INCOME" ] } } }, "InvoiceWithSkuListDto": { "type": "object", "description": "Схема, представляющая накладную с товарами (SKU).", "properties": { "id": { "type": "integer", "description": "Уникальный идентификатор накладной.", "format": "int64" }, "shopId": { "type": "integer", "description": "Идентификатор магазина, связанного с накладной.", "format": "int64" }, "shopTitle": { "type": "string", "description": "Название магазина, связанного с накладной." }, "invoiceNumber": { "type": "integer", "description": "Номер накладной.", "format": "int64" }, "deliveryCertificate": { "type": "string", "description": "Документ подтверждающий доставку." }, "dateCreated": { "type": "string", "description": "Дата создания накладной." }, "status": { "type": "string", "description": "Старый статус накладной (устаревший, используйте invoiceStatus).", "deprecated": true }, "invoiceStatus": { "description": "Текущий статус накладной.", "allOf": [ { "$ref": "#/components/schemas/InvoiceStatus" } ] }, "fullPrice": { "type": "integer", "description": "Полная стоимость накладной.", "format": "int64" }, "timeSlotReservation": { "description": "Информация о зарезервированном временном интервале для доставки/приемки.", "allOf": [ { "$ref": "#/components/schemas/TimeSlotReservationDto" } ] }, "totalAccepted": { "type": "integer", "description": "Общее количество товаров, принятых по накладной.", "format": "int32" }, "totalToStock": { "type": "integer", "description": "Общее количество товаров, которые должны быть добавлены на склад.", "format": "int32" }, "remainingAmountOfUpdates": { "type": "integer", "description": "Количество оставшихся возможных обновлений накладной.", "format": "int32" }, "dateAccepted": { "type": "string", "description": "Дата, когда накладная была принята.", "format": "date-time" }, "expressAcceptanceDate": { "type": "string", "description": "Дата и время экспресс-приемки накладной.", "format": "date-time" }, "stock": { "description": "Информация о складе, связанная с накладной.", "allOf": [ { "$ref": "#/components/schemas/StockDto" } ] }, "externalNumber": { "type": "string", "description": "Внешний номер накладной (если применимо)." }, "productForInvoiceDto": { "type": "array", "description": "Список товаров, включенных в накладную.", "items": { "$ref": "#/components/schemas/ProductForInvoiceDto" } } } }, "GenericResponseLong": { "type": "object", "description": "Общий формат ответа, содержащий числовое значение (тип long) в качестве полезной нагрузки.", "properties": { "payload": { "type": "integer", "format": "int64", "description": "Полезная нагрузка ответа — числовое значение типа long." }, "errors": { "type": "array", "description": "Массив ошибок, возникших при выполнении запроса.", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Дата и время формирования ответа, в формате ISO 8601." }, "trace": { "type": "string", "description": "Трассировочный идентификатор запроса, полезен для отладки и логирования." }, "error": { "type": "string", "readOnly": true, "example": "null", "description": "Краткое описание ошибки, если она произошла. Если значение равно null — значит ошибка не возникла." } } }, "GenericResponseSellerOrderLabelDto": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/SellerOrderLabelDto" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } }, "SellerOrderLabelDto": { "required": [ "document" ], "type": "object", "properties": { "document": { "type": "array", "description": "PDF этикетки FBS заказа в Base64 строке", "items": { "type": "string", "description": "PDF этикетки FBS заказа в Base64 строке", "format": "byte" } } }, "description": "DTO этикетки FBS заказа" }, "GenericResponse": { "type": "object", "properties": { "payload": { "type": "object", "description": "Response payload" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorResponse" } }, "timestamp": { "type": "string", "format": "date-time" }, "trace": { "type": "string" }, "error": { "type": "string", "readOnly": true, "example": "null" } } } } } }