Vsemayki REST API

https://rest.vsemayki.ru/doc/
Admin
Vsemayki REST API is a web service API documented with Swagger UI that provides endpoints for...
Tokens:83,525
Snippets:254
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET /proxy-userhub/api/v1/constructor_info

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of constructor designs.

```APIDOC
## GET /proxy-userhub/api/v1/constructor_info

### Description
Retrieves a list of constructor designs.

### Method
GET

### Endpoint
/proxy-userhub/api/v1/constructor_info

### Parameters
#### Query Parameters
- **access-token** (string) - Required - The application access token.

### Request Example
```
GET /proxy-userhub/api/v1/constructor_info?access-token=YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **Constructor Info List** (object) - Contains the status of the operation, a list of constructor design descriptions, and a message.
  - **success** (boolean) - The status of the operation.
  - **data** (array) - An array of constructor design descriptions.
    - **items** ($ref: "#/definitions/ConstructorInfo")
  - **message** (string) - Accompanying message.

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "description": "constructor design description"
    }
  ],
  "message": "string"
}
```
```

--------------------------------

### GET /promo/placement-banners

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of promo banner and placement relationships.

```APIDOC
## GET /promo/placement-banners

### Description
Retrieves a list of relationships between promotional banners and their placement locations. Supports filtering by banner ID and placement ID, as well as pagination.

### Method
GET

### Endpoint
/promo/placement-banners

### Parameters
#### Query Parameters
- **filter[banner_id]** (integer) - Optional - Filters the results by banner ID.
- **filter[placement_id]** (integer) - Optional - Filters the results by placement ID.
- **offset** (integer) - Optional - The number of records to skip (for pagination).
- **limit** (integer) - Optional - The maximum number of records to return (for pagination).
- **access-token** (string) - Required - Application access token.

### Response
#### Success Response (200)
- **placement_banners** (array of PlacementBanner) - A list of banner-placement relationships.

#### Response Example
```json
[
  {
    "banner_id": 1,
    "placement_id": 101
  },
  {
    "banner_id": 2,
    "placement_id": 102
  }
]
```
```

--------------------------------

### GET /catalog/items/recommendations

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of recommended products based on specified categories.

```APIDOC
## GET /catalog/items/recommendations

### Description
Retrieves a list of recommended products based on specified categories.

### Method
GET

### Endpoint
/catalog/items/recommendations

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access key.
- **categories** (array of strings) - Required - Filter by category aliases.
- **offset** (integer) - Optional - Offset for product listing (starting point).

### Request Example
```json
{
  "example": "(No request body for GET request)"
}
```

### Response
#### Success Response (200)
- **CatalogPage** (object) - A page of recommended catalog items.

#### Response Example
```json
{
  "example": "(Schema to be defined for recommended items)"
}
```
```

--------------------------------

### GET /catalog/products/views

Source: https://rest.vsemayki.ru/doc/api

Fetches a list of displayed products based on a given layout ID.

```APIDOC
## GET /catalog/products/views

### Description
Fetches a list of displayed products based on a given layout ID.

### Method
GET

### Endpoint
/catalog/products/views

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access key
- **template** (integer) - Required - Identifier of the template

### Response
#### Success Response (200)
- **ProductViewPage** (*)
  - Description: Structure describing the list of displayed products.

#### Error Response (500)
- **ErrorStatus** (*)
  - Description: Error processing the request.

### Response Example
```json
{
  "example": "ProductViewPage object"
}
```
```

--------------------------------

### Create Constructor Mockup API

Source: https://rest.vsemayki.ru/doc/api

Creates a new mockup from the constructor. Requires an access token and item data.

```APIDOC
## POST /order/constructor-item

### Description
Creates a new mockup from the constructor. This is a new endpoint for creating constructor mockups.

### Method
POST

### Endpoint
/order/constructor-item

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Access key for the application.

#### Request Body
- **item_data** (object) - Required - Data for creating the new item.
  - See `#/definitions/CartConstructorItemData` for schema details.

### Response
#### Success Response (200)
- **CartConstructorItem** (object) - ID of the created mockup.

#### Error Response (400)
- **ErrorStatus** (object) - Indicates an invalid request format.

#### Error Response (500)
- **ErrorStatus** (object) - Indicates a request processing error.

### Request Example
```json
{
  "access-token": "YOUR_ACCESS_TOKEN",
  "item_data": {
    "productId": "PROD123",
    "designData": "some_design_data"
  }
}
```

