{ "openapi": "3.0.0", "info": { "title": "Fashion House Documentation", "description": "Documentation on the description of API methods for the Fashion House project version 2.0. Authorization in this version of the api is carried out through the Barer token, the token itself must be formed on the front of the part, the backend further binds the session to the transferred token.", "version": "2.0.0" }, "servers": [ { "url": "http://localhost/api/v2", "description": "Server" }, { "url": "http://localhost/api/v2", "description": "Localhost" } ], "paths": { "/brands": { "get": { "tags": [ "FavoriteBrands" ], "summary": "Brands resource list", "description": "Get all active brands", "operationId": "3458f72e35a72e43384af9cfdb271ba5", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/catalog": { "get": { "tags": [ "Catalog" ], "description": "Get catalog products", "operationId": "4d477c7ec28f52c49fe0b927f37a273b", "parameters": [ { "name": "hash", "in": "query", "description": "Menu hash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "blocks": { "type": "array", "items": {} }, "data": { "type": "array", "items": {} }, "meta": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/catalog/filters": { "get": { "tags": [ "Catalog" ], "description": "Get catalog filters", "operationId": "e7fb85e043db9b169e7ce1d0a4566b36", "parameters": [ { "name": "hash", "in": "query", "description": "Menu hash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/catalog/search": { "get": { "tags": [ "Catalog" ], "description": "Search in catalog", "operationId": "5cf447b582d33ba605a9754c2ee4b585", "parameters": [ { "name": "barcode", "in": "query", "description": "Product barcode", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} }, "meta": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/card": { "get": { "tags": [ "Client" ], "summary": "get client cards", "description": "Get client cards", "operationId": "getClientCards", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "$ref": "#/components/schemas/ClientCardResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/card/{card}": { "delete": { "tags": [ "Client" ], "summary": "Delete client card", "description": "Delete client card", "operationId": "deleteClientCard", "parameters": [ { "name": "id", "in": "path", "description": "card id", "required": true, "schema": { "type": "integer", "format": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "The client card successful deleted." } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] }, "patch": { "tags": [ "Client" ], "summary": "Update client card", "description": "Update client card", "operationId": "updateClientCard", "parameters": [ { "name": "card", "in": "path", "description": "card id", "required": true, "schema": { "type": "integer", "format": "integer", "example": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientCardRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Card successful updated" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed update card" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized" } }, "type": "object" } } } }, "404": { "description": "Client card not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Client card not found." } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/order": { "post": { "tags": [ "Client" ], "summary": "Client client orders", "description": "Client client orders", "operationId": "getClientOrders", "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/order/show": { "get": { "tags": [ "Client" ], "summary": "Client client order", "description": "Client client order", "operationId": "getClientOrderShow", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/order/products": { "get": { "tags": [ "Client" ], "summary": "Client client orders products", "description": "Client client orders products", "operationId": "getClientOrdersProducts", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile": { "post": { "tags": [ "Client" ], "summary": "update client profile", "description": "Update client", "operationId": "updateClientProfil", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientProfileRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile/order-history": { "post": { "tags": [ "Client" ], "summary": "Client order-history", "description": "Update client", "operationId": "orderHistory", "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile/discount": { "post": { "tags": [ "Client" ], "summary": "Get and update clinet discount", "description": "Get and update clinet discount", "operationId": "dbd2a737eeb9adb20f57d18779902f22", "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile/subscriptions": { "post": { "tags": [ "Client" ], "summary": "Client subscriptions", "description": "Client subscriptions", "operationId": "0c7ed9e8b21064fc06dff5e67491e86a", "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/email-verify": { "post": { "tags": [ "Services" ], "description": "Email verifying method", "operationId": "27e863862cd323d1bcf641369fcf0d9d", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/is-email-verify-by-phone": { "get": { "tags": [ "Service" ], "description": "Get email verify info by phone", "operationId": "cf321c6b713d7141b14736583889eb63", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/client/verify-email-by-phone": { "post": { "tags": [ "Services" ], "description": "Verify email by phone", "operationId": "2d159909fecacbc81e3490e56fbede01", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile/wallet": { "get": { "tags": [ "Client" ], "summary": "Apple wallet loyalty card", "description": "Get apple wallet loyalty card", "operationId": "6f8ea3bbffb4e92c5a0c52ec37da4099", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/profile/params": { "get": { "tags": [ "Client" ], "summary": "Apple wallet loyalty card", "description": "Get apple wallet loyalty card", "operationId": "f3d915569bad53e58f41a234ffb96f9d", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/refund": { "post": { "tags": [ "Client" ], "summary": "Client client refunds", "description": "Client client refunds", "operationId": "getClientRefunds", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/client/refund/show": { "get": { "tags": [ "Client" ], "summary": "Client refund", "description": "Client refund", "operationId": "getClientOrder", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "client": { "$ref": "#/components/schemas/ClientResource" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/delivery/slots": { "post": { "tags": [ "Delivery" ], "summary": "Delivery slots list", "description": "Get all delivery slots", "operationId": "getDeliverySlots", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySlotsRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "format": "string", "example": "success" }, "desired_dates": { "type": "array", "items": { "properties": { "day": { "type": "string", "format": "string", "example": "28 января" }, "day_of_week": { "type": "string", "format": "string", "example": "пятница" }, "times": { "type": "array", "format": "array", "items": { "type": "string", "example": "10:00 - 11:00, 12:00 - 13:00" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/delivery/near": { "post": { "tags": [ "Delivery" ], "summary": "Near delivery date by product", "description": "Near delivery date by product", "operationId": "6ddd600655d5f744cb7a787eb63f5e75", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySlotsRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "format": "string", "example": "success" } }, "type": "object" } } } }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/delivery/countries": { "get": { "tags": [ "Batch" ], "summary": "Response delivery countries list", "description": "Response delivery countries list.", "operationId": "29ed0239efa50f5726f05e314d0fdab0", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "delivery countries not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/batch/{batchId}": { "get": { "tags": [ "Batch" ], "summary": "Batch resource info", "description": "Return batch entity", "operationId": "batchInfo", "parameters": [ { "name": "batchId", "in": "path", "description": "batch uuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/BatchResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Batch not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "batch not found" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] }, "delete": { "tags": [ "Batch" ], "summary": "Cancel batch", "description": "Cancel batch. Return batch entity", "operationId": "cancelBatch", "parameters": [ { "name": "batchId", "in": "path", "description": "batch uuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/BatchResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Batch not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Batch not found" } } }, "type": "object" } } } }, "422": { "description": "The batch was already finished", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "The batch was already finished" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/batch/{batchId}/resolve": { "get": { "tags": [ "Batch" ], "summary": "Resolve batch", "description": "Resolve batch. Return batch entity", "operationId": "batchResolve", "parameters": [ { "name": "batchId", "in": "path", "description": "batch uuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "array", "items": { "$ref": "#/components/schemas/BatchResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Batch not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "batch not found" } } }, "type": "object" } } } }, "422": { "description": "the batch has amount of not finished jobs", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "the batch has 12 not finished jobs" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/import/product": { "post": { "tags": [ "Import products" ], "summary": "create import batch and start import product", "description": "Import products", "operationId": "createImportBatch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProductRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "properties": { "batchId": { "type": "uuid", "example": "94bf8e7c-7acf-4ec1-87d1-73725b5e4ee0" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/import/product/{batchId}": { "post": { "tags": [ "Import products" ], "summary": "create import batch and start import product", "description": "Import products", "operationId": "appendToExistingImportBatch", "parameters": [ { "name": "batchId", "in": "path", "description": "batch id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProductRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "properties": { "batchId": { "type": "uuid", "example": "94bf8e7c-7acf-4ec1-87d1-73725b5e4ee0" } }, "type": "object" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/exchange/reports/retailcrm-clients": { "post": { "tags": [ "ExchangeReports" ], "description": "Get clients from retailcrm", "operationId": "77dba511cd3b83f5c0d94afab2d9c247", "responses": { "200": { "description": "Success" }, "403": { "description": "Unauthorized action" } }, "security": [ { "apiAuth": [] } ] } }, "/api/v2/exchange/reports/prices": { "get": { "tags": [ "Цены" ], "summary": "Получить список цен", "operationId": "f48c08c960de5a6d15f4423dd771c7ff", "parameters": [ { "name": "date", "in": "query", "description": "Дата обновления (в формате YYYY-MM-DD)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "name", "in": "query", "description": "Название домена", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Успешный ответ", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "external_id": { "type": "integer", "example": 123 }, "last_updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01 12:34:56" }, "price": { "type": "number", "format": "float", "example": 100.5 }, "first_price": { "type": "number", "format": "float", "example": 120.75 }, "page_url": { "type": "string", "example": "https://example.com/page" }, "url": { "type": "string", "example": "https://example.com/item" }, "sku": { "type": "string", "example": "ABC123" } }, "type": "object" } } } } }, "400": { "description": "Некорректный запрос (отсутствует параметр или неверный формат)" }, "500": { "description": "Внутренняя ошибка сервера" } } } }, "/exchange/import/reset_stock": { "post": { "tags": [ "ExchangeReports" ], "description": "Reset stock", "operationId": "3ed054be1cfeaf39a0a6c94bf6aa701e", "responses": { "200": { "description": "Success" }, "403": { "description": "Unauthorized action" } }, "security": [ { "apiAuth": [] } ] } }, "/favorite-brands": { "get": { "tags": [ "FavoriteBrands" ], "summary": "Favorite brands resource list", "description": "Get all favorite brands by session id", "operationId": "8672979a99fcfb9f52d9ed7df8d498b1", "responses": { "200": { "description": "Successful operation" }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/api/v2/favorite-brands/create": { "post": { "tags": [ "Избранные бренды" ], "summary": "Добавить бренд в избранное", "operationId": "8ee6ba08cdd131255a0a1a1e6b632e5b", "requestBody": { "description": "Данные для добавления бренда в избранное", "required": true, "content": { "application/json": { "schema": { "properties": { "brand_id": { "description": "Идентификатор бренда", "type": "integer", "example": 42 }, "mindboxDeviceUUID": { "description": "Уникальный идентификатор устройства (опционально)", "type": "string", "example": "abcd1234-5678-efgh-ijkl-91011mnopqr" } }, "type": "object" } } } }, "responses": { "200": { "description": "Бренд успешно добавлен в избранное", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "description": "Идентификатор записи", "type": "integer", "example": 1 }, "session_id": { "description": "Идентификатор сессии", "type": "integer", "example": 123 }, "brand_id": { "description": "Идентификатор бренда", "type": "integer", "example": 42 } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Ошибка авторизации" }, "400": { "description": "Некорректные данные запроса" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v2/favorite-brands/delete": { "delete": { "tags": [ "Избранные бренды" ], "summary": "Удалить бренд из избранного", "operationId": "c2ccf3deb7795132b8b1a4a234457fc6", "requestBody": { "description": "Данные для удаления бренда из избранного", "required": true, "content": { "application/json": { "schema": { "properties": { "brand_id": { "description": "Идентификатор бренда", "type": "integer", "example": 42 }, "mindboxDeviceUUID": { "description": "Уникальный идентификатор устройства (опционально)", "type": "string", "example": "abcd1234-5678-efgh-ijkl-91011mnopqr" } }, "type": "object" } } } }, "responses": { "200": { "description": "Бренд успешно удалён из избранного", "content": { "application/json": { "schema": { "type": "object" }, "example": [] } } }, "401": { "description": "Ошибка авторизации" }, "400": { "description": "Некорректные данные запроса" }, "404": { "description": "Бренд не найден в избранном" } }, "security": [ { "bearerAuth": [] } ] } }, "/feedback": { "get": { "tags": [ "Feedback" ], "summary": "Feedback resource list", "description": "Get all feedback", "operationId": "cd1d276a43c53771b7f1c6cb6a3f2d72", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/feedback/create": { "post": { "tags": [ "Feedback" ], "summary": "Create feedback resource", "description": "Add feedback", "operationId": "saveFeedback", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackStoreRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/feedback/{feedback}": { "get": { "tags": [ "Feedback" ], "summary": "Feedback resource info", "description": "Get feedback resource", "operationId": "getFeedbacks", "parameters": [ { "name": "feedback", "in": "path", "description": "feedback id", "required": true, "schema": { "type": "integer", "format": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Feedback not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Not found!" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] }, "patch": { "tags": [ "Feedback" ], "summary": "Update feedback resource", "description": "Change feedback review status or update text", "operationId": "updateFeedback", "parameters": [ { "name": "feedback", "in": "path", "description": "feedback id", "required": true, "schema": { "type": "integer", "format": "integer", "example": 1 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackUpdateRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResource" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Feedback not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Not found!" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "feedback/{feedback}/delete": { "delete": { "tags": [ "Feedback" ], "summary": "Delete feedback", "description": "Delete feedback resource", "operationId": "deleteFeedback", "parameters": [ { "name": "feedback", "in": "path", "description": "feedback id", "required": true, "schema": { "type": "integer", "format": "integer", "example": "1" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } }, "404": { "description": "Feedback not found", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Not found!" } } }, "type": "object" } } } }, "422": { "description": "Imposibble remove feedback", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "[]" } } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/flant/url": { "get": { "tags": [ "Flant" ], "summary": "Get schema.", "description": "Get shema by flant", "operationId": "1661d899aaced41a17f32e837763afd3", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/order/certificate/apply": { "post": { "tags": [ "Order" ], "summary": "Apply certificate to cart", "description": "Apply certificate to cart", "operationId": "42fedc038282bec9607968de0e782c22", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/certificate/remove": { "post": { "tags": [ "Order" ], "summary": "Remove certificate to cart", "description": "Remove certificate to cart", "operationId": "131f514d14f824af0b309c65af10b558", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/certificate/remove/all": { "post": { "tags": [ "Order" ], "summary": "Remove all certificates to cart", "description": "Remove all certificates to cart", "operationId": "24282f3baf8d968dbc02bb99019f8a97", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/checkout": { "get": { "tags": [ "Order" ], "summary": "Checkout", "description": "Checkout order", "operationId": "3331318410d69e1bd7c76f0ae2143834", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/shops": { "get": { "tags": [ "Order" ], "summary": "Shops where product from order avilable", "description": "Shops where product from order avilable", "operationId": "89d35ff8bd29c1e40a242034e6e79a7d", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "shops": { "type": "array", "items": { "properties": { "id": { "type": "interger", "example": "1" }, "name": { "type": "string", "example": "Parfois (ТЦ Dana Mall)" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/success": { "get": { "tags": [ "Order" ], "summary": "Success page data", "description": "Get last order for success page", "operationId": "a0eca95141bf7c5411c7fd62beeeb17a", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/promo-code/apply": { "post": { "tags": [ "Order" ], "summary": "Apply certificate to cart", "description": "Apply certificate to cart", "operationId": "dc5ab242c3d9e903612a50e08863befa", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/order/refund": { "get": { "description": "Refund products details", "operationId": "d264c56c0d5d77d5873d6f11d80d04a5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } } }, "/order/refund/{hash}": { "get": { "description": "Get refund details by hash", "operationId": "6b5424a1af9f378ea42b83e3da8504d0", "responses": { "200": { "description": "Success" } } } }, "/order/refund/{hash}/download": { "get": { "description": "Dowload refund file by hash", "operationId": "75a24331ffe5c924602ebd0274ac1f64", "responses": { "200": { "description": "Success" } } } }, "/order/refund/{phone}": { "get": { "description": "Refunds list by phone", "operationId": "0236465dd17308bb7bf42fe176536a9e", "responses": { "200": { "description": "Success" } } } }, "/page/layout": { "get": { "tags": [ "Pages" ], "summary": "Get data for selected menu.", "description": "Get layout: navigation, settings, sidebar and page data", "operationId": "774e2a2c812b56b103deb16295d8033f", "parameters": [ { "name": "slug", "in": "query", "description": "Page slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/page/layout/menu": { "get": { "tags": [ "Pages" ], "description": "Get menu and navigation, settings", "operationId": "b7d211304f6ee1add013a3b42e0c07a0", "responses": { "200": { "description": "Success" }, "403": { "description": "Unauthorized action" } }, "security": [ { "apiAuth": [] } ] } }, "/page/catalog": { "get": { "tags": [ "Pages" ], "summary": "Catalog page.", "description": "Get page catalog. All menu tree", "operationId": "a5857dba6503f29776d9034a3ab5bcb8", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/page/layout/root": { "get": { "tags": [ "Pages" ], "summary": "Menu list.", "description": "Get menu list", "operationId": "986b7c88efea1ee06315da311f555f90", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/special-offers": { "get": { "tags": [ "Pages" ], "description": "Get page special-offers data", "operationId": "0cb0ab7dbc5af9973cac1a79742fcd32", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/articles": { "get": { "tags": [ "Pages" ], "description": "Get page articles data", "operationId": "57779e830b88a902072e96c4a891c53c", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product": { "get": { "tags": [ "Pages" ], "summary": "Get data for selected menu.", "description": "Product info", "operationId": "195778c61795c13bf372254b54ea7586", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success", "deprecated": true }, "data": { "type": "array", "items": {}, "deprecated": true } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error", "deprecated": true }, "message": { "type": "string", "example": "Unauthorized action", "deprecated": true } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/collections": { "get": { "tags": [ "Pages" ], "summary": "Get collection by product.", "description": "Product info", "operationId": "15f16cdcfbaa2122b6d568db92784834", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success", "deprecated": true }, "data": { "type": "array", "items": {}, "deprecated": true } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error", "deprecated": true }, "message": { "type": "string", "example": "Unauthorized action", "deprecated": true } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/shops": { "get": { "tags": [ "Pages" ], "summary": "Get shops by product.", "description": "Product info", "operationId": "7a743220c3f383a5d6c3cfb780417a7b", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success", "deprecated": true }, "data": { "type": "array", "items": {}, "deprecated": true } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error", "deprecated": true }, "message": { "type": "string", "example": "Unauthorized action", "deprecated": true } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model": { "get": { "tags": [ "Pages" ], "summary": "Get data for selected product model.", "description": "Product info", "operationId": "49a71472f5e66092cd5496939f286cc8", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model/shops": { "get": { "tags": [ "Pages" ], "summary": "Get shops by product model.", "description": "Product info", "operationId": "9cc1ef3255fd75d382ed4ec24f9946b9", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model/collections": { "get": { "tags": [ "Pages" ], "summary": "Get collection by product model.", "description": "Product info", "operationId": "0ee11dd06e336cae5a77950f28eceb1e", "parameters": [ { "name": "slug", "in": "query", "description": "Product id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success", "deprecated": true }, "data": { "type": "array", "items": {}, "deprecated": true } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error", "deprecated": true }, "message": { "type": "string", "example": "Unauthorized action", "deprecated": true } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model/collections/paginate": { "get": { "tags": [ "Pages" ], "summary": "Get collection page by product model.", "description": "Product info", "operationId": "7b8476a902f127775a152840e070d97b", "parameters": [ { "name": "slug", "in": "query", "description": "Model id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model/look": { "get": { "tags": [ "Pages" ], "summary": "Get collection page by product model.", "description": "Look info", "operationId": "6a0bdbe5cfe9b08fdc36f9806441a6b6", "parameters": [ { "name": "slug", "in": "query", "description": "Look id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/product/model/search/refund": { "get": { "tags": [ "Pages" ], "summary": "Get collection by product model.", "description": "Product Seacrh for refund", "operationId": "ed3a75e18e114b2d779e086569f5a1b9", "parameters": [ { "name": "query", "in": "query", "description": "Product seacrh param (brand,sku,barcode)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } } }, "/product/model/list": { "get": { "tags": [ "Pages" ], "summary": "Get list models by IDS", "description": "Product info", "operationId": "2be13807279052d99fee7969fb902e2b", "responses": { "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/push-tokens/put": { "post": { "tags": [ "PushToken" ], "summary": "Сохранить токен.", "description": "Save push token in db", "operationId": "69a1981d08cb4f0fb9735970a133e051", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscription_popup" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/push-tokens/delete": { "post": { "tags": [ "PushToken" ], "summary": "Удалить токен.", "description": "Remove push token in db", "operationId": "d969e215aae475cf83aa200abf777872", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscription_popup" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/regions": { "get": { "tags": [ "Regions" ], "summary": "Regions resource list", "description": "Get all active regions", "operationId": "219cf6986d6ad920d20c3af888c946d7", "responses": { "200": { "description": "Successful operation" } }, "security": [ { "apiAuth": [] } ] } }, "/api/v2/regions/set-region": { "post": { "tags": [ "Клиент" ], "summary": "Установить регион клиента", "operationId": "f28c4717222a00096e6bd513d4c12bf4", "requestBody": { "description": "Данные для установки региона", "required": true, "content": { "application/json": { "schema": { "required": [ "region_id" ], "properties": { "region_id": { "description": "Идентификатор региона", "type": "integer", "example": 123 } }, "type": "object" } } } }, "responses": { "200": { "description": "Регион успешно установлен", "content": { "application/json": { "schema": { "properties": { "result": { "description": "Статус операции", "type": "string", "example": "success" } }, "type": "object" } } } }, "422": { "description": "Некорректные данные запроса", "content": { "application/json": { "schema": { "properties": { "result": { "description": "Статус ошибки", "type": "string", "example": "error" }, "message": { "description": "Сообщение об ошибке", "type": "string", "example": "Укажите корректный region_id." } }, "type": "object" } } } }, "401": { "description": "Ошибка авторизации", "content": { "application/json": { "schema": { "properties": { "result": { "description": "Статус ошибки", "type": "string", "example": "error" }, "message": { "description": "Сообщение об ошибке", "type": "string", "example": "Unauthenticated" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/service/broadcasting/test": { "post": { "tags": [ "Services" ], "description": "Test broadcasting event", "operationId": "dff5e9752cd07e27194d065c321b7d66", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/event": { "post": { "tags": [ "Services" ], "description": "Call something event", "operationId": "53f96288d845b500eceeb8541e975d2d", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/event/mindbox": { "post": { "tags": [ "Services" ], "description": "Call event mindbox", "operationId": "4222377391cda4d9aa543ce5a95f7f35", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/mindbox/amp-callback": { "post": { "tags": [ "Services" ], "description": "Call amp-callback from mindbox marketing emails", "operationId": "b20078bb5a5fe1fa3a41de44d305954d", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/mindbox/subscribe-callback": { "post": { "tags": [ "Services" ], "description": "Change subscribe event", "operationId": "7c72a3288e7ed47e975125517a5b4cc5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/mindbox/email-verify-callback": { "post": { "tags": [ "Services" ], "description": "Email verify event", "operationId": "0c91ef023f11b4422bff9804bb437058", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/redirect": { "get": { "tags": [ "Service" ], "description": "Get redirect payment", "operationId": "46ae89ca0bf879063b1018820e54a0c9", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/info": { "get": { "tags": [ "Service" ], "description": "Get info from payment", "operationId": "16a4882e863132a67fe800092c6ed6f2", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/notification": { "post": { "tags": [ "Service" ], "description": "Notification event from payment system", "operationId": "7b951cb18cbe6bd252caad86c1bdf5e9", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/success": { "get": { "tags": [ "Service" ], "description": "Success event from payment system", "operationId": "18d4f1fa6e26869885a34d5316154448", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/decline": { "get": { "tags": [ "Service" ], "description": "Decline event from payment system", "operationId": "0ffab450adbf080ee0b4ff312530ea2a", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/fail": { "get": { "tags": [ "Service" ], "description": "Fail event from payment system", "operationId": "256e3c7268421c987183a93c4a110dcd", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/cancel": { "get": { "tags": [ "Service" ], "description": "Cancel event from payment system", "operationId": "5d6718cb15c4b8db82368b14201f50c0", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/service/payment/{id}/return": { "get": { "tags": [ "Service" ], "description": "Return event from payment system", "operationId": "051d5a669a97b44504be2d8315842a3d", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/subscription-popups": { "get": { "tags": [ "SubscribePopup" ], "summary": "Returns all available SubscriptionPopups at the moment.", "description": "Retrieve popups data as JSON", "operationId": "a96c8daba3cf2800b1c1df9f6168765b", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscription_popup" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/subscription-popups/{id}": { "get": { "tags": [ "SubscribePopup" ], "summary": "Returns data obout popup by id.", "description": "Get popup data", "operationId": "383a138cb691c303c7ecac637938f3d8", "parameters": [ { "name": "id", "in": "path", "description": "Popup id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscription_popup" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/subscription-popups/subscribe": { "post": { "tags": [ "SubscribePopup" ], "summary": "Subscribe client by popup.", "description": "Subscribe client by popup", "operationId": "c8ec60faebf68d2de7353ccacc6ec1f9", "parameters": [ { "name": "id", "in": "query", "description": "Popup id", "required": true, "schema": { "type": "integer" } }, { "name": "email", "in": "query", "description": "Email", "required": false, "schema": { "type": "string", "example": "test@fh.by" } }, { "name": "phone", "in": "query", "description": "Phone", "required": false, "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "firstName", "required": false, "schema": { "type": "string", "example": "Roman" } }, { "name": "lastName", "in": "query", "description": "lastName", "required": false, "schema": { "type": "string", "example": "Roman" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/subscription_popup" } } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/locator/proxies": { "get": { "tags": [ "Locator" ], "description": "Get available locator proxies", "operationId": "e73cccfc398b96a87e9f65e1a552948a", "responses": { "200": { "description": "Success" } }, "security": [ { "apiAuth": [] } ] } }, "/api/v2/passkit/test": { "post": { "tags": [ "Client" ], "summary": "Выполнить действие PassKit для клиента", "description": "Находит клиента по номеру телефона и выполняет действие `passKitFile` для него. Если клиент не найден, возвращается ошибка.", "operationId": "clientPassKit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone" ], "properties": { "phone": { "description": "Номер телефона клиента", "type": "string", "example": "+1234567890" } }, "type": "object" } } } }, "responses": { "200": { "description": "Действие выполнено успешно", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Сообщение об успешном выполнении действия", "type": "string", "example": "PassKit action completed successfully" } }, "type": "object" } } } }, "404": { "description": "Клиент не найден", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Сообщение об ошибке, если клиент не найден", "type": "string", "example": "Client not found" } }, "type": "object" } } } }, "400": { "description": "Некорректный запрос", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Сообщение об ошибке, если передан некорректный номер телефона", "type": "string", "example": "Invalid phone number" } }, "type": "object" } } } } } } }, "/api/service/info": { "get": { "tags": [ "Service" ], "summary": "Получить информацию о сервисе", "description": "Возвращает информацию о сервисе, включая статус.", "operationId": "getServiceInfo", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, для которого требуется информация", "type": "string", "example": "example_service" } } ], "responses": { "200": { "description": "Информация о сервисе", "content": { "application/json": { "schema": { "properties": { "status": { "description": "Статус успешного выполнения запроса", "type": "string", "example": "success" } }, "type": "object" } } } }, "400": { "description": "Некорректный запрос", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Ошибка, если сервис не найден", "type": "string", "example": "Invalid service" } }, "type": "object" } } } } } } }, "/api/v2/passkit/{service}/v1/log": { "post": { "tags": [ "Service" ], "summary": "Запись логов для сервиса", "description": "Метод принимает логи и записывает их с помощью логера.", "operationId": "logService", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, для которого записываются логи", "type": "string", "example": "example_service" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "logs" ], "properties": { "logs": { "description": "Массив строк логов", "type": "array", "items": { "type": "string", "example": "This is a log line." } } }, "type": "object" } } } }, "responses": { "200": { "description": "Логи успешно записаны", "content": { "application/json": { "schema": { "properties": { "message": { "description": "Сообщение об успешной записи логов", "type": "string", "example": "Logs successfully saved" } }, "type": "object" } } } }, "400": { "description": "Некорректный запрос", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Сообщение об ошибке, если данные некорректны", "type": "string", "example": "Invalid log data" } }, "type": "object" } } } } } } }, "/api/v2/passkit/{service}/v1/devices/{libraryIdentifier}/registrations/{passType}/{serialNumber}": { "post": { "tags": [ "Device" ], "summary": "Регистрация устройства для сервиса", "description": "Метод позволяет зарегистрировать устройство для указанного сервиса, используя его уникальный идентификатор, тип и серийный номер.", "operationId": "registerDevice", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, для которого регистрируется устройство", "type": "string", "example": "example_service" } }, { "name": "deviceLibraryIdentifier", "in": "query", "required": true, "schema": { "description": "Уникальный идентификатор устройства в библиотеке", "type": "string", "example": "device123" } }, { "name": "passType", "in": "query", "required": true, "schema": { "description": "Тип пропуска, который связан с устройством", "type": "string", "example": "passbook" } }, { "name": "serialNumber", "in": "query", "required": true, "schema": { "description": "Серийный номер устройства", "type": "string", "example": "SN123456789" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "pushToken" ], "properties": { "pushToken": { "description": "Токен push-уведомлений для регистрации", "type": "string", "example": "some-push-token" } }, "type": "object" } } } }, "responses": { "200": { "description": "Устройство успешно зарегистрировано", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Device registered successfully" } }, "type": "object" } } } }, "400": { "description": "Некорректный запрос", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Ошибка, если данные запроса некорректны", "type": "string", "example": "Invalid data" } }, "type": "object" } } } } } }, "delete": { "tags": [ "Device" ], "summary": "Удаление регистрации устройства", "description": "Метод удаляет регистрацию устройства для указанного сервиса, используя уникальный идентификатор устройства, тип и серийный номер.", "operationId": "unRegisterDevice", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, для которого удаляется регистрация устройства", "type": "string", "example": "example_service" } }, { "name": "deviceLibraryIdentifier", "in": "query", "required": true, "schema": { "description": "Уникальный идентификатор устройства в библиотеке", "type": "string", "example": "device123" } }, { "name": "passType", "in": "query", "required": true, "schema": { "description": "Тип пропуска, связанный с устройством", "type": "string", "example": "passbook" } }, { "name": "serialNumber", "in": "query", "required": true, "schema": { "description": "Серийный номер устройства", "type": "string", "example": "SN123456789" } } ], "responses": { "200": { "description": "Устройство успешно удалено из регистрации", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Device unregistered successfully" } }, "type": "object" } } } }, "400": { "description": "Некорректный запрос", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Ошибка, если данные запроса некорректны", "type": "string", "example": "Invalid data" } }, "type": "object" } } } } } } }, "/api/v2/passkit/{service}/v1/passes/{passType}/{serialNumber}": { "get": { "tags": [ "Device" ], "summary": "Скачивание карты", "description": "Метод предоставляет возможность скачать карту для указанного сервиса по типу пропуска и серийному номеру. Также поддерживается проверка на наличие обновлений через заголовок `If-Modified-Since`.", "operationId": "showPass", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, к которому относится карта", "type": "string", "example": "example_service" } }, { "name": "passType", "in": "query", "required": true, "schema": { "description": "Тип карты, который требуется скачать", "type": "string", "example": "default" } }, { "name": "serialNumber", "in": "query", "required": true, "schema": { "description": "Серийный номер карты", "type": "string", "example": "SN123456789" } } ], "responses": { "200": { "description": "Карта успешно скачана", "content": { "application/json": { "schema": { "properties": { "data": { "description": "Содержимое карты", "type": "object" } }, "type": "object" } } } }, "304": { "description": "Карта не изменялась", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Not Modified" } }, "type": "object" } } } }, "404": { "description": "Карта не найдена", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Pass not found" } }, "type": "object" } } } } } } }, "/api/v2/passkit/{service}/v1/devices/{libraryIdentifier}/registrations/{passType}": { "get": { "tags": [ "Device" ], "summary": "Обновленные карточки", "description": "Метод возвращает список обновленных карточек для указанного устройства и типа карты с момента последнего обновления.", "operationId": "getUpdatedPasses", "parameters": [ { "name": "service", "in": "query", "required": true, "schema": { "description": "Название сервиса, к которому относятся карточки", "type": "string", "example": "example_service" } }, { "name": "deviceLibraryIdentifier", "in": "query", "required": true, "schema": { "description": "Уникальный идентификатор устройства в библиотеке", "type": "string", "example": "device123" } }, { "name": "passType", "in": "query", "required": true, "schema": { "description": "Тип карточек, которые нужно проверить на обновления", "type": "string", "example": "default" } }, { "name": "passesUpdatedSince", "in": "query", "required": false, "schema": { "description": "Дата и время последнего обновления. Если указано, возвращаются только карточки, обновленные позже этой даты.", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00Z" } } ], "responses": { "200": { "description": "Список обновленных карточек", "content": { "application/json": { "schema": { "properties": { "lastUpdated": { "description": "Дата последнего обновления", "type": "string", "format": "date-time", "example": "2023-01-01T12:00:00Z" }, "serialNumbers": { "description": "Список серийных номеров обновленных карточек", "type": "array", "items": { "type": "string", "example": "SN123456789" } } }, "type": "object" } } } }, "304": { "description": "Нет обновленных карточек", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Not Modified" } }, "type": "object" } } } }, "404": { "description": "Устройство или карточки не найдены", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Device or passes not found" } }, "type": "object" } } } } } } }, "/auth/sms": { "post": { "tags": [ "Auth" ], "description": "Send sms to client", "operationId": "3c4326791d85487d730c734d9b257514", "parameters": [ { "name": "phone", "in": "query", "description": "Client phone", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/auth/login": { "post": { "tags": [ "Auth" ], "description": "Auth user", "operationId": "c715c6e93fc03f5b1f7f804214c16347", "parameters": [ { "name": "phone", "in": "query", "description": "Client phone", "required": true, "schema": { "type": "string" } }, { "name": "verification_code", "in": "query", "description": "Sms Verification Code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "registered": { "type": "string", "example": "true" }, "session": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/auth/logout": { "post": { "tags": [ "Auth" ], "description": "Logout client", "operationId": "81545aa83cfd9352b4c6457311633326", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/auth/remove": { "post": { "tags": [ "Auth" ], "summary": "Remove profile endpoint.", "description": "Remove profile endpoint", "operationId": "9ba87189b35c94a2cfbe429d757aefcb", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/auth/email-verification/{id}/{hash}": { "get": { "tags": [ "Auth" ], "description": "Verification email", "operationId": "3cf7077f63a1320a77482878106427ba", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true }, { "name": "hash", "in": "path", "description": "hash", "required": true } ], "responses": { "301": { "description": "Success" }, "404": { "description": "Unauthorized action" } }, "security": [ { "apiAuth": [] } ] } }, "/session-new": { "get": { "tags": [ "Session" ], "summary": "Load session info controller.", "description": "Load session info controller", "operationId": "57aca833036debfb52af1eeb6239bec2", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "token": { "type": "string", "example": "error" }, "hashed_key": { "type": "string", "example": "error" }, "session": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/settings": { "get": { "tags": [ "Session" ], "summary": "Load settings controller.", "description": "Load settings controller", "operationId": "b51b9c110db4b31fc2347015d8ef6c22", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "settings": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/favorites/new": { "get": { "tags": [ "Session" ], "description": "Load favorites with Model on page controller", "operationId": "0190272e77fc1e844f2a05114ba723b5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart/put": { "post": { "tags": [ "Session" ], "summary": "Add product to cart storage.", "description": "Add product to cart storage", "operationId": "40818425b6a1b30b9cbb13f9d03aa242", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart/put-batch": { "post": { "tags": [ "Session" ], "summary": "Add a lot of products to cart storage.", "description": "Add a lot of products to cart storage", "operationId": "27ef5d46add048a4a75da9caaa3d2408", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart/update": { "post": { "tags": [ "Session" ], "summary": "Update quantity products on cart storage.", "description": "Update quantity products on cart storage", "operationId": "4feb98291d1579e3ff9de38015bea938", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart": { "get": { "tags": [ "Session" ], "summary": "Load cart on page controller.", "description": "Load cart on page controller.", "operationId": "a0f934d7db451ff6c6dd15e79222aa4f", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart/dispatch": { "get": { "tags": [ "Session" ], "summary": "Load cart on page controller.", "description": "Load cart on page controller.", "operationId": "0599e1b166d9dd3938e234d4dba8cfc5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/delete": { "post": { "tags": [ "Session" ], "summary": "Remove product on cart.", "description": "Remove product on cart", "operationId": "bc23749a992fbf3607e7f3adefb964d5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/history": { "get": { "tags": [ "Session" ], "summary": "Load histories list for block on product page.", "description": "Load histories list for block on product page", "operationId": "14b8276d59bd0649d581a3c27645baaf", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/history/delete": { "post": { "tags": [ "Session" ], "summary": "Remove product on histories.", "description": "Remove product on histories", "operationId": "d99e05a7780017b0a5bf5655f579e3ec", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/history/put": { "post": { "tags": [ "Session" ], "summary": "Put product on histories.", "description": "Put product on histories", "operationId": "d74c7f9d3ae6d31d521912783407e2f1", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/session-new/cart/delivery-info": { "post": { "tags": [ "Session" ], "summary": "Delivery info.", "description": "Delivery info", "operationId": "e1f17b7b530eef91a5811838f30a31bb", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "delivery_dates": { "type": "array", "items": {} }, "delivery_types": { "type": "array", "items": {} } }, "type": "object" } } } }, "403": { "description": "Unauthorized action", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized action" } }, "type": "object" } } } } }, "security": [ { "apiAuth": [] } ] } }, "/validate/phone": { "post": { "tags": [ "Validator" ], "summary": "validate phone number", "description": "validate phone number", "operationId": "validatePhoneNumber", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "array", "items": {}, "example": "[]" } }, "type": "object" } } } }, "400": { "description": "Введите корректный телефон", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Введите корректный телефон" } } }, "type": "object" } } } }, "402": { "description": "Отсутствующий или недопустимый код страны.", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Отсутствующий или недопустимый код страны." } } }, "type": "object" } } } } } } }, "/validate/email": { "post": { "tags": [ "Validator" ], "summary": "validate email", "description": "validate email", "operationId": "validateEmail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailRequest" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "success" }, "message": { "type": "array", "items": {}, "example": "[]" } }, "type": "object" } } } }, "400": { "description": "Такое значение поля \\'Email\\' уже существует.", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Такое значение поля \\'Email\\' уже существует." } } }, "type": "object" } } } }, "402": { "description": "Поле \\'Email\\' должно быть действительным электронным адресом.", "content": { "application/json": { "schema": { "properties": { "result": { "type": "string", "example": "error" }, "message": { "type": "array", "items": { "type": "string", "example": "Поле \\'Email\\' должно быть действительным электронным адресом." } } }, "type": "object" } } } } } } } }, "components": { "schemas": { "CartStoreRequest": { "title": "Create cart request", "description": "Create cart Request", "required": [ "product_id", "quantity" ], "properties": { "product_id": { "title": "product_id", "description": "product id", "format": "integer", "example": "1" }, "quantity": { "title": "quantity", "description": "quantity", "format": "integer", "example": "1" } }, "type": "object" }, "CatalogRequest": { "title": "Catalog request", "description": "Catalog request", "properties": { "hash": { "title": "hash", "description": "Menu hash", "format": "string", "example": "sdlkfsdf" } }, "type": "object" }, "CatalogSearchRequest": { "title": "Catalog barcode request", "description": "Catalog barcode request", "properties": { "barcode": { "title": "barcode", "description": "Product barcode", "format": "string", "example": "123123123" } }, "type": "object" }, "GetClientOrderRequest": { "title": "Client order request", "description": "Client order Request", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "Client order id", "format": "integer", "example": "1" } }, "type": "object" }, "UpdateClientCardRequest": { "title": "Client card update request", "description": "Client Card Update Request", "required": [ "id" ], "properties": { "id": { "title": "id", "description": "Client card id", "format": "integer", "example": "1" }, "holder": { "title": "holder", "description": "Card holder", "format": "string", "example": "IVANOV IVAN" }, "number": { "title": "number", "description": "Client card number", "format": "integer" }, "exp_month": { "title": "exp_month", "description": "Client card exp_month", "format": "integer", "example": 1 }, "exp_year": { "title": "exp_year", "description": "Client card exp_year", "format": "integer", "example": "2023" } }, "type": "object" }, "ClientProfileRequest": { "title": "Client update profile", "description": "Client update profile", "properties": { "first_name": { "title": "first_name", "description": "Client first name", "format": "string", "example": "Daler" }, "last_name": { "title": "last_name", "description": "Client last name", "format": "string", "example": "B" }, "email": { "title": "email", "description": "Client email", "format": "email", "example": "email@example.com" }, "birthday": { "title": "birthday", "description": "Client birthday", "format": "date", "example": "29-03-1988" }, "is_personal_data": { "title": "is_personal_data", "description": "Access to personal data", "format": "boolean", "example": "true" }, "is_personal_data_mailing": { "title": "is_personal_data_mailing", "description": "Receiving mailings", "format": "boolean", "example": "true" }, "is_personal_data_discounts": { "title": "is_personal_data_discounts", "description": "Receiving discounts and bonuses", "format": "boolean", "example": "true" }, "is_personal_data_feedback": { "title": "is_personal_data_feedback", "description": "Receiving feedback", "format": "boolean", "example": "true" }, "is_personal_data_tech_notice": { "title": "is_personal_data_tech_notice", "description": "Receiving technical information", "format": "boolean", "example": "true" }, "is_personal_data_stat_info": { "title": "is_personal_data_stat_info", "description": "Processing of statistical information", "format": "boolean", "example": "true" }, "is_personal_site_notices": { "title": "is_personal_site_notices", "description": "Receiving information from the site", "format": "boolean", "example": "true" }, "sex": { "title": "sex", "description": "Client sex", "format": "string", "example": "men|women" }, "address": { "title": "address", "description": "Client address", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientAddressResource" } }, "discount_card": { "title": "discount_card", "description": "Client discount card", "format": "string", "example": "0.00" }, "height": { "title": "height", "description": "Client height", "format": "int", "example": "0.00" }, "weight": { "title": "weight", "description": "Client weight", "format": "int", "example": "0.00" }, "shoe_size": { "title": "shoe_size", "description": "Client shoe size", "format": "int", "example": "0.00" }, "clothing_size": { "title": "clothing_size", "description": "Client clothing size", "format": "int", "example": "0.00" }, "brand_ids": { "title": "brand_ids", "description": "Client brand ids", "type": "array", "format": "array", "items": { "format": "string" } }, "subscription_topics": { "title": "subscription_topics", "description": "Client subscription topics", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientSubscriptionTopicResource" } }, "subscription_channels": { "title": "subscription_channels", "description": "Client subscription channels", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientSubscriptionChannelResource" } } }, "type": "object" }, "ClientRegionRequest": { "title": "Client region request", "description": "Client region request", "required": [ "region_id" ], "properties": { "region_id": { "title": "region_id", "description": "region id", "format": "integer", "example": "1" } }, "type": "object" }, "DeliveryNearDateRequest": { "title": "Delivery near date request", "description": "Delivery near date request", "required": [ "model_id" ], "properties": { "model_id": { "description": "Product model id", "type": "integer", "example": "1" } }, "type": "object" }, "DeliverySlotsRequest": { "title": "Delivery slots request", "description": "Get delivery slots requets", "required": [ "address" ], "properties": { "address": { "description": "Object of delivery address", "properties": { "country": { "description": "Country name", "type": "string", "example": "Россия" }, "city": { "description": "City name", "type": "string", "example": "г. Ижевск" }, "address": { "description": "Address name", "type": "string", "example": "ул. Репина" }, "house_number": { "description": "House number", "type": "string", "example": "24" } }, "type": "object" }, "self_pickup": { "description": "It is self pickup method?", "type": "boolean", "example": "true" } }, "type": "object" }, "EventRequest": { "title": "Event request", "description": "Catalog request", "properties": { "type": { "title": "type", "description": "Event type", "format": "string", "example": "sdlkfsdf" } }, "type": "object" }, "FavoriteBrandsRemoveRequest": { "title": "Remove favorite request", "description": "Remove Favorite brand Request", "required": [ "brand_id" ], "properties": { "brand_id": { "title": "brand_id", "description": "brand id", "format": "integer", "example": "1" } }, "type": "object" }, "FavoriteBrandsStoreRequest": { "title": "Create favorite store request", "description": "Create Favorite store Request", "required": [ "brand_id" ], "properties": { "brand_id": { "title": "brand_id", "description": "brand id", "format": "integer", "example": "1" } }, "type": "object" }, "FeedbackStoreRequest": { "title": "Create feedback request", "description": "Create Feedback Request", "required": [ "text", "product_id" ], "properties": { "feedback_text": { "title": "feedback_text", "description": "Feedback text", "type": "text", "format": "text", "example": "Feedback big text" }, "phone": { "title": "phone", "description": "Feedback phone", "type": "string", "format": "string", "example": "+375292482906" }, "name": { "title": "name", "description": "Feedback name", "type": "string", "format": "string", "example": "Aliakseyenka Mikhail Aliakseyevich" }, "header": { "title": "header", "description": "Feedback header", "type": "string", "format": "string", "example": "I love this shop" }, "mark": { "title": "mark", "description": "Feedback mark", "type": "integer", "format": "int", "example": "5" } }, "type": "object" }, "FeedbackUpdateRequest": { "title": "Update feedback request", "description": "Update Feedback Request", "required": [ "reviewed" ], "properties": { "text": { "title": "text", "description": "Feedback text", "type": "text", "format": "text", "example": "Feedback big text" }, "reviewed": { "title": "Reviewed", "description": "Is feedback need review?", "type": "boolean", "format": "boolean", "example": "true" } }, "type": "object" }, "ImportProductRequest": { "title": "Import product request", "description": "Import product request body data", "required": [ "products" ], "properties": { "attributes": { "title": "attributes", "description": "Product attributes", "format": "array", "example": "[]" }, "attribute_category": { "title": "attribute_category", "description": "Product attribute categories", "format": "array", "example": "[]" }, "products": { "title": "products", "description": "Products", "format": "array", "example": "[]" } }, "type": "object" }, "ApplyCertificateRequest": { "title": "Apply certificate request", "required": [ "certificate" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CertificateRequest" }, { "properties": { "certificate": { "title": "Certificate", "description": "Certificate number", "format": "integer", "example": "1" } }, "type": "object" } ] }, "CertificateRequest": { "title": "Certificate request", "required": [ "certificate" ], "properties": { "certificate": { "title": "Certificate", "description": "Certificate number", "format": "integer", "example": "1" } }, "type": "object" }, "OrderCheckoutRequest": { "title": "Order checkout request", "required": [ "delivery_type", "phone", "email", "payment_type" ], "properties": { "delivery_type": { "title": "delivery_type", "description": "Delivery type, foe example: self-delivery or courier", "format": "string", "example": "courier" }, "payment_type": { "title": "payment_type", "description": "Payment type cash or online", "format": "string", "example": "cash" }, "shop_id": { "title": "shop_id", "description": "Shop id if you nead self delivery", "format": "integer", "example": "1" }, "phone": { "title": "phone", "description": "Clinet contact phone", "format": "string", "example": "375291112233" }, "email": { "title": "email", "description": "Client contact email", "format": "string", "example": "tets@fh.by" } }, "type": "object" }, "OrderDeliveryRequest": { "title": "Order delivery request", "required": [ "delivery_type", "delivery_date", "delivery_time" ], "properties": { "delivery_type": { "title": "Delivery type", "description": "Delivery type: courier or self-delivery", "format": "string", "example": "courier" }, "shop_id": { "title": "Shop id", "description": "Shop id if you nead self delivery", "format": "integer", "example": "1" }, "address": { "title": "address", "description": "Delibvery address", "format": "string", "example": "" }, "delivery_date": { "title": "Delivery date", "description": "Delivery date", "format": "string", "example": "2020-01-09" }, "delivery_time": { "title": "Delivery time", "description": "Delivery time", "format": "string", "example": "12:00-14:00" } }, "type": "object" }, "OrderPersonalInfoRequest": { "title": "Order personal info request", "properties": { "first_name": { "title": "First name", "format": "string" }, "last_name": { "title": "Last name", "format": "string" }, "phone": { "title": "Phone", "format": "string" }, "email": { "title": "Email", "format": "string" }, "order_comments": { "title": "Order comments", "format": "string" } }, "type": "object" }, "OrderRefundRequest": { "title": "Order refund request", "required": [ "name", "phone" ], "properties": { "name": { "format": "string" }, "phone": { "format": "string" } }, "type": "object" }, "PromoCodeRequest": { "title": "Promo code request", "properties": { "promo_code": { "title": "Promo code", "description": "Promo code number", "format": "string", "example": "1121234" } }, "type": "object" }, "PageLayoutRequest": { "title": "Page layout request", "description": "Page layout request", "properties": { "slug": { "title": "slug", "description": "Page slug", "format": "string", "example": "/man" } }, "type": "object" }, "ResetStockRequest": { "required": [ "data" ], "properties": { "data": { "description": "Массив данных для обновления запасов", "type": "array", "items": { "required": [ "shop_id" ], "properties": { "shop_id": { "description": "Идентификатор магазина", "type": "integer", "example": 123 } }, "type": "object" } } }, "type": "object" }, "EmailVerifyCallbackRequest": { "required": [ "CustomerIdsWebsiteID", "CustomerEmailVerifyEmail", "CustomerEmailVerifyStatus" ], "properties": { "CustomerIdsWebsiteID": { "description": "Идентификатор клиента на сайте", "type": "integer", "example": 123 }, "CustomerEmailVerifyIsVerified": { "description": "Статус верификации email (необязательно)", "type": "boolean", "example": true }, "CustomerEmailVerifyEmail": { "description": "Адрес электронной почты клиента", "type": "string", "example": "customer@example.com" }, "CustomerEmailVerifyStatus": { "description": "Статус верификации email", "type": "string", "example": "verified" } }, "type": "object" }, "SubscribeCallbackRequest": { "title": "Subscribe mindbox callback request", "description": "Subscribe mindbox callback request", "properties": { "CustomerIdsWebsiteID": { "title": "CustomerIdsWebsiteID", "description": "CustomerIdsWebsiteID", "format": "string", "example": "sdlkfsdf" }, "CustomerCustomerSubscriptionsFashionhouseIsSubscribed": { "title": "CustomerCustomerSubscriptionsFashionhouseIsSubscribed", "description": "CustomerCustomerSubscriptionsFashionhouseIsSubscribed", "format": "string", "example": "sdlkfsdf" }, "CustomerCustomerSubscriptionsFashionhouseSmsIsSubscribed": { "title": "CustomerCustomerSubscriptionsFashionhouseSmsIsSubscribed", "description": "CustomerCustomerSubscriptionsFashionhouseSmsIsSubscribed", "format": "string", "example": "sdlkfsdf" }, "CustomerCustomerSubscriptionsFashionhouseEmailIsSubscribed": { "title": "CustomerCustomerSubscriptionsFashionhouseEmailIsSubscribed", "description": "CustomerCustomerSubscriptionsFashionhouseEmailIsSubscribed", "format": "string", "example": "sdlkfsdf" }, "CustomerCustomerSubscriptionsFashionhouseViberIsSubscribed": { "title": "CustomerCustomerSubscriptionsFashionhouseViberIsSubscribed", "description": "CustomerCustomerSubscriptionsFashionhouseViberIsSubscribed", "format": "string", "example": "sdlkfsdf" } }, "type": "object" }, "NotificationRequest": { "title": "Service notification request", "description": "Service notification request", "type": "object" }, "PaymentInfoRequest": { "title": "Service payment info request", "description": "Service payment info request", "properties": { "payment_id": { "title": "payment_id", "description": "Payment id", "format": "string", "example": "/man" } }, "type": "object" }, "RedirectRequest": { "title": "Service redirect request", "description": "Page layout request", "properties": { "order_id": { "title": "order_id", "description": "Order id", "format": "string", "example": "1020" } }, "type": "object" }, "SubscribeOnPopupRequest": { "title": "Subscribe on popup request", "description": "Subscribe on popup request", "required": [ "products" ], "properties": { "email": { "title": "email", "description": "Email", "format": "string", "example": "test@fh.by" }, "phone": { "title": "phone", "description": "Phone number", "format": "string", "example": "375290001122" }, "firstName": { "title": "firstName", "description": "First name", "format": "string", "example": "Roman" }, "lastName": { "title": "lastName", "description": "Last name", "format": "string", "example": "Slauta" } }, "type": "object" }, "CartResource": { "title": "Cart Resource", "description": "User viewed product", "properties": { "id": { "title": "id", "description": "history id", "format": "int", "example": "1" }, "session_id": { "title": "session_id", "description": "session id", "format": "int", "example": "1" }, "client_id": { "title": "client_id", "description": "client id", "format": "int", "example": "1" }, "quantity": { "title": "quantity", "description": "quantity", "format": "int", "example": "1" }, "products": { "title": "products", "description": "cart products", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ProductResource" } } }, "type": "object", "xml": { "name": "Cart Response" } }, "DeliveryCountryResource": { "title": "DeliveryCountry Resource", "description": "delivery country", "properties": { "name": { "title": "_id", "description": "delivery country name", "format": "string", "example": "Грузия" }, "iso": { "title": "iso", "description": "delivery country iso", "format": "string", "example": "G" } }, "type": "object" }, "FavoriteBrandsResource": { "title": "Create favorite brands resource", "description": "Create favorite brands resource", "required": [ "text", "product_id" ], "type": "object" }, "FavoriteListResource": { "title": "Favorite Resource", "description": "User favorite produtc", "properties": { "id": { "title": "id", "description": "favorite id", "format": "int", "example": "1" }, "name": { "title": "name", "description": "favorite list name", "format": "string", "example": "Мечта" }, "session_id": { "title": "session_id", "description": "session id", "format": "int", "example": "1" }, "client_id": { "title": "client_id", "description": "client id", "format": "int", "example": "1" }, "favorites": { "title": "favorites", "description": "Favorite products", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/FavoriteResource" } } }, "type": "object", "xml": { "name": "Favorite Response" } }, "FeedbackResource": { "title": "Create feedback request", "description": "Create Feedback Request", "required": [ "text", "product_id" ], "properties": { "feedback_text": { "title": "feedback_text", "description": "Feedback text", "type": "text", "format": "text", "example": "Feedback big text" }, "phone": { "title": "phone", "description": "Feedback phone", "type": "string", "format": "string", "example": "+375292482906" }, "name": { "title": "name", "description": "Feedback name", "type": "string", "format": "string", "example": "Aliakseyenka Mikhail Aliakseyevich" }, "header": { "title": "header", "description": "Feedback header", "type": "string", "format": "string", "example": "I love this shop" }, "mark": { "title": "mark", "description": "Feedback mark", "type": "integer", "format": "int", "example": "5" } }, "type": "object" }, "ProductModelDetailsResource": { "title": "ProductModel Resource", "description": "productModel", "properties": { "id": { "title": "_id", "description": "productModel id", "format": "int", "example": "1" } }, "type": "object" }, "ProductModelResource": { "title": "Product Resource", "description": "product", "properties": { "id": { "title": "_id", "description": "product id", "format": "int", "example": "1" } }, "type": "object" }, "ProductModelSearchResource": { "title": "Product Model Search Resource", "description": "Representation of a product model in search results", "properties": { "id": { "description": "The ID of the product model", "type": "integer" }, "slug": { "description": "The slug of the product model", "type": "string" }, "sku": { "description": "The SKU of the product model", "type": "string" }, "name": { "description": "The name of the product model", "type": "string" }, "media": { "description": "URL of the main image for search view", "type": "string", "nullable": true }, "brand": { "description": "Details of the brand associated with the product model", "properties": { "id": { "description": "The ID of the brand", "type": "integer" }, "name": { "description": "The name of the brand", "type": "string" } }, "type": "object" }, "price": { "description": "The price of the product model", "type": "number", "format": "float" }, "no_refund": { "description": "Indicates if the product is non-refundable", "type": "boolean" }, "max_returnable_days": { "description": "The maximum number of days the product can be returned", "type": "integer" } }, "type": "object" }, "ProductResource": { "title": "Product Resource", "description": "product", "properties": { "_id": { "title": "_id", "description": "product id", "format": "int", "example": "1" }, "external_id": { "title": "external_id", "description": "product external id", "format": "int", "example": "1" }, "name": { "title": "name", "description": "product name", "format": "string", "example": "Шарф MEADOW" }, "slug": { "title": "slug", "description": "product slug", "format": "int", "example": "59" }, "brand": { "title": "brand", "description": "product brand name", "format": "string", "example": "BOSS" }, "price": { "title": "price", "description": "product price", "format": "float", "example": "59.00" }, "price_diff_percent": { "title": "price_diff_percent", "description": "product price_diff_percent", "format": "string", "example": "-51689" }, "old_price": { "title": "old_price", "description": "product old_price", "format": "string", "example": "5.03" }, "media": { "title": "media", "description": "product media", "format": "array", "example": "[]" }, "quantity": { "title": "quantity", "description": "product quantity", "format": "integer", "example": "11" }, "switchable_attributes": { "title": "switchable_attributes", "description": "product switchable attributes", "format": "array", "example": "[]" }, "features": { "title": "features", "description": "product features", "format": "array", "example": "[]" }, "images_info": { "title": "images_info", "description": "product images info", "properties": { "alt": { "type": "string", "example": "Шарф MEADOW|Артикул:127836" }, "title": { "type": "string", "example": "Шарф MEADOW" } }, "type": "object" }, "external_menu_item_id": { "title": "external_menu_item_id", "description": "product external_menu_item_id", "format": "integer", "example": "43" }, "uuid": { "title": "uuid", "description": "product uuid", "format": "uuid", "example": "7fb2337f-e109-33aa-a9c3-0e26db577b53" }, "category": { "title": "category", "description": "product category", "properties": { "slug": { "type": "string" }, "name": { "type": "string", "example": "Женские часы" } }, "type": "object" }, "order": { "title": "order", "description": "product order", "format": "integer", "example": "" } }, "type": "object" }, "RefundProductResource": { "title": "Refund product resource", "description": "product refund", "properties": { "id": { "title": "_id", "description": "refund id", "format": "int", "example": "1" } }, "type": "object" }, "RefundPublicResource": { "title": "Refund resource", "description": "product refund", "properties": { "id": { "title": "_id", "description": "refund id", "format": "int", "example": "1" } }, "type": "object" }, "RefundResource": { "title": "RefundR resource", "description": "product refund", "properties": { "id": { "title": "_id", "description": "refund id", "format": "int", "example": "1" } }, "type": "object" }, "RegionResource": { "title": "Create regions resource", "description": "Create regions resource", "properties": { "id": { "title": "id", "description": "Region id", "type": "integer", "example": "12" }, "name": { "title": "name", "description": "Region name", "type": "string", "example": "Минск" }, "is_active": { "title": "is_active", "description": "Region is_active", "format": "boolean", "example": "true" }, "order": { "title": "order", "description": "Region order", "type": "integer", "example": "2" } }, "type": "object" }, "ShopResource": { "title": "Shop Resource", "description": "Shop info", "properties": { "id": { "description": "shop id", "type": "integer", "example": "1" }, "name": { "description": "Shop name", "type": "string", "example": "Parfois (ТЦ Green City)" }, "address": { "description": "Shop full address", "type": "string", "example": "796173, Нижегородская область, город Дмитров, пер. Гоголя, 81" }, "latitude": { "description": "Shop coordinates: latitude", "type": "string", "example": "53.9217540" }, "longitude": { "description": "Shop coordinates: longitude", "type": "string", "example": "27.4903670" }, "store_hours": { "description": "Shop work hours", "type": "array", "items": { "properties": { "weekday": { "description": "weekday", "type": "integer", "example": "1" }, "start_time": { "description": "start_time", "type": "string", "example": "03:12:48" }, "end_time": { "description": "end_time", "type": "string", "example": "10:37:10" }, "day_off": { "description": "day_off", "type": "boolean", "example": "false" } }, "type": "object" } }, "phones": { "description": "Shop phones", "type": "array", "items": { "properties": { "phone": { "description": "phone", "type": "string", "example": "3336785461231" } }, "type": "object" } }, "created_at": { "description": "created_at", "type": "string", "example": "2021-12-24T12:22:05.000000Z" }, "updated_at": { "description": "updated_at", "type": "string", "example": "2021-12-24T12:22:05.000000Z" }, "shop": { "description": "shop short name", "type": "string", "example": "Parfois" }, "is_available_pickup": { "description": "is available pickup in this shop", "type": "boolean", "example": "true" }, "is_show_map": { "description": "is need to show map", "type": "boolean", "example": "true" }, "is_show_leftovers": { "description": "is need to show leftovers", "type": "boolean", "example": "true" }, "retailcrm_name": { "description": "shop retailcrm name", "type": "string", "example": "retailCrmName" } }, "type": "object" }, "BatchResource": { "title": "Batch Response", "description": "Batch response", "properties": { "id": { "title": "id", "description": "uuid of batch", "format": "uuid", "example": "94bf8e7c-7acf-4ec1-87d1-73725b5e4ee0" }, "name": { "title": "name", "description": "batch name", "format": "string", "example": "Обрабатываем товары от поставщика: 2" }, "total_jobs": { "title": "total_jobs", "description": "total jobs in batch", "format": "int", "example": "90999" }, "pending_jobs": { "title": "pending_jobs", "description": "pending jobs in batch", "format": "int", "example": "12" }, "failed_jobs": { "title": "failed_jobs", "description": "failed jobs in batch", "format": "int", "example": "0" }, "failed_job_ids": { "title": "failed_job_ids", "description": "failed jobs uuid in batch", "format": "array", "example": "[]" }, "cancelled_at": { "title": "cancelled_at", "description": "batch cancelled at", "format": "datetime", "example": "2021-10-29 09:38:01" }, "created_at": { "title": "created_at", "description": "batch created at", "format": "datetime", "example": "2021-10-29 07:38:01" }, "finished_at": { "title": "finished_at", "description": "batch finished at", "format": "datetime", "example": "2021-10-29 12:38:01" } }, "type": "object", "xml": { "name": "Batch Response" } }, "ClientAddressResource": { "title": "Client Address Resource", "description": "Client address response", "properties": { "id": { "title": "id", "description": "address id", "format": "int", "example": "1" }, "post_code": { "title": "post code", "description": "address post code", "format": "string", "example": "426000" }, "country": { "title": "country", "description": "address country", "format": "string", "example": "Россия" }, "city": { "title": "city", "description": "address city", "format": "string", "example": "Ижевск" }, "address": { "title": "address", "description": "address", "format": "string", "example": "ул. Репина" }, "entrance_number": { "title": "entrance number", "description": "address entrance number", "format": "string", "example": "7" }, "house_number": { "title": "house number", "description": "address house number", "format": "string", "example": "24" }, "apartment_number": { "title": "apartment_number", "description": "address apartment number", "format": "string", "example": "87" } }, "type": "object", "xml": { "name": "Client Address Response" } }, "ClientCardResource": { "title": "Client Cards Resource", "description": "Client cards response", "properties": { "id": { "title": "id", "description": "card id", "format": "int", "example": "1" }, "holder": { "title": "card holder", "description": "card holder", "format": "string", "example": "IVANOV IVAN" }, "brand": { "title": "brand", "description": "card brand", "format": "string", "example": "visa" }, "last_number": { "title": "last_number", "description": "card last 4 number", "format": "string", "example": "4321" }, "first_number": { "title": "first_number", "description": "card first number", "format": "string", "example": "2" }, "exp_month": { "title": "exp_month", "description": "card exp month", "format": "intger", "example": "7" }, "exp_year": { "title": "exp_year", "description": "card exp year", "format": "integer", "example": "2022" } }, "type": "object", "xml": { "name": "Client Cards Response" } }, "ClientDiscountResource": { "title": "Client discount resource", "description": "Client discount response", "properties": { "discount": { "title": "discount", "description": "discount", "format": "int", "example": "1" } }, "type": "object", "xml": { "name": "Client discount Response" } }, "ClientResource": { "title": "Client Resource", "description": "Client update response", "properties": { "id": { "title": "id", "description": "client id", "format": "int", "example": "1" }, "first_name": { "title": "first name", "description": "client first name", "format": "string", "example": "Daler" }, "last_name": { "title": "last name", "description": "client last name", "format": "string", "example": "B" }, "email": { "title": "email", "description": "client email", "format": "email", "example": "email@example.com" }, "phone": { "title": "phone", "description": "client phone", "format": "string", "example": "375447772381" }, "sex": { "title": "sex", "description": "client sex", "format": "string", "example": "men" }, "birthday": { "title": "birthday", "description": "client birthday", "format": "date", "example": "29-03-1988" }, "shoe_size": { "title": "shoe_size", "description": "client shoe size", "format": "decimal", "example": "0.00" }, "clothing_size": { "title": "clothing_size", "description": "client clothing size", "format": "decimal", "example": "0.00" }, "height": { "title": "height", "description": "client height", "format": "decimal", "example": "0.00" }, "weight": { "title": "weight", "description": "client weight", "format": "decimal", "example": "0.00" }, "brand_ids": { "title": "brand_ids", "description": "client brand ids", "format": "string", "example": "1" }, "discount": { "title": "discount", "description": "client discount", "properties": { "discount": { "type": "integer", "example": "0" }, "accrual": { "type": "number", "format": "float", "example": "0.0" }, "bonus_points": { "type": "number", "format": "float", "example": "0.0" }, "qr_code_base_64": { "type": "string" } }, "type": "object", "format": "object" }, "address": { "title": "address", "description": "Client address", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientAddressResource" } }, "subscription_topics": { "title": "subscription_topics", "description": "Client subscription topics", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientSubscriptionTopicResource" } }, "subscription_channels": { "title": "subscription_channels", "description": "Client subscription channels", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ClientSubscriptionChannelResource" } } }, "type": "object", "xml": { "name": "Client Response" } }, "ClientSubscriptionChannelResource": { "title": "Client subscribtion channals Resource", "description": "Client subscribtion channals response", "properties": { "email": { "title": "email", "description": "channel email", "format": "boolean", "example": "true" }, "viber": { "title": "viber", "description": "channel viber", "format": "boolean", "example": "true" }, "sms": { "title": "sms", "description": "channel sms", "format": "boolean", "example": "true" }, "unsubscribed": { "title": "unsubscribed", "description": "unsubscribe all channels", "format": "boolean", "example": "false" } }, "type": "object", "xml": { "name": "Client subscribtion channals" } }, "ClientSubscriptionResource": { "title": "Client subscribtion Resource", "description": "Client subscribtion topics response", "type": "object", "xml": { "name": "Client subscribtion topics" } }, "ClientSubscriptionTopicResource": { "title": "Client subscribtion topics Resource", "description": "Client subscribtion topics response", "properties": { "subscription_topic_id": { "title": "subscription_topic_id", "description": "subscription topic id", "format": "integer", "example": "2" }, "state": { "title": "state", "description": "state", "format": "boolean", "example": "true" } }, "type": "object", "xml": { "name": "Client subscribtion topics" } }, "subscription_popup": { "title": "Subscription popup data", "properties": { "id": { "title": "ID", "description": "Popup ID", "format": "int32", "example": "113" }, "anchor": { "title": "Popup anchor", "description": "Link on the page to activate popup", "format": "string", "example": "subscription_popup_2" }, "request_text": { "title": "Request text", "description": "Text on the first popup page", "format": "string", "example": "Subscribe now!" }, "success_text": { "title": "Success text", "description": "Text on the second popup page", "format": "string", "example": "Thank you for the subscription!" }, "conditions": { "title": "Show conditions", "description": "The conditions used to display popup (NYI)", "format": "object", "example": "[]" }, "image": { "title": "Popup image", "description": "URL for the popup header image", "format": "string", "example": "https://example.xyz/test.jpg" } }, "type": "object" }, "LocatorProxyResource": { "title": "Locator proxies", "description": "Locator proxies", "type": "object" }, "LocatorResource": { "title": "Locator items for 1C", "description": "Locator items for 1C", "type": "object" }, "Request": { "description": "Класс для обработки запросов с валидацией и кастомными ошибками.", "properties": { "authorize": { "description": "Метод авторизации запроса, всегда возвращает true", "type": "boolean", "example": true }, "rules": { "description": "Метод, который возвращает массив правил валидации (пустой в данном случае)", "type": "array", "items": { "type": "string" } }, "failedValidation": { "description": "Метод для обработки ошибок валидации, который вызывает кастомный ответ с ошибками", "type": "void", "example": "customResponse" }, "customResponse": { "description": "Метод для отправки кастомного ответа с ошибками валидации", "type": "void", "example": "throws ValidationException" } }, "type": "object" }, "FavoriteRemoveWithModelRequest": { "required": [ "model_id" ], "properties": { "model_id": { "description": "Идентификатор модели. Должно быть числовое положительное значение.", "type": "integer", "example": 123 } }, "type": "object" }, "FavoriteRequest": { "title": "Запрос на добавление в избранное", "description": "Запрос для добавления элемента в избранное на основе идентификатора продукта.", "required": [ "product_id" ], "properties": { "product_id": { "description": "Идентификатор продукта. Должен быть положительным целым числом.", "type": "integer", "example": 456 } }, "type": "object" }, "FavoriteUpdateRequest": { "title": "Запрос на обновление избранного", "description": "Запрос для обновления данных в избранном.", "required": [ "new_product_id", "model_id", "favorite_id" ], "properties": { "new_product_id": { "description": "Идентификатор нового продукта. Должен быть положительным целым числом.", "type": "integer", "example": 123 }, "model_id": { "description": "Идентификатор модели. Должен быть положительным целым числом.", "type": "integer", "example": 456 }, "favorite_id": { "description": "Идентификатор избранного. Должен быть положительным целым числом.", "type": "integer", "example": 789 } }, "type": "object" }, "FavoriteWithModelRequest": { "title": "Запрос для добавления избранного с моделью", "description": "Запрос для добавления в избранное, связанное с моделью и опционально с продуктом.", "required": [ "model_id" ], "properties": { "model_id": { "description": "Идентификатор модели. Должен быть положительным целым числом и существовать в таблице product_models.", "type": "integer", "example": 123 }, "product_id": { "description": "Идентификатор продукта. Должен быть связан с указанной моделью.", "type": "integer", "example": 456, "nullable": true } }, "type": "object" }, "LoginRequest": { "title": "Login request", "description": "Login request", "required": [ "phone", "verification_code" ], "properties": { "phone": { "title": "Phone", "description": "User phone", "format": "string", "example": "375290001122" }, "verification_code": { "title": "Verification code", "description": "SMS verification code", "format": "string", "example": "1" } }, "type": "object" }, "SendVerificationCodeRequest": { "title": "Send verification code request", "description": "Send verification code request", "required": [ "phone" ], "properties": { "phone": { "title": "Phone", "description": "User phone", "format": "string", "example": "375290001122" } }, "type": "object" }, "FavoriteResource": { "title": "Favorite Resource", "description": "User favorite produtc", "properties": { "id": { "title": "id", "description": "favorite id", "format": "int", "example": "1" }, "favorite_list": { "title": "favorite_list", "description": "Favorite list", "type": "array", "format": "array", "items": { "properties": { "id": { "title": "id", "description": "favorite list id", "format": "int", "example": "1" }, "name": { "title": "name", "description": "favorite list name", "format": "string", "example": "Мечта" } }, "type": "object" } }, "session_id": { "title": "session_id", "description": "session id", "format": "int", "example": "1" }, "client_id": { "title": "client_id", "description": "client id", "format": "int", "example": "1" }, "products": { "title": "products", "description": "Favorite products", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ProductResource" } } }, "type": "object", "xml": { "name": "Favorite Response" } }, "FavoriteWithModelResource": { "title": "Favorite Resource", "description": "User favorite produtc", "properties": { "id": { "title": "id", "description": "favorite id", "format": "int", "example": "1" }, "favorite_list": { "title": "favorite_list", "description": "Favorite list", "type": "array", "format": "array", "items": { "properties": { "id": { "title": "id", "description": "favorite list id", "format": "int", "example": "1" }, "name": { "title": "name", "description": "favorite list name", "format": "string", "example": "Мечта" } }, "type": "object" } }, "session_id": { "title": "session_id", "description": "session id", "format": "int", "example": "1" }, "client_id": { "title": "client_id", "description": "client id", "format": "int", "example": "1" }, "products": { "title": "products", "description": "Favorite products", "type": "array", "format": "array", "items": { "$ref": "#/components/schemas/ProductResource" } } }, "type": "object", "xml": { "name": "Favorite Response" } }, "RelatedProductResource": { "title": "Ресурс связанного товара", "description": "Ресурс, представляющий связанные товары в корзине.", "properties": { "product_id": { "description": "Идентификатор товара.", "type": "integer", "example": 123 }, "name": { "description": "Название товара.", "type": "string", "example": "Smartphone XYZ" }, "price": { "description": "Цена товара.", "type": "number", "format": "float", "example": 299.99 }, "cart_quantity": { "description": "Количество товара в корзине.", "type": "integer", "example": 1 }, "image_url": { "description": "URL изображения товара.", "type": "string", "example": "https://example.com/images/product_123.jpg" } }, "type": "object" }, "RelatedProductResourceCollection": { "title": "Коллекция связанных продуктов", "description": "Коллекция ресурсов, представляющих связанные продукты.", "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductResource" } }, "SessionCartInfoResource": { "title": "Информация о корзине сессии", "description": "Ресурс, представляющий информацию о корзине сессии пользователя.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/SessionResource" }, { "properties": { "client": { "$ref": "#/components/schemas/ClientResource" }, "cart": { "description": "Массив идентификаторов товаров в корзине", "type": "array", "items": { "description": "Идентификаторы товаров в корзине", "type": "integer" } }, "cart_count": { "description": "Общее количество товаров в корзине.", "type": "integer", "example": 3 } }, "type": "object" } ] }, "SessionResource": { "title": "Ресурс сессии", "description": "Информация о сессии, включая корзину, избранные товары, историю просмотров и информацию о клиенте.", "properties": { "id": { "description": "ID сессии", "type": "integer" }, "cart": { "description": "Список ID продуктов в корзине", "type": "array", "items": { "type": "integer" } }, "favorite_brands": { "description": "Список ID брендов в избранном", "type": "array", "items": { "type": "integer" } }, "favorites": { "description": "Список избранных продуктов", "type": "array", "items": { "properties": { "product_id": { "type": "integer" }, "model_id": { "type": "integer" } }, "type": "object" } }, "views_history": { "description": "История просмотров продуктов", "type": "array", "items": { "type": "string" } }, "cart_count": { "description": "Количество товаров в корзине", "type": "integer" }, "favorites_count": { "description": "Количество избранных товаров", "type": "integer" }, "views_history_count": { "description": "Количество товаров в истории просмотров", "type": "integer" }, "promo_code": { "description": "Промокод, связанный с сессией", "type": "string" }, "region_id": { "description": "ID региона клиента", "type": "integer" }, "certificates": { "description": "Список сертификатов", "type": "array", "items": { "type": "string" } }, "client": { "$ref": "#/components/schemas/ClientResource" }, "confirmAge": { "description": "Подтверждение возраста клиента (если меньше 16 или больше 90 лет)", "type": "boolean" } }, "type": "object" }, "EmailRequest": { "title": "Email requst validator", "description": "Validate request body data", "required": [ "email" ], "properties": { "email": { "title": "email", "description": "client email", "type": "string", "format": "email", "example": "mail@example.com" } }, "type": "object" }, "PhoneRequest": { "title": "Phone number requst validator", "description": "Validate request body data", "required": [ "phone" ], "properties": { "phone": { "title": "phone", "description": "Phone number in international format", "format": "string", "example": "+79111234567" } }, "type": "object" } }, "securitySchemes": { "apiAuth": { "type": "http", "description": "Company authentication token", "name": "Token based", "in": "header", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Catalog", "description": "Request catalog data" }, { "name": "Client", "description": "resource" }, { "name": "Delivery", "description": "Request delivery slots" }, { "name": "Batch", "description": "manipulate resources" }, { "name": "Feedback", "description": "Request feedback resources" }, { "name": "Flant", "description": "Flant services" }, { "name": "Order", "description": "Request order info" }, { "name": "Pages", "description": "Request page data" }, { "name": "PushToken", "description": "" }, { "name": "Regions", "description": "All active regions" }, { "name": "Services", "description": "" }, { "name": "SubscribePopup", "description": "Retrieve popups data as JSON" }, { "name": "Validator", "description": "validate email and phone" }, { "name": "FavoriteBrands", "description": "FavoriteBrands" }, { "name": "Service", "description": "Service" }, { "name": "Import products", "description": "Import products" }, { "name": "ExchangeReports", "description": "ExchangeReports" }, { "name": "Цены", "description": "Цены" }, { "name": "Избранные бренды", "description": "Избранные бренды" }, { "name": "Клиент", "description": "Клиент" }, { "name": "Locator", "description": "Locator" }, { "name": "Device", "description": "Device" }, { "name": "Auth", "description": "Auth" }, { "name": "Session", "description": "Session" } ] }