Creditar ou debitar bônus

POST/api/crm/v2/clients_bonuses.addv2

operationId: clientsBonuses.add

Executa a adição manual (type=accrual) ou retirada (type=withdraw) de bônus: com mode=one — para um cliente pelo phone_format_id e phone_number, com mode=all — para todos os clientes da rede, podendo filtrar por gender se necessário. As datas são convertidas para UTC conforme o fuso horário do ponto de venda. Indisponível enquanto a automação do sistema estiver ativada; o cliente deve ter bônus habilitados. A adição em massa retorna not_accrualed_for_phones — telefones para os quais a operação falhou.

Autorização

api-token + language + role

Corpo da solicitação `application/json`

object

modestringobrigatório

Valores:oneall

typestringobrigatório

Valores:accrualwithdraw

chain_idintegerobrigatório

Exemplo: 7124

date_availablestring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

descriptionstring

Para type=accrual

sumnumberobrigatório

Exemplo: 125.5

phone_format_idinteger (PhoneFormatId)

Código do país: 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)

Exemplo: 1

phone_numberstring

Para mode=one

Exemplo: 999-999-99-99

genderstring

Para mode=all

Valores:manwoman

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/clients_bonuses.add' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -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.ru/api/crm/v2/clients_bonuses.add', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        '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.ru/api/crm/v2/clients_bonuses.add", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "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.ru/api/crm/v2/clients_bonuses.add",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "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()

Resposta 200

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

As solicitações são enviadas para foodsoul.ru — o host deste portal, não é possível escolher outro.

Creditar ou debitar bônus

Autorização

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`