### Response Example
```json
{
  "mockupId": "MOCKUP001"
}
```
```

--------------------------------

### GET /cart/{id}/advise

Source: https://rest.vsemayki.ru/doc/api

Gets recommendations for a specific shopping cart identified by its ID. Requires an access token.

```APIDOC
## GET /cart/{id}/advise

### Description
Gets recommendations for a specific shopping cart identified by its ID. Requires an access token.

### Method
GET

### Endpoint
/cart/{id}/advise

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the cart.

#### Query Parameters
- **access-token** (string) - Required - Your application's access key.

### Response
#### Success Response (200)
- **CatalogPage** - The catalog page data with recommendations.

#### Error Responses
- **404** - Cart not found
- **500** - Internal server error
```

--------------------------------

### GET /catalog/item/{itemId}

Source: https://rest.vsemayki.ru/doc/api

Retrieves detailed information about a specific product. You can use this endpoint to get all the necessary details for a given item ID.

```APIDOC
## GET /catalog/item/{itemId}

### Description
Retrieves detailed information about a specific product. You can use this endpoint to get all the necessary details for a given item ID.

### Method
GET

### Endpoint
/catalog/item/{itemId}

### Parameters
#### Path Parameters
- **itemId** (integer) - Required - Идентификатор товара

#### Query Parameters
- **access-token** (string) - Required - Ключ доступа приложения
- **ignore_store** (boolean) - Optional - Включать отсутствующие на складе товары
- **geo[region_name]** (string) - Optional - Регион нахождения пользователя
- **geo[district_name]** (string) - Optional - Район нахождения пользователя
- **geo[city_name]** (string) - Optional - Город нахождения пользователя
- **geo[location_name]** (string) - Optional - Населенный пункт нахождения пользователя

### Response
#### Success Response (200)
- **object** - Информация о товаре (структура ItemFull)

#### Response Example
```json
{
  "id": 123,
  "name": "Example Product",
  "description": "This is a detailed description of the example product.",
  "price": 19.99,
  "currency": "USD",
  "images": [
    "http://example.com/image1.jpg",
    "http://example.com/image2.jpg"
  ],
  "options": [
    {
      "name": "Color",
      "values": ["Red", "Blue"]
    }
  ]
}
```
```

--------------------------------

### POST /promo/placements

Source: https://rest.vsemayki.ru/doc/api

Creates a new promotional banner placement. Requires shop ID and alias.

```APIDOC
## POST /promo/placements

### Description
Creates a new promotional banner placement. Requires shop ID and alias.

### Method
POST

### Endpoint
/promo/placements

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access token.

#### Request Body
- **placement_data** (object) - Required - Data for the new placement. Must include `shop_id` and `alias`.
  - **shop_id** (integer) - Required - The ID of the shop.
  - **alias** (string) - Required - The alias for the placement.
  - **title** (string) - Optional - The title of the placement.

### Request Example
```json
{
  "shop_id": 101,
  "alias": "new-product-banner",
  "title": "New Product Launch"
}
```

### Response
#### Success Response (201)
- **Placement** (object) - The created placement object.

#### Response Example
```json
{
  "id": 2,
  "shop_id": 101,
  "alias": "new-product-banner",
  "title": "New Product Launch"
}
```

#### Error Response (422)
- **ErrorValidationArray** - An array of validation errors if the input is invalid.
#### Error Response (500)
- **ErrorStatus** - An error object if the request fails.
```

--------------------------------

### Get Order Status by ID and Email (GET)

Source: https://rest.vsemayki.ru/doc/api

Retrieves the status of an order using its ID and the associated email. Requires an access token. Returns order details or an error status.

```OpenAPI
{
  "get": {
    "tags": [
      "заказ"
    ],
    "summary": "Получение статуса заказа для неавторизованного юзера, по id email",
    "parameters": [
      {
        "in": "query",
        "name": "access-token",
        "description": "Ключ доступа приложения",
        "required": true,
        "type": "string"
      },
      {
        "in": "query",
        "name": "email",
        "description": "email соответствующих номеру заказа",
        "required": true,
        "type": "string",
        "format": "email"
      },
      {
        "in": "path",
        "name": "orderId",
        "description": "Идентификатор заказа",
        "required": true,
        "type": "integer",
        "format": "int64"
      }
    ],
    "responses": {
      "200": {
        "description": "Данные о заказе",
        "schema": {
          "$ref": "#/definitions/Order"
        }
      },
      "400": {
        "description": "Неверный формат запроса",
        "schema": {
          "$ref": "#/definitions/ErrorStatus"
        }
      },
      "500": {
        "description": "Ошибка обработки запроса",
        "schema": {
          "$ref": "#/definitions/ErrorStatus"
        }
      }
    },
    "security": [
      {
        "access_token": [
          "order"
        ]
      }
    ]
  }
}
```

--------------------------------

### POST /proxy-userhub/api/v1/constructor_info

Source: https://rest.vsemayki.ru/doc/api

Creates a constructor design.

```APIDOC
## POST /proxy-userhub/api/v1/constructor_info

