Cashback settings

INFO

Каждый ответ приходит в общем конверте — code, message, messages, status_code, time — а полезная нагрузка лежит в data. Таблицы ниже описывают содержимое data.

POST /cashback-setting/create

This method allows adding cashback-settings into the account.

Тело запроса

Поле	Тип	Обязательно	Описание
type	string	Да	Допустимые значения: by_amount, all. По умолчанию: "by_amount"
is_active	boolean	Да	По умолчанию: true
organization_id	string	Да
organization_ids	string[]	Нет
cashbacks	object[]	Да
cashbacks[].cashback_type	string	Да	Допустимые значения: percent, cash. По умолчанию: "percent"
cashbacks[].min_amount	number	Нет
cashbacks[].amount	number	Да
cashbacks[].percent	number	Да
cashbacks[].currency_id	string	Да

{
  "type": "by_amount",
  "is_active": true,
  "organization_id": "67b486d242ed76693cd2cc59",
  "organization_ids": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ],
  "cashbacks": [
    {
      "cashback_type": "percent",
      "min_amount": 0,
      "amount": 0,
      "percent": 0,
      "currency_id": "67b486d242ed76693cd2cc59"
    }
  ]
}

Ответ

Поле	Тип	Описание
type	string	Допустимые значения: all, by_amount
is_active	boolean	По умолчанию: false
organization_id	string
cashbacks	object[]
cashbacks[].cashback_type	string	Допустимые значения: percent, cash
cashbacks[].min_amount	number
cashbacks[].amount	number
cashbacks[].percent	number
cashbacks[].currency_id	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "type": "all",
    "is_active": false,
    "organization_id": "string",
    "cashbacks": [
      {
        "cashback_type": "percent",
        "min_amount": 0,
        "amount": 0,
        "percent": 0,
        "currency_id": "67b486d242ed76693cd2cc59"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /cashback-setting/update

This method allows updating cashback-settings in the account.

Тело запроса

Поле	Тип	Обязательно	Описание
_id	string	Да
type	string	Да	Допустимые значения: by_amount, all. По умолчанию: "by_amount"
is_active	boolean	Да	По умолчанию: true
organization_id	string	Да
organization_ids	string[]	Нет
cashbacks	object[]	Да
cashbacks[].cashback_type	string	Да	Допустимые значения: percent, cash. По умолчанию: "percent"
cashbacks[].min_amount	number	Нет
cashbacks[].amount	number	Да
cashbacks[].percent	number	Да
cashbacks[].currency_id	string	Да

{
  "_id": "63f8b0c4e4b0d3a2f8e4b0c4",
  "type": "by_amount",
  "is_active": true,
  "organization_id": "67b486d242ed76693cd2cc59",
  "organization_ids": [
    "63f8b0c4e4b0d3a2f8e4b0c4"
  ],
  "cashbacks": [
    {
      "cashback_type": "percent",
      "min_amount": 0,
      "amount": 0,
      "percent": 0,
      "currency_id": "67b486d242ed76693cd2cc59"
    }
  ]
}

Ответ

Структура ответа совпадает с POST /cashback-setting/create.

DELETE /cashback-setting/delete/{id}

Delete a cashback-settings

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /cashback-setting/get-all

Get all cashback-settings

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    {
      "type": "all",
      "is_active": false,
      "organization_id": "string",
      "cashbacks": [
        {
          "cashback_type": null,
          "min_amount": null,
          "amount": null,
          "percent": null,
          "currency_id": null
        }
      ]
    }
  ],
  "time": "2025-05-01T12:00:00Z"
}

GET /cashback-setting/get-by-id/{id}

Get cashback-settings using its _id

Параметры пути

Параметр	Тип	Обязательно	Описание
id	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /cashback-setting/create.

GET /cashback-setting/get-deleted

Get deleted cashback-settings ids

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

Параметр	Тип	Обязательно	Описание
deleted_at	string	Да

Тело запроса

Тело запроса не требуется.

Ответ

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

GET /cashback-setting/get-by-organization_id/{organization_id}

Get cashback-settings using organization_id

Параметры пути

Параметр	Тип	Обязательно	Описание
organization_id	string	Да	organization_id

Тело запроса

Тело запроса не требуется.

Ответ

Структура ответа совпадает с POST /cashback-setting/create.

---

Эта страница сгенерирована из спецификации OpenAPI.