Attivare o disattivare un'offerta

POST/api/crm/v2/special_offers_list.toggle_statusv2

operationId: specialOffersList.toggleStatus

Abilita o disabilita una promozione. Se la promozione viene abilitata con una data di inizio nel passato, la data viene aggiornata all’ora corrente.

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

La filiale in cui viene eseguita la richiesta. Un partner con più filiali è obbligato a specificarla, altrimenti la richiesta fallirà con un errore. Per un partner con una sola filiale, il server la imposta automaticamente.

Esempio: 8778

Corpo della richiesta `application/json`

object

idintegerobbligatorio

Esempio: 1

activebooleanobbligatorio

Esempio: true

Risposte

object (Response)

statusstringobbligatorio

Valori:successerror

Esempio: success

Una delle opzioni

object

Informazioni sull'errore

errorobjectobbligatorio

codeintegerobbligatorio

Codice di errore

variablesobject

descriptionstringobbligatorio

Descrizione dell'errore

object

Array di dati (la struttura dipende dall'azione, vedi esempi)

dataobjectobbligatorio

curl -X POST 'https://foodsoul.pro/api/crm/v2/special_offers_list.toggle_status' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: it' \
  -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' => 'it',
        '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": "it",
        "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": "it",
        "role": "partner",
    },
    json={
        "id": 1,
        "active": True,
    },
)
data = response.json()

Risposta 200

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

Le richieste vengono inviate a foodsoul.pro, che è l’host di questo portale; non è possibile sceglierne un altro.

Attivare o disattivare un'offerta

Autorizzazione

Parametri della richiesta

Corpo della richiesta application/json

Risposte

Corpo della richiesta `application/json`