### Description
Creates a constructor design.

### Method
POST

### Endpoint
/proxy-userhub/api/v1/constructor_info

### Parameters
#### Query Parameters
- **access-token** (string) - Required - The application access token.

### Request Body
(Schema not fully provided in the input, but likely contains details for creating a constructor design)

### Request Example
```
POST /proxy-userhub/api/v1/constructor_info?access-token=YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "design_details": "..."
}
```

### Response
#### Success Response (200)
(Response schema not fully provided in the input, but likely confirms creation or returns the created design details.)

#### Response Example
(Schema reference: Not available)
```

--------------------------------

### GET /user/device-id

Source: https://rest.vsemayki.ru/doc/api

Generates a device identifier.

```APIDOC
## GET /user/device-id

### Description
Generates a device identifier.

### Method
GET

### Endpoint
/user/device-id

### Parameters
None

### Request Example
```
GET /user/device-id
```

### Response
#### Success Response (200)
- **DeviceId** (object) - Contains the status of the operation, the generated device ID, and a message.
  - **success** (boolean) - The status of the operation.
  - **data** (string) - The generated device identifier.
  - **message** (string) - Accompanying message.

#### Response Example
```json
{
  "success": true,
  "data": "GENERATED_DEVICE_ID",
  "message": "string"
}
```
```

--------------------------------

### POST /promo/banners

Source: https://rest.vsemayki.ru/doc/api

Creates a new promotional banner. Requires path, width, and height.

```APIDOC
## POST /promo/banners

### Description
Creates a new promotional banner. Requires path, width, and height.

### Method
POST

### Endpoint
/promo/banners

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access token.

#### Request Body
- **banner_data** (object) - Required - Data for the new banner.
  - **path** (string) - Required - The path to the banner image.
  - **width** (integer) - Required - The width of the banner in pixels.
  - **height** (integer) - Required - The height of the banner in pixels.
  - **placement_id** (integer) - Optional - The ID of the placement for this banner.

### Request Example
```json
{
  "path": "/new/banner/image.png",
  "width": 300,
  "height": 250,
  "placement_id": 1
}
```

### Response
#### Success Response (201)
- **Banner** (object) - The created banner object.

#### Response Example
```json
{
  "id": 2,
  "path": "/new/banner/image.png",
  "width": 300,
  "height": 250,
  "placement_id": 1
}
```

#### Error Response (422)
- **ErrorValidationArray** - An array of validation errors if the input is invalid.
#### Error Response (500)
- **ErrorStatus** - An error object if the request fails.
```

--------------------------------

### Get User Profile (REST API)

Source: https://rest.vsemayki.ru/doc/api

Shows how to retrieve a user's profile information using the `/user/profile` GET endpoint. This request requires an `access-token` as a query parameter. The response contains the user's profile data or an error status if the request fails.

```shell
GET /user/profile?access-token=YOUR_ACCESS_TOKEN
```

--------------------------------

### POST /promo/banners

Source: https://rest.vsemayki.ru/doc/api

Creates a new promotional banner.

```APIDOC
## POST /promo/banners

### Description
Creates a new promotional banner with the provided data.

### Method
POST

### Endpoint
/promo/banners

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access token.

#### Request Body
- **banner** (Banner) - Required - The banner data to create.

### Request Example
```json
{
  "banner": {
    "id": 1,
    "name": "Summer Sale Banner",
    "description": "Get ready for summer savings!",
    "image_url": "https://example.com/images/summer_banner.jpg",
    "start_date": "2023-06-01",
    "end_date": "2023-08-31",
    "is_active": true
  }
}
```

### Response
#### Success Response (201)
- **banner** (Banner) - The newly created promotional banner.

#### Response Example
```json
{
  "banner": {
    "id": 1,
    "name": "Summer Sale Banner",
    "description": "Get ready for summer savings!",
    "image_url": "https://example.com/images/summer_banner.jpg",
    "start_date": "2023-06-01",
    "end_date": "2023-08-31",
    "is_active": true
  }
}
```
```

--------------------------------

### Promotion API

Source: https://rest.vsemayki.ru/doc/api

Defines the structure for promotional offers, including details like description, dates, discount percentage, and limits.

```APIDOC
## Promotion

### Promotion

Represents a promotional offer.

#### Properties

