Modifier les paramètres du système de bonus

POST/api/crm/v2/bonuses_settings.updatev2

operationId: bonusesSettings.update

Modifie les paramètres du système de bonus. Si automation est activé, le serveur force enable à true, referral à false, et les attributions pour l'inscription, l'anniversaire et l'avis à 0. Pour un réseau enfant, le drapeau common est ignoré. Un champ non transmis est enregistré comme 0.
Erreurs : 121 — la valeur n'est pas un nombre, 122 — la valeur est inférieure au minimum, 124 — la valeur est hors de la plage autorisée.

Autorisation

api-token + language + role

Paramètres de requête

chain_idintegerobligatoire

Exemple: 7156

Corps de la requête `application/json`

object

automationboolean

Exemple: true

enableboolean

Exemple: true

commonboolean

Si activé (peut être true pour un réseau enfant), les autres champs, à l’exception de automation, sont masqués

Exemple: true

hide_accrualboolean

Exemple: true

minimum_sumboolean

Exemple: true

rules_accrual_registrationnumber

Si common et automation sont désactivés

Exemple: 0

rules_accrual_itemsnumber

Pourcentage du prix de l'article attribué en bonus ; les valeurs décimales sont autorisées

Exemple: 0

rules_withdraw_itemsnumber

Pourcentage du montant des articles pouvant être payé avec des bonus ; les valeurs décimales sont autorisées

Exemple: 0

rules_accrual_birthdaynumber

Si common et automation sont désactivés

Exemple: 0

rules_accrual_feedbacknumber

Exemple: 0

free_deliveryboolean

Exemple: true

rules_accrual_withdrawboolean

Exemple: true

rules_accrual_decreaseboolean

Exemple: true

referralboolean

Si common et automation sont désactivés

Exemple: true

rules_accrual_referral_pyramidboolean

Si common et automation sont désactivés

Exemple: true

rules_accrual_referral_invitednumber

Si common et automation sont désactivés

Exemple: 0

rules_accrual_referral_inviternumber

Si common et automation sont désactivés

Exemple: 0

rules_accrual_referral_percentnumber

Pourcentage des crédits du client invité transféré à l'invitant ; les valeurs décimales sont autorisées ; applicable si common et automation sont désactivés

Exemple: 0

rules_validity_itemsinteger

Si common et automation sont désactivés

Exemple: 0

rules_validity_feedbackinteger

Si common et automation sont désactivés

Exemple: 0

rules_validity_birthdayinteger

Si common et automation sont désactivés

Exemple: 0

rules_validity_registrationinteger

Si common et automation sont désactivés

Exemple: 0

rules_validity_referralinteger

Si common et automation sont désactivés

Exemple: 0

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: 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: fr' \
  -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' => 'fr',
        '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": "fr",
        "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": "fr",
        "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()

Réponse 200

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

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.

Modifier les paramètres du système de bonus

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`