Управление акциями и спецпредложениями магазина

Магазин может управлять набором акций и спецпредложений, которые будут отображены в маркетплейсе.

Для добавления или изменения спецпредложения, отправьте следующий запрос:

метод: POST
ресурс: /v3/marketplace/api/special-offer
тело запроса - объект CreateSpecialOfferRequest
тело ответа - объект SpecialOfferResponse
Возможные ошибки

Пример запроса и ответа

POST /special-offer
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
   "merchantId" : "ffffffff-ffff-ffff-ffff-ffffffffffff",
   "externalId" : "1234",
   "active" : true,
   "startAt" :"2023-01-01T12:00:00Z",
   "finishAt" :"2029-01-01T23:59:59Z",
   "name" : "Скидка на День Рождения",
   "description" : "Скидка 15% на всё меню в день рождения",
   "tags" : [
      "birthday"
   ]
}

{
   "data":{
      "id" : 123,
      "merchantId" : "ffffffff-ffff-ffff-ffff-ffffffffffff",
      "externalId" : "1234",
      "active" : true,
      "startAt" : "2023-01-01T12:00:00Z",
      "finishAt" : "2029-01-01T23:59:59Z",
      "name" : "Скидка на День Рождения",
      "description" : "Скидка 15% на всё меню в день рождения",
      "tags" : [
         "birthday"
       ]
   }
}

CreateSpecialOfferRequest

Свойство	Обязательное	Тип	Описание	Пример значения
merchantId	да	string(36)	Идентификатор магазина	`01771534-1a57-f184-dee3-ebeb91dded76`
externalId	да	string(36)	Идентификатор спецпредложения во внтуренней системе учёта магазина	`1234`
active	да	bool	Флаг активности спецпредложения	`true`
startAt	да	datetime	Время начала действия спецпредложения	`2023-01-01T12:00:00Z`
finishAt	да	datetime	Время окончания действия спецпредложения	`2029-01-01T23:59:59Z`
description	да	string(1000)	Описание	`Скидка 15% на всё меню в день рождения`
tags	да	array of string	Теги	`birthday`

SpecialOfferResponse

Повторяет свойства объекта CreateSpecialOfferRequest с дополнительными свойствами:

Свойство	Обязательное	Тип	Описание	Пример значения
id	да	int	Идентификатор спецпредложения в маркетплейсе	`123`