Aktion aktivieren oder deaktivieren

POST/api/crm/v2/special_offers_list.toggle_statusv2

operationId: specialOffersList.toggleStatus

Aktiviert oder deaktiviert ein Special Offer. Wenn das Special Offer mit einem Startdatum in der Vergangenheit aktiviert wird, wird das Startdatum auf den aktuellen Zeitpunkt gesetzt.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Die Filiale, in der die Anfrage ausgeführt wird. Ein Partner mit mehreren Filialen muss diesen Parameter angeben, andernfalls wird die Anfrage mit einem Fehler abgelehnt. Bei einem Partner mit nur einer Filiale wird dieser Wert vom Server automatisch gesetzt.

Beispiel: 8778

Anfragetext `application/json`

object

idintegererforderlich

Beispiel: 1

activebooleanerforderlich

Beispiel: true

Antworten

object (Response)

statusstringerforderlich

Werte:successerror

Beispiel: success

Eine der Optionen

object

Fehlerinformationen

errorobjecterforderlich

codeintegererforderlich

Fehlercode

variablesobject

descriptionstringerforderlich

Fehlerbeschreibung

object

Datenarray (Struktur abhängig von der Aktion, siehe Beispiele)

dataobjecterforderlich

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

<?php

$client = new \GuzzleHttp\Client();

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

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/special_offers_list.toggle_status", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "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.ru/api/crm/v2/special_offers_list.toggle_status",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "de",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Antwort 200

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

Anfragen werden an foodsoul.ru gesendet – dies ist der Host dieses Portals, ein anderer kann nicht ausgewählt werden.

Aktion aktivieren oder deaktivieren

Autorisierung

Abfrageparameter

Anfragetext application/json

Antworten

Anfragetext `application/json`