- **id** (string) - Required - ID акции.
- **full_description** (string) - Required - Полное описание акции.
- **short_description** (string) - Required - Краткое описание акции.
- **percent** (integer, format: int32) - Required - Процент скидки.
- **date_start** (string, format: date) - Дата начала акции.
- **date_end** (string, format: date) - Дата конца акции.
- **sum_limit** (integer, format: int32) - Лимит суммы для применения акции.
- **count** (integer, format: int32) - Количество товаров, для которых применяется акция.
```

--------------------------------

### Get User Orders List (REST API)

Source: https://rest.vsemayki.ru/doc/api

Explains how to retrieve a list of user orders using the `/user/orders` GET endpoint. This request requires an `access-token` and optionally accepts `offset` and `limit` query parameters for pagination. The response provides a page of orders or an error status.

```shell
GET /user/orders?access-token=YOUR_ACCESS_TOKEN&offset=0&limit=10
```

--------------------------------

### User Sign-In Example (REST API)

Source: https://rest.vsemayki.ru/doc/api

Demonstrates how to sign in a user using the `/user/sign-in` endpoint. This POST request requires specific grant type, client credentials, username, and password in the request body. The endpoint returns authorization data upon successful authentication or an error status for invalid requests or credentials.

```shell
POST /user/sign-in?access-token=9c71aa06479eb776f26d18826faa68530ae22b8a
Content-Type: application/json

{
  "grant_type": "password",
  "client_id": "[YOUR_ID]",
  "client_secret": "[YOUR_SECRET]",
  "username": "79111111111",
  "password": "testpass"
}
```

--------------------------------

### GET /promotions

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of active promotions.

```APIDOC
## GET /promotions

### Description
Retrieves a list of active promotions.

### Method
GET

### Endpoint
/promotions

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access key.
- **date_start** (string) - Optional - The start date for filtering promotions.
- **date_end** (string) - Optional - The end date for filtering promotions.

### Response
#### Success Response (200)
- **GetPromotionsResponse** (array) - An array of Promotion objects.
  - Each object contains details about a promotion.

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Summer Sale",
    "description": "Get up to 50% off on selected items.",
    "start_date": "2023-06-01",
    "end_date": "2023-08-31"
  }
]
```

#### Error Response (500)
- Internal server error.
```

--------------------------------

### User Sign-up (POST)

Source: https://rest.vsemayki.ru/doc/api

Registers a user. Requires 'grant_type', 'client_id', 'client_secret', 'username', and 'password'. An example request body is provided. Handles various error scenarios including 'Bad request' and 'Internal server error'.

```json
{
  "tags": [
    "пользователь"
  ],
  "summary": "Регистрация",
  "description": "Пример запроса:\n\n`POST /user/sign-up`\n\nТело запроса:\n\n```\n{\n  'grant_type': 'password',\n  'client_id': '[YOUR_ID]',\n  'client_secret': '[YOUR_SECRET]',\n  'username': '79111111111',\n  'password':'testpass'\n}\n```\n",
  "parameters": [
    {
      "in": "body",
      "name": "userData",
      "description": "Данные для авторизации",
      "require"
    }
  ]
}
```

--------------------------------

### GET /filters/list

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of available filters for the platform.

```APIDOC
## GET /filters/list

### Description
Retrieves a list of available filters.

### Method
GET

### Endpoint
/filters/list

### Parameters
#### Query Parameters
None

### Response
#### Success Response (200)
- **(array of strings)** - Названия фильтров

#### Response Example
```json
["color", "size", "brand"]
```
```

--------------------------------

### POST /user/sign-in

Source: https://rest.vsemayki.ru/doc/api

Allows users to sign in or register. Requires application credentials and user login details.

```APIDOC
## POST /user/sign-in

### Description
Allows users to sign in or register. Requires application credentials and user login details.

### Method
POST

### Endpoint
/user/sign-in

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access token.

#### Request Body
- **userData** (object) - Required - Contains login data.
  - **grant_type** (string) - Required - Type of grant (e.g., 'password').
  - **client_id** (string) - Required - Your application's client ID.
  - **client_secret** (string) - Required - Your application's client secret.
  - **username** (string) - Required - User's username or phone number.
  - **password** (string) - Required - User's password.

### Request Example
```json
{
  "grant_type": "password",
  "client_id": "[YOUR_ID]",
  "client_secret": "[YOUR_SECRET]",
  "username": "79111111111",
  "password": "testpass"
}
```

### Response
#### Success Response (200)
- **AuthUserData** (object) - Contains authentication and user data.

#### Response Example
```json
{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "email": "user@example.com",
  "name": "John Doe",
  "phone": "+1234567890"
}
```
```

