Нарахувати або списати бонуси

POST/api/crm/v2/clients_bonuses.addv2

operationId: clientsBonuses.add

Виконує ручне нарахування (type=accrual) або списання (type=withdraw) бонусів: при mode=one — одному клієнту за phone_format_id та phone_number, при mode=all — всім клієнтам мережі, за потреби з відбором за gender. Дати переводяться в UTC за часовим поясом точки продажу. Недоступно, поки увімкнена системна автоматизація; у клієнта мають бути увімкнені бонуси. Масове нарахування повертає not_accrualed_for_phones — телефони, для яких операція не виконана.

Авторизація

api-token + language + role

Тіло запиту `application/json`

object

modestringобов’язковий

Значення:oneall

typestringобов’язковий

Значення:accrualwithdraw

chain_idintegerобов’язковий

Приклад: 7124

date_availablestring (DataTimeFormat)

Приклад: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Приклад: 17:45 06/05/2024

descriptionstring

Для type=accrual

sumnumberобов’язковий

Приклад: 125.5

phone_format_idinteger (PhoneFormatId)

Код країни: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Приклад: 1

phone_numberstring

Для mode=one

Приклад: 999-999-99-99

genderstring

Для mode=all

Значення:manwoman

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/clients_bonuses.add' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: uk' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"mode":"one","type":"accrual","chain_id":7124,"date_available":"17:45 06/05/2024","date_expiration":"17:45 06/05/2024","description":"string","sum":125.5,"phone_format_id":1,"phone_number":"999-999-99-99","gender":"man"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/clients_bonuses.add', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'uk',
        'role' => 'partner',
    ],
    'json' => [
        'mode' => 'one',
        'type' => 'accrual',
        'chain_id' => 7124,
        'date_available' => '17:45 06/05/2024',
        'date_expiration' => '17:45 06/05/2024',
        'description' => 'string',
        'sum' => 125.5,
        'phone_format_id' => 1,
        'phone_number' => '999-999-99-99',
        'gender' => 'man',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/clients_bonuses.add", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "mode": "one",
        "type": "accrual",
        "chain_id": 7124,
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "description": "string",
        "sum": 125.5,
        "phone_format_id": 1,
        "phone_number": "999-999-99-99",
        "gender": "man"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/clients_bonuses.add",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "uk",
        "role": "partner",
    },
    json={
        "mode": "one",
        "type": "accrual",
        "chain_id": 7124,
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "description": "string",
        "sum": 125.5,
        "phone_format_id": 1,
        "phone_number": "999-999-99-99",
        "gender": "man",
    },
)
data = response.json()

Відповідь 200

{
  "status": "success",
  "data": {}
}

Запити надсилаються на foodsoul.pro — це хост цього порталу, інший обрати неможливо.

Нарахувати або списати бонуси

Авторизація

Тіло запиту application/json

Відповіді

Тіло запиту `application/json`