Skip to content

Cashback settings ​

INFO

Har bir javob umumiy konvertda qaytadi — code, message, messages, status_code, time — foydali yuk esa data ichida. Quyidagi jadvallar faqat data ichini tavsiflaydi.

POST /cashback-setting/create ​

This method allows adding cashback-settings into the account.

So‘rov tanasi

MaydonTurMajburiyTavsif
typestringHaMumkin qiymatlar: by_amount, all. Standart: "by_amount"
is_activebooleanHaStandart: true
organization_idstringHa
organization_idsstring[]Yo‘q
cashbacksobject[]Ha
cashbacks[].cashback_typestringHaMumkin qiymatlar: percent, cash. Standart: "percent"
cashbacks[].min_amountnumberYo‘q
cashbacks[].amountnumberHa
cashbacks[].percentnumberHa
cashbacks[].currency_idstringHa
json
{
  "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"
    }
  ]
}

Javob

MaydonTurTavsif
typestringMumkin qiymatlar: all, by_amount
is_activebooleanStandart: false
organization_idstring
cashbacksobject[]
cashbacks[].cashback_typestringMumkin qiymatlar: percent, cash
cashbacks[].min_amountnumber
cashbacks[].amountnumber
cashbacks[].percentnumber
cashbacks[].currency_idstring
json
{
  "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.

So‘rov tanasi

MaydonTurMajburiyTavsif
_idstringHa
typestringHaMumkin qiymatlar: by_amount, all. Standart: "by_amount"
is_activebooleanHaStandart: true
organization_idstringHa
organization_idsstring[]Yo‘q
cashbacksobject[]Ha
cashbacks[].cashback_typestringHaMumkin qiymatlar: percent, cash. Standart: "percent"
cashbacks[].min_amountnumberYo‘q
cashbacks[].amountnumberHa
cashbacks[].percentnumberHa
cashbacks[].currency_idstringHa
json
{
  "_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"
    }
  ]
}

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /cashback-setting/create.

DELETE /cashback-setting/delete/{id} ​

Delete a cashback-settings

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

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

GET /cashback-setting/get-all ​

Get all cashback-settings

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "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

Yo‘l parametrlari

ParametrTurMajburiyTavsif
idstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /cashback-setting/create.

GET /cashback-setting/get-deleted ​

Get deleted cashback-settings ids

So‘rov parametrlari

ParametrTurMajburiyTavsif
deleted_atstringHa

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

json
{
  "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

Yo‘l parametrlari

ParametrTurMajburiyTavsif
organization_idstringHaorganization_id

So‘rov tanasi

So‘rov tanasi talab qilinmaydi.

Javob

Javob tuzilishi quyidagi bilan bir xil: POST /cashback-setting/create.


Bu sahifa OpenAPI spetsifikatsiyasidan yaratilgan.

Bito 2.0 Integration API