--------------------------------

### GET /proxy-userhub/api/v1/constructor_info/{id}

Source: https://rest.vsemayki.ru/doc/api

Retrieves information about a specific constructor design.

```APIDOC
## GET /proxy-userhub/api/v1/constructor_info/{id}

### Description
Retrieves information about a specific constructor design.

### Method
GET

### Endpoint
/proxy-userhub/api/v1/constructor_info/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - id дизайна

#### Query Parameters
- **access-token** (string) - Required - Ключ доступа приложения

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - статус операции
- **data** (object) - описание дизайна (schema: #/definitions/ConstructorInfo)
- **message** (string) - сопроводительное сообщение

#### Response Example
```json
{
  "success": true,
  "data": {},
  "message": "Constructor info retrieved successfully"
}
```
```

--------------------------------

### Create Order

Source: https://rest.vsemayki.ru/doc/index

Creates a new order by submitting cart details, selected options, and customer information.

```APIDOC
## POST /orders

### Description
Creates a new order. This is the final step in the order creation process.

### Method
POST

### Endpoint
/orders

### Parameters
#### Request Body
- **cart** (object) - Required - The cart object containing items and pricing.
  - **id** (string) - Required - The ID of the cart.
- **promoCode** (string) - Optional - The promotional code applied.
- **deliveryAlias** (string) - Required - The alias of the chosen delivery method.
- **pickupPointId** (string) - Optional - The ID of the selected pickup point, if applicable.
- **paymentAlias** (string) - Required - The alias for the payment method (e.g., 'pre' for prepayment, 'post' for post-payment).
- **clientInfo** (object) - Required - Information about the client (legal entity).
  - **name** (string) - Required - The name of the client.
  - **inn** (string) - Required - The INN (tax identification number) of the client.

### Request Example
```json
{
  "cart": {
    "id": "cart_abc123",
    "items": [
      {
        "productId": "123",
        "quantity": 2,
        "price": 50.00
      }
    ],
    "currency": "RUB"
  },
  "promoCode": "SUMMER20",
  "deliveryAlias": "pickup_point",
  "pickupPointId": "pp_1",
  "paymentAlias": "pre",
  "clientInfo": {
    "name": "Example Corp",
    "inn": "7712345678"
  }
}
```

### Response
#### Success Response (200)
- **orderId** (string) - The unique identifier of the created order.
- **status** (string) - The initial status of the created order.

#### Response Example
```json
{
  "orderId": "order_xyz987",
  "status": "processing"
}
```
```

--------------------------------

### POST /cart

Source: https://rest.vsemayki.ru/doc/api

Creates a new shopping cart.

```APIDOC
## POST /cart

### Description
Creates a new shopping cart.

### Method
POST

### Endpoint
/cart

#### Query Parameters
- **access-token** (string) - Required - Ключ доступа приложения

#### Headers
- **device_id** (string) - Optional - Идентификатор устройства

#### Request Body
- **schema** (object) - referencing `#/definitions/PostCart` - Данные корзины

### Request Example
```json
{
  "items": [
    {
      "productId": "prod1",
      "quantity": 1
    }
  ]
}
```

### Response
#### Success Response (200)
- **schema** (object) - referencing `#/definitions/PostCartResponse` - Данные созданной корзины
  - **success** (boolean) - статус операции
  - **data** (object) - referencing `#/definitions/Cart` - описание корзины
  - **message** (string) - сопроводительное сообщение

#### Error Response (400)
- Bad request
#### Error Response (500)
- Internal server error

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "newCart123",
    "items": [
      {
        "productId": "prod1",
        "quantity": 1
      }
    ]
  },
  "message": "Cart created successfully"
}
```
```

--------------------------------

### Product Details and Reviews

Source: https://rest.vsemayki.ru/doc/api

This section details the structure of product information and how reviews are represented, including user, offer, and source details.

