Обновление скидки

Обновляет скидку.

Request

PATCH

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

Body

application/json

{
  "title": "Скидка 10%",
  "discount_value": {
    "value": "10.00",
    "type": "PERCENT"
  },
  "discount_dates": {
    "start_date": "2020-01-01T00:00:00Z",
    "end_date": "2020-01-01T00:00:00Z"
  },
  "status": "ACTIVE",
  "binding_mode": "ALL_VARIANTS"
}

Name	Description
binding_mode	Type: DiscountBindingModeForUpdate Изменение режима применения скидки: `ALL_VARIANTS` — скидка применяется ко всем товарам магазина. `SELECTED_VARIANTS` — скидка применяется к определенным объектам. Чтобы выбрать режим `SELECTED_CATEGORIES_COLLECTIONS`, добавьте к скидке сущности категорий или коллекций. При этом скидка не должна иметь привязанных товаров. Enum: `ALL_VARIANTS`, `SELECTED_VARIANTS`
discount_dates	Type: DiscountDates Информация о датах действия скидки. Example `{ "start_date": "2020-01-01T00:00:00Z", "end_date": "2020-01-01T00:00:00Z" }`
discount_value	Type: DiscountValue Информация о значении скидки и о типе скидки. Example `{ "value": "10.00", "type": "PERCENT" }`
status	Type: DiscountNotArchivedStatus Статус скидки: `ACTIVE` — активная скидка. `INACTIVE` — неактивная скидка. Enum: `ACTIVE`, `INACTIVE`
title	Type: string Название скидки. Example: `Скидка 10%`

DiscountValue

Информация о значении скидки и о типе скидки.

Name

Description

type

Type: string

Тип скидки:

PERCENT — скидка в процентах от цены товара.
VALUE — скидка в абсолютном значении (в рублях).

Enum: PERCENT, VALUE

value

Type: string<decimal>

Для типа PERCENT — значение от 0 до 100 (например, 10.5).
Для типа VALUE — сумма в рублях (например, 500.00).

Example: 10.00

Example

{
  "value": "10.00",
  "type": "PERCENT"
}

DiscountDates

Информация о датах действия скидки.

Name

Description

start_date

Type: string<date-time>

Дата начала действия скидки.

Example: 2020-01-01T00:00:00Z

end_date

Type: string<date-time>

Дата окончания действия скидки. Если не указана, то скидка действует бесконечно.

Example: 2020-01-01T00:00:00Z

Example

{
  "start_date": "2020-01-01T00:00:00Z",
  "end_date": "2020-01-01T00:00:00Z"
}

DiscountNotArchivedStatus

Статус скидки:

ACTIVE — активная скидка.
INACTIVE — неактивная скидка.

Type: string

Enum: ACTIVE, INACTIVE

DiscountBindingModeForUpdate

Изменение режима применения скидки:

ALL_VARIANTS — скидка применяется ко всем товарам магазина.
SELECTED_VARIANTS — скидка применяется к определенным объектам.

Чтобы выбрать режим SELECTED_CATEGORIES_COLLECTIONS, добавьте к скидке сущности категорий или коллекций. При этом скидка не должна иметь привязанных товаров.

Type: string

Enum: ALL_VARIANTS, SELECTED_VARIANTS

Responses

200 OK

Скидка успешно обновлена.

Body

application/json

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "title": "Скидка 10%",
  "discount_value": {
    "value": "10.00",
    "type": "PERCENT"
  },
  "discount_dates": {
    "start_date": "2020-01-01T00:00:00Z",
    "end_date": "2020-01-01T00:00:00Z"
  },
  "status": "ACTIVE",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "binding_mode": "ALL_VARIANTS"
}

Name	Description
binding_mode	Type: DiscountBindingMode Режим применения скидки: `ALL_VARIANTS` — скидка применяется ко всем товарам магазина. `SELECTED_VARIANTS` — скидка применяется к выбранным товарам. `SELECTED_CATEGORIES_COLLECTIONS` — скидка применяется к товарам из выбранных категорий и коллекций. Enum: `ALL_VARIANTS`, `SELECTED_VARIANTS`, `SELECTED_CATEGORIES_COLLECTIONS`
created_at	Type: string<date-time> Дата создания скидки. Example: `2020-01-01T00:00:00Z`
discount_dates	Type: DiscountDates Информация о датах действия скидки. Example `{ "start_date": "2020-01-01T00:00:00Z", "end_date": "2020-01-01T00:00:00Z" }`
discount_value	Type: DiscountValue Информация о значении скидки и о типе скидки. Example `{ "value": "10.00", "type": "PERCENT" }`
id	Type: DiscountID Идентификатор скидки. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
status	Type: DiscountStatus Статус скидки: `ACTIVE` — активная скидка. `INACTIVE` — неактивная скидка. `ARCHIVED` — архивированная скидка. Enum: `ACTIVE`, `INACTIVE`, `ARCHIVED`
title	Type: string Название скидки. Example: `Скидка 10%`
updated_at	Type: string<date-time> Дата последнего обновления скидки. Example: `2020-01-01T00:00:00Z`

DiscountID

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

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

DiscountStatus

Статус скидки:

ACTIVE — активная скидка.
INACTIVE — неактивная скидка.
ARCHIVED — архивированная скидка.

Type: string

Enum: ACTIVE, INACTIVE, ARCHIVED

DiscountBindingMode

Режим применения скидки:

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

Type: string

Enum: ALL_VARIANTS, SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

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`

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

Получение скидки по ID

Получение идентификаторов категорий для которых применяется скидка