Activer ou désactiver une offre spéciale

POST/api/crm/v2/special_offers_list.toggle_statusv2

operationId: specialOffersList.toggleStatus

Active ou désactive une offre spéciale. Si l'offre est activée avec une date de début antérieure, la date est déplacée à l'instant actuel.

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

La succursale dans laquelle la requête est effectuée. Un partenaire disposant de plusieurs succursales doit obligatoirement la transmettre, sinon la requête échoue. Pour un partenaire avec une seule succursale, le serveur la renseigne automatiquement.

Exemple: 8778

Corps de la requête `application/json`

object

idintegerobligatoire

Exemple: 1

activebooleanobligatoire

Exemple: true

Réponses

object (Response)

statusstringobligatoire

Valeurs:successerror

Exemple: success

L'une des options

object

Informations sur l’erreur

errorobjectobligatoire

codeintegerobligatoire

Code d’erreur

variablesobject

descriptionstringobligatoire

Description de l’erreur

object

Tableau de données (la structure dépend de l'action, voir les exemples)

dataobjectobligatoire

curl -X POST 'https://foodsoul.pro/api/crm/v2/special_offers_list.toggle_status' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: fr' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"id":1,"active":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/special_offers_list.toggle_status', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'fr',
        'role' => 'partner',
    ],
    'json' => [
        'id' => 1,
        'active' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/special_offers_list.toggle_status", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "id": 1,
        "active": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/special_offers_list.toggle_status",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "fr",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Réponse 200

{
  "error": {
    "code": 0,
    "variables": {},
    "description": "string"
  }
}

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

Activer ou désactiver une offre spéciale

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`