```APIDOC
## Product Information Schema

### Description
Defines the structure for product data, including its ID, name, description, status, and associated metadata like theme and file information.

### Schema
```json
{
  "id": "integer",
  "name": "string",
  "description": "string",
  "status": "integer",
  "producttype_id": "integer",
  "theme_id": "integer",
  "files_name": "array<string>",
  "files_description": "array<string>"
}
```

## Review Data Structures

### Description
Details the schemas for creating and representing product reviews, including user information, offer details, source, ratings, text, and attached files.

### Schemas

#### ReviewCreate Schema
```json
{
  "user": {
    "id": "integer",
    "name": "string",
    "email": "string",
    "phone": "string"
  },
  "offer": {
    "product": "string",
    "template": "integer",
    "attributes": {
      "color": "string",
      "size": "string"
    }
  },
  "source": {
    "platform": "string",
    "order_id": "integer"
  },
  "mark": "integer",
  "text": "string",
  "files": "array<ReviewFile>"
}
```

#### ReviewFile Schema
```json
{
  "path": "string"
}
```

#### Review Schema
```json
{
  "id": "integer",
  "user_name": "string",
  "user_email": "string",
  "mark": "number",
  "text": "string",
  "order_id": "integer",
  "created_at": "string (date-time)",
  "status": "number",
  "updated_at": "string (date-time)",
  "is_show_in_main": "integer",
  "producttype_id": "integer",
  "theme_id": "integer",
  "user_id": "integer",
  "user_phone": "string",
  "producttype_alias": "string",
  "platform": "string",
  "attrs": {
    "color_id": "integer",
    "color_alias": "string",
    "size_id": "integer",
    "size_alias": "string"
  },
  "files": "array<ReviewFile>"
}
```
```

--------------------------------

### GET /cart/{id}

Source: https://rest.vsemayki.ru/doc/api

Retrieves information about a specific cart by its ID.

```APIDOC
## GET /cart/{id}

### Description
Retrieves information about a specific cart by its ID.

### Method
GET

### Endpoint
/cart/{id}

#### Path Parameters
- **id** (string) - Required - id корзины

#### Query Parameters
- **access-token** (string) - Required - Ключ доступа приложения

### Response
#### Success Response (200)
- **schema** (object) - referencing `#/definitions/GetCartIdResponse` - Данные корзины
  - **success** (boolean) - статус операции
  - **data** (object) - описание корзины
  - **message** (string) - сопроводительное сообщение

#### Response Example
```json
{
  "success": true,
  "data": {
    "id": "cart123",
    "items": [
      {
        "productId": "prod1",
        "quantity": 1
      }
    ]
  },
  "message": "Cart details retrieved successfully"
}
```
```

--------------------------------

### GET /cart

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of carts associated with the access token.

```APIDOC
## GET /cart

### Description
Retrieves a list of carts associated with the access token.

### Method
GET

### Endpoint
/cart

#### Query Parameters
- **access-token** (string) - Required - Ключ доступа приложения

### Response
#### Success Response (200)
- **schema** (object) - referencing `#/definitions/GetCartResponse` - Список корзин
  - **success** (boolean) - статус операции
  - **data** (array) - описание корзины, items referencing `#/definitions/Cart`
  - **message** (string) - сопроводительное сообщение

#### Error Response (500)
- Internal server error

#### Response Example
```json
{
  "success": true,
  "data": [
    {
      "id": "cart123",
      "items": []
    }
  ],
  "message": "Carts retrieved successfully"
}
```
```

--------------------------------

### POST /user/sign-up

Source: https://rest.vsemayki.ru/doc/api

Registers a new user. Requires user details including grant type, client credentials, username, and password.

```APIDOC
## POST /user/sign-up

### Description
Registers a new user account. This endpoint is specifically for the sign-up process, distinct from general authentication.

### Method
POST

### Endpoint
`/user/sign-up`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **userData** (object) - Required - Data for user registration.
  - **grant_type** (string) - Required. Typically 'password'.
  - **client_id** (string) - Required.
  - **client_secret** (string) - Required.
  - **username** (string) - Required - User's username (e.g., phone number).
  - **password** (string) - Required - User's password.

### Request Example
```json
{
  "grant_type": "password",
  "client_id": "[YOUR_ID]",
  "client_secret": "[YOUR_SECRET]",
  "username": "79111111111",
  "password": "testpass"
}
```

### Response
#### Success Response (200)
- **AuthUserData** (object) - Contains authorization details. Refers to `#/definitions/AuthUserData`.

#### Error Response (400)
- **ErrorStatus** (object) - Describes the error. Refers to `#/definitions/ErrorStatus`.

#### Error Response (500)
- **ErrorStatus** (object) - Describes the server error. Refers to `#/definitions/ErrorStatus`.

#### Response Example (200)
{
  "access_token": "eyJ...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "def..."
}
```

--------------------------------

### GET /user/order-info

Source: https://rest.vsemayki.ru/doc/api

Retrieves user information for an order based on previous orders.

```APIDOC
## GET /user/order-info

### Description
Retrieves user information for an order based on previous orders.

### Method
GET

### Endpoint
/user/order-info

### Parameters
#### Query Parameters
- **access-token** (string) - Required - The application access token.

