Alterar configurações do sistema de bônus

POST/api/crm/v2/bonuses_settings.updatev2

operationId: bonusesSettings.update

Altera as configurações do sistema de bônus. Se automation estiver ativado, o servidor força enable para true, referral para false e define os valores de bônus por registro, aniversário e avaliação como 0. Para uma rede filial, o parâmetro common é ignorado. Um campo não enviado é salvo como 0. Erros: 121 — valor não é um número, 122 — valor abaixo do mínimo, 124 — valor fora do intervalo permitido.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idintegerobrigatório

Exemplo: 7156

Corpo da solicitação `application/json`

object

automationboolean

Exemplo: true

enableboolean

Exemplo: true

commonboolean

Se ativado (pode ser true para uma rede filha), os demais campos, exceto automation, ficam ocultos

Exemplo: true

hide_accrualboolean

Exemplo: true

minimum_sumboolean

Exemplo: true

rules_accrual_registrationnumber

Se common e automation estiverem desativados

Exemplo: 0

rules_accrual_itemsnumber

Percentual do preço do produto a ser creditado em bônus; valores fracionários são permitidos

Exemplo: 0

rules_withdraw_itemsnumber

Percentual do valor dos produtos que pode ser pago com bônus; valores fracionários são permitidos

Exemplo: 0

rules_accrual_birthdaynumber

Se common e automation estiverem desativados

Exemplo: 0

rules_accrual_feedbacknumber

Exemplo: 0

free_deliveryboolean

Exemplo: true

rules_accrual_withdrawboolean

Exemplo: true

rules_accrual_decreaseboolean

Exemplo: true

referralboolean

Se common e automation estiverem desativados

Exemplo: true

rules_accrual_referral_pyramidboolean

Se common e automation estiverem desativados

Exemplo: true

rules_accrual_referral_invitednumber

Se common e automation estiverem desativados

Exemplo: 0

rules_accrual_referral_inviternumber

Se common e automation estiverem desativados

Exemplo: 0

rules_accrual_referral_percentnumber

Percentual dos créditos do cliente indicado transferido para o indicador; valores fracionários são permitidos; aplicável quando common e automation estão desativados

Exemplo: 0

rules_validity_itemsinteger

Se common e automation estiverem desativados

Exemplo: 0

rules_validity_feedbackinteger

Se common e automation estiverem desativados

Exemplo: 0

rules_validity_birthdayinteger

Se common e automation estiverem desativados

Exemplo: 0

rules_validity_registrationinteger

Se common e automation estiverem desativados

Exemplo: 0

rules_validity_referralinteger

Se common e automation estiverem desativados

Exemplo: 0

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/bonuses_settings.update?chain_id=7156' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"automation":true,"enable":true,"common":true,"hide_accrual":true,"minimum_sum":true,"rules_accrual_registration":0,"rules_accrual_items":0,"rules_withdraw_items":0,"rules_accrual_birthday":0,"rules_accrual_feedback":0,"free_delivery":true,"rules_accrual_withdraw":true,"rules_accrual_decrease":true,"referral":true,"rules_accrual_referral_pyramid":true,"rules_accrual_referral_invited":0,"rules_accrual_referral_inviter":0,"rules_accrual_referral_percent":0,"rules_validity_items":0,"rules_validity_feedback":0,"rules_validity_birthday":0,"rules_validity_registration":0,"rules_validity_referral":0}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/bonuses_settings.update?chain_id=7156', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'automation' => true,
        'enable' => true,
        'common' => true,
        'hide_accrual' => true,
        'minimum_sum' => true,
        'rules_accrual_registration' => 0,
        'rules_accrual_items' => 0,
        'rules_withdraw_items' => 0,
        'rules_accrual_birthday' => 0,
        'rules_accrual_feedback' => 0,
        'free_delivery' => true,
        'rules_accrual_withdraw' => true,
        'rules_accrual_decrease' => true,
        'referral' => true,
        'rules_accrual_referral_pyramid' => true,
        'rules_accrual_referral_invited' => 0,
        'rules_accrual_referral_inviter' => 0,
        'rules_accrual_referral_percent' => 0,
        'rules_validity_items' => 0,
        'rules_validity_feedback' => 0,
        'rules_validity_birthday' => 0,
        'rules_validity_registration' => 0,
        'rules_validity_referral' => 0,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/bonuses_settings.update?chain_id=7156", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "automation": true,
        "enable": true,
        "common": true,
        "hide_accrual": true,
        "minimum_sum": true,
        "rules_accrual_registration": 0,
        "rules_accrual_items": 0,
        "rules_withdraw_items": 0,
        "rules_accrual_birthday": 0,
        "rules_accrual_feedback": 0,
        "free_delivery": true,
        "rules_accrual_withdraw": true,
        "rules_accrual_decrease": true,
        "referral": true,
        "rules_accrual_referral_pyramid": true,
        "rules_accrual_referral_invited": 0,
        "rules_accrual_referral_inviter": 0,
        "rules_accrual_referral_percent": 0,
        "rules_validity_items": 0,
        "rules_validity_feedback": 0,
        "rules_validity_birthday": 0,
        "rules_validity_registration": 0,
        "rules_validity_referral": 0
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/bonuses_settings.update?chain_id=7156",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "automation": True,
        "enable": True,
        "common": True,
        "hide_accrual": True,
        "minimum_sum": True,
        "rules_accrual_registration": 0,
        "rules_accrual_items": 0,
        "rules_withdraw_items": 0,
        "rules_accrual_birthday": 0,
        "rules_accrual_feedback": 0,
        "free_delivery": True,
        "rules_accrual_withdraw": True,
        "rules_accrual_decrease": True,
        "referral": True,
        "rules_accrual_referral_pyramid": True,
        "rules_accrual_referral_invited": 0,
        "rules_accrual_referral_inviter": 0,
        "rules_accrual_referral_percent": 0,
        "rules_validity_items": 0,
        "rules_validity_feedback": 0,
        "rules_validity_birthday": 0,
        "rules_validity_registration": 0,
        "rules_validity_referral": 0,
    },
)
data = response.json()

Resposta 200

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

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

Alterar configurações do sistema de bônus

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`