Обновление услуги

Обновляет существующую услугу.

Request

PATCH

https://api.kit.yandex.net/v1/addons/{id}

Body

application/json

{
  "title": "Установка и настройка",
  "description": "Полная установка оборудования",
  "price": "2000.00",
  "final_price": "1500.00",
  "is_price_enabled": true,
  "vat": 22,
  "binding_mode": "ALL_VARIANTS",
  "attachments": [
    {
      "file_id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Инструкция по установке",
      "display_sequence": 1,
      "extension": "pdf"
    }
  ],
  "geography": {
    "included_region_ids": [
      225,
      1
    ],
    "excluded_region_ids": [
      213
    ]
  }
}

Name	Description
attachments	Type: AddonAttachmentCreateCommand[] Вложения услуги. Max items: `10` Example `[ { "file_id": "123e4567-e89b-12d3-a456-426614174000", "title": "Инструкция по установке", "display_sequence": 1, "extension": "pdf" } ]`
binding_mode	Type: AddonBindingMode Режим привязки услуги: `ALL_VARIANTS` — услуга доступна для всех товаров. `SELECTED_VARIANTS` — услуга доступна для выбранных товаров. `SELECTED_CATEGORIES_COLLECTIONS` — услуга доступна для товаров из выбранных категорий и коллекций. Enum: `ALL_VARIANTS`, `SELECTED_VARIANTS`, `SELECTED_CATEGORIES_COLLECTIONS`
description	Type: string Описание услуги. Example: `Полная установка оборудования`
final_price	Type: string<decimal> Цена со скидкой. Example: `1500.00`
geography	Type: AddonGeographyNullable Example `{ "included_region_ids": [ 225, 1 ], "excluded_region_ids": [ 213 ] }`
is_price_enabled	Type: boolean Отображать ли цену услуги.
price	Type: string<decimal> Цена без скидки. Example: `2000.00`
title	Type: string Название услуги. Example: `Установка и настройка`
vat	Type: integer НДС в процентах. Специальное значение -1 означает, что товар не облагается НДС.

AddonBindingMode

Режим привязки услуги:

ALL_VARIANTS — услуга доступна для всех товаров.
SELECTED_VARIANTS — услуга доступна для выбранных товаров.
SELECTED_CATEGORIES_COLLECTIONS — услуга доступна для товаров из выбранных категорий и коллекций.

Type: string

Enum: ALL_VARIANTS, SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

AddonAttachmentCreateCommand

Name	Description
display_sequence	Type: integer Порядок отображения.
extension	Type: string Расширение файла. Example: `pdf`
file_id	Type: string<uuid> Идентификатор файла. Example: `123e4567-e89b-12d3-a456-426614174000`
title	Type: string Название вложения. Example: `Инструкция по установке`

Example

{
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Инструкция по установке",
  "display_sequence": 1,
  "extension": "pdf"
}

AddonGeography

География доступности услуги.

Name

Description

excluded_region_ids

Type: integer[]

Идентификаторы регионов, в которых услуга недоступна.

Example

[
  213
]

included_region_ids

Type: integer[]

Идентификаторы регионов, в которых услуга доступна.

Min items: 1

Example

[
  225,
  1
]

Example

{
  "included_region_ids": [
    225,
    1
  ],
  "excluded_region_ids": [
    213
  ]
}

AddonGeographyNullable

All of 1 type

Type: AddonGeography

География доступности услуги.

Example

{
  "included_region_ids": [
    225,
    1
  ],
  "excluded_region_ids": [
    213
  ]
}

Example

{
  "included_region_ids": [
    225,
    1
  ],
  "excluded_region_ids": [
    213
  ]
}

Responses

200 OK

Услуга успешно обновлена.

Body

application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "number": 12345,
  "title": "Установка и настройка",
  "description": "Полная установка оборудования",
  "price": "2000.00",
  "final_price": "1500.00",
  "is_price_enabled": false,
  "vat": 22,
  "binding_mode": "ALL_VARIANTS",
  "attachments": [
    {
      "file_id": "123e4567-e89b-12d3-a456-426614174000",
      "title": "Инструкция по установке",
      "display_sequence": 1,
      "extension": "pdf",
      "public_path": "https://storage.example.com/documents/instruction.pdf"
    }
  ],
  "geography": {
    "included_region_ids": [
      225,
      1
    ],
    "excluded_region_ids": [
      213
    ]
  },
  "created_at": "2023-01-15T10:30:00Z"
}

Name	Description
attachments	Type: AddonAttachment[] Вложения услуги. Example `[ { "file_id": "123e4567-e89b-12d3-a456-426614174000", "title": "Инструкция по установке", "display_sequence": 1, "extension": "pdf", "public_path": "https://storage.example.com/documents/instruction.pdf" } ]`
binding_mode	Type: AddonBindingMode Режим привязки услуги: `ALL_VARIANTS` — услуга доступна для всех товаров. `SELECTED_VARIANTS` — услуга доступна для выбранных товаров. `SELECTED_CATEGORIES_COLLECTIONS` — услуга доступна для товаров из выбранных категорий и коллекций. Enum: `ALL_VARIANTS`, `SELECTED_VARIANTS`, `SELECTED_CATEGORIES_COLLECTIONS`
created_at	Type: string<date-time> Дата создания. Example: `2023-01-15T10:30:00Z`
description	Type: string Описание услуги. Example: `Полная установка оборудования`
final_price	Type: string<decimal> Цена со скидкой. Example: `1500.00`
geography	Type: AddonGeography География доступности услуги. Example `{ "included_region_ids": [ 225, 1 ], "excluded_region_ids": [ 213 ] }`
id	Type: AddonID Идентификатор услуги. Example: `123e4567-e89b-12d3-a456-426614174000`
is_price_enabled	Type: boolean Отображать ли цену услуги.
number	Type: integer Уникальный числовой идентификатор услуги.
price	Type: string<decimal> Цена до скидки. Example: `2000.00`
title	Type: string Название услуги. Example: `Установка и настройка`
vat	Type: integer НДС в процентах. Специальное значение -1 означает, что товар не облагается НДС.

AddonID

Идентификатор услуги.

Type: string<uuid>

Example: 123e4567-e89b-12d3-a456-426614174000

AddonAttachment

Приложение к услуге.

Name	Description
display_sequence	Type: integer Порядок отображения.
extension	Type: string Расширение файла. Example: `pdf`
file_id	Type: string<uuid> Идентификатор файла. Example: `123e4567-e89b-12d3-a456-426614174000`
public_path	Type: string Публичный URL файла. Example: `https://storage.example.com/documents/instruction.pdf`
title	Type: string Название вложения. Example: `Инструкция по установке`

Example

{
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Инструкция по установке",
  "display_sequence": 1,
  "extension": "pdf",
  "public_path": "https://storage.example.com/documents/instruction.pdf"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Удаление услуги

Получение уникальных идентификаторов товаров услуги