### Request Example
```
GET /user/order-info?access-token=YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **User Information** (object) - Contains user details like country, region, city, address, name, email, phone, delivery type, and postamat ID.
  - **addressCountry** (string) - The country.
  - **addressRegion** (string) - The region.
  - **addressCity** (string) - The city.
  - **addressIndex** (string) - The postal index.
  - **address** (string) - The address.
  - **customerFirstName** (string) - The first name.
  - **customerLastName** (string) - The last name.
  - **customerMiddleName** (string) - The middle name.
  - **customerEmail** (string) - The email.
  - **customerPhone** (string) - The phone number.
  - **deliveryType** (string) - The delivery method.
  - **deliveryPostamatId** (integer) - The postamat ID.

#### Response Example
```json
{
  "addressCountry": "string",
  "addressRegion": "string",
  "addressCity": "string",
  "addressIndex": "string",
  "address": "string",
  "customerFirstName": "string",
  "customerLastName": "string",
  "customerMiddleName": "string",
  "customerEmail": "string",
  "customerPhone": "string",
  "deliveryType": "string",
  "deliveryPostamatId": 0
}
```
```

--------------------------------

### Create Constructor Layout (POST)

Source: https://rest.vsemayki.ru/doc/api

Creates a new layout from the constructor. Requires an access token and item data. Returns the ID of the created layout or an error status.

```OpenAPI
{
  "post": {
    "tags": [
      "товар"
    ],
    "summary": "Создание макета из конструктора (new)",
    "parameters": [
      {
        "in": "query",
        "name": "access-token",
        "description": "Ключ доступа приложения",
        "required": true,
        "type": "string"
      },
      {
        "in": "body",
        "name": "item_data",
        "description": "Данные для создание нового товара",
        "required": true,
        "schema": {
          "$ref": "#/definitions/CartConstructorItemData"
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Ид созданного макета",
        "schema": {
          "$ref": "#/definitions/CartConstructorItem"
        }
      },
      "400": {
        "description": "Неверный формат запроса",
        "schema": {
          "$ref": "#/definitions/ErrorStatus"
        }
      },
      "500": {
        "description": "Ошибка обработки запроса",
        "schema": {
          "$ref": "#/definitions/ErrorStatus"
        }
      }
    },
    "security": [
      {
        "access_token": [
          "order"
        ]
      }
    ]
  }
}
```

--------------------------------

### POST /pricing/constructor

Source: https://rest.vsemayki.ru/doc/api

Calculates the price for a custom-built product. This is used for items assembled from various components.

```APIDOC
## POST /pricing/constructor

### Description
Calculates the price for a custom-built product.

### Method
POST

### Endpoint
/pricing/constructor

### Parameters
#### Request Body
- **body** (object) - Required - Contains the details of the constructor item.
  - **item** (object) - Required - The constructor item details.
    - (Schema defined in `#/definitions/ConstructorCartItem`)

### Request Example
(Schema defined in `#/definitions/ConstructorCartItem`)

### Response
#### Success Response (200)
- **(object)** - The cart item with its calculated price. Defined by `#/definitions/CartItem`.

#### Response Example
```json
{
  "item_id": "constructor_item_1",
  "price": 1500,
  "currency": "RUB"
}
```
```

--------------------------------

### GET /user/orders/{orderId}

Source: https://rest.vsemayki.ru/doc/api

Retrieves detailed information about a specific user order.

```APIDOC
## GET /user/orders/{orderId}

### Description
Retrieves detailed information about a specific user order.

### Method
GET

### Endpoint
/user/orders/{orderId}

### Parameters
#### Path Parameters
- **orderId** (integer) - Required - The ID of the order.

#### Query Parameters
- **access-token** (string) - Required - The application access token.

### Request Example
```
GET /user/orders/123?access-token=YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **Order** (object) - Contains the order details.

#### Response Example
(Schema reference: #/definitions/Order)
```

--------------------------------

### Discount Documentation

Source: https://rest.vsemayki.ru/doc/api

This section details the structure and properties of a 'Discount' object, used for defining promotional offers.

```APIDOC
## Discount Documentation

### Description
Defines the structure for discount objects, used to specify promotional offers with various conditions and types.

### Object Definition
**Discount**

*   **name** (string) - Required - The name of the discount.
*   **description** (string) - Optional - A description of the discount.
*   **action_type** (string) - Optional - The type of promotion. Enum: [1 (for order), 2 (for delivery), 3 (for order items), 4 (for constructor items)].
*   **min_order_price** (string) - Optional - The minimum order price required for the discount.
*   **show_partner** (string) - Optional - Indicates if the discount is available for partners. Enum: [true, false].
*   **is_certificate** (string) - Optional - Indicates if the offer is a certificate. Enum: [0 (no), 1 (yes)].
```

