get/v3/billing/api/merchant/special-offer

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

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

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

метод: POST
ресурс: /v3/billing/api/merchant/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" :"2026-08-12T12: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" : "2026-08-12T12:00:00Z",
      "finishAt" : "2029-01-01T23:59:59Z",
      "name" : "Скидка на День Рождения",
      "description" : "Скидка 15% на всё меню в день рождения",
      "tags" : [
         "birthday"
       ]
   }
}

Ответ (по схеме):

{
  "data": {
    "id": 1,
    "merchantId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "externalId": "01771534-1a57-f184-dee3-ebeb91dded75",
    "active": false,
    "startAt": "2026-08-03T12:00:00+03:00",
    "finishAt": "2026-08-03T12:00:00+03:00",
    "name": "string",
    "description": "string",
    "tags": {}
  },
  "metaData": {
    "totalCount": 1,
    "pageSize": 1,
    "page": 1
  },
  "extendedData": [
    {
      "type": "string",
      "data": {}
    }
  ]
}

CreateSpecialOfferRequest

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

SpecialOfferResponse

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

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

Параметры запроса — POST

Только обязательные5 обязательных из 8

ПолеТипОписание

merchantId *#string

externalId#string | null

active *#boolean

startAt *#stringdate-time

finishAt *#stringdate-time

name *#string

description#string | null

tags#ArrayMap | null

Параметры запроса — PUT

Только обязательные5 обязательных из 8

ПолеТипОписание

merchantId *#string

externalId#string | null

active *#boolean

startAt *#stringdate-time

finishAt *#stringdate-time

name *#string

description#string | null

tags#ArrayMap | null

Страница помогла?

Нужна помощь?Написать в поддержку Телеграм-канал

← НазадОбновление точки продаж

getПолучение списка спецДемо

curl -X GET 'https://api.invoicebox.ru/v3/billing/api/merchant/special-offer' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'

postСоздание специального предложения для магазинаДемо

curl -X POST 'https://api.invoicebox.ru/v3/billing/api/merchant/special-offer' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "merchantId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "active": true,
  "startAt": "2026-08-21T15:07:40+00:00",
  "finishAt": "2026-08-21T15:07:40+00:00",
  "name": "Бронирование номера",
  "description": "Оплата бронирования"
}'

Акции демо-магазина видны всем читателям, поэтому создавать их порталом нельзя.

putРедактирование специального предложенияДемо

id *

curl -X PUT 'https://api.invoicebox.ru/v3/billing/api/merchant/special-offer/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "merchantId": "ffffffff-ffff-ffff-ffff-ffffffffffff",
  "active": true,
  "startAt": "2026-08-21T15:07:40+00:00",
  "finishAt": "2026-08-21T15:07:40+00:00",
  "name": "Бронирование номера",
  "description": "Оплата бронирования"
}'

Акции демо-магазина общие — правка меняет их для всех читателей.

deleteУдаление специального предложенияДемо

id *

curl -X DELETE 'https://api.invoicebox.ru/v3/billing/api/merchant/special-offer/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'

Акции демо-магазина общие — удаление уберёт их у всех читателей.