--------------------------------

### GET /proxy-seo/v1/seo/{id}

Source: https://rest.vsemayki.ru/doc/api

Retrieves detailed information for a specific SEO page.

```APIDOC
## GET /proxy-seo/v1/seo/{id}

### Description
Retrieves detailed information for a specific SEO page.

### Method
GET

### Endpoint
/proxy-seo/v1/seo/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the SEO record.

#### Query Parameters
- **access-token** (string) - Required - Application access key.

### Response
#### Success Response (200)
- **SeoModel** (object) - Detailed information about the SEO page.
  - **id** (integer) - The ID of the SEO page.
  - **shop_id** (integer) - The ID of the shop.
  - **title** (string) - The title of the SEO page.
  - **uri** (string) - The URI of the SEO page.
  - **description** (string) - The meta description.
  - **keywords** (string) - The meta keywords.
  - **created_at** (string) - The creation timestamp.
  - **updated_at** (string) - The last update timestamp.

#### Response Example
```json
{
  "id": 1,
  "shop_id": 10,
  "title": "Homepage",
  "uri": "/",
  "description": "Welcome to Vsemayki! Find unique prints and clothing.",
  "keywords": "vsemayki, prints, t-shirts, clothing",
  "created_at": "2023-01-01T10:00:00Z",
  "updated_at": "2023-01-01T10:00:00Z"
}
```
```

--------------------------------

### User Registration

Source: https://rest.vsemayki.ru/doc/api

Register a new user with email, password, and phone number.

```APIDOC
## POST /register

### Description
Registers a new user providing their credentials.

### Method
POST

### Endpoint
/register

### Parameters
#### Request Body
- **client_id** (string) - Required - Application identifier.
- **client_secret** (string) - Required - Application secret key.
- **grant_type** (string) - Required - Must be 'password' for user authorization.
- **password** (string) - Required - User's password.
- **email** (string) - Required - User's email address.
- **phone** (string) - Required - User's phone number.

### Request Example
```json
{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "grant_type": "password",
  "password": "user_password",
  "email": "user@example.com",
  "phone": "+1234567890"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - Authentication token.
- **expires_in** (integer) - Token validity period in seconds.
- **scope** (string) - Available scopes.
- **refrest_token** (string) - Token for renewal.

#### Response Example
```json
{
  "access_token": "your_access_token",
  "expires_in": 3600,
  "scope": "read write",
  "refrest_token": "your_refresh_token"
}
```
```

--------------------------------

### GET /proxy-seo/v1/seo

Source: https://rest.vsemayki.ru/doc/api

Retrieves a list of SEO pages with filtering and sorting options.

```APIDOC
## GET /proxy-seo/v1/seo

### Description
Retrieves a list of SEO pages with filtering and sorting options.

### Method
GET

### Endpoint
/proxy-seo/v1/seo

### Parameters
#### Query Parameters
- **access-token** (string) - Required - Application access key.
- **filter[field(:modifier)]** (string) - Optional - Filter by one or more fields. Supports dot notation for nested fields and modifiers like `eq` (equal, default), `in` (includes), `ex` (excludes). Example: `filter[title]=value`, `filter[uri:ex]=/catalog`, `filter[domain:in]=vsemayki.ru`. Special characters must be URL-encoded.
- **with** (string) - Optional - Comma-separated list of additional fields to return from `data` (e.g., `with=field1,field2`).
- **limit** (integer) - Optional - The number of rows to return. Defaults to 20.
- **offset** (integer) - Optional - The number of rows to skip. Defaults to 0.

### Response
#### Success Response (200)
- **SeoModelShort** (array) - An array of short SEO page objects.

#### Response Example
```json
[
  {
    "id": 1,
    "shop_id": 10,
    "title": "Homepage",
    "uri": "/"
  }
]
```
```

--------------------------------

### POST /user/set-video-seen

Source: https://rest.vsemayki.ru/doc/api

Marks all video tutorials as viewed by a designer.

```APIDOC
## POST /user/set-video-seen

### Description
Marks all video tutorials as viewed by a designer.

### Method
POST

### Endpoint
/user/set-video-seen

### Parameters
#### Query Parameters
- **access-token** (string) - Required - The application access token.

### Request Example
```
POST /user/set-video-seen?access-token=YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **UserProfile** (object) - Contains the user's profile data.

#### Response Example
(Schema reference: #/definitions/UserProfile)
```
Tokens:
Raw