Creare una categoria

POST/api/crm/v2/categories.addv2

operationId: categories.add

Crea una categoria. L'indirizzo SEO viene generato automaticamente e verificato per unicità. I flag di pubblicazione, sconti, importo minimo e consegna gratuita sono abilitati per impostazione predefinita.

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idintegerobbligatorio

Esempio: 1

Corpo della richiesta `application/json`

object

nameobject (TranslationField) obbligatorio

Campo traducibile del catalogo; la struttura è identica sia nella risposta che nella richiesta.
Alla creazione, ogni lingua della rete assente in translations rimane vuota e viene messa in coda per la traduzione AI.
In caso di modifica, vengono salvate solo le lingue presenti in translations: una lingua assente nell’oggetto mantiene il valore precedente, se l’originale non è cambiato; un valore vuoto cancella la traduzione e la mette in coda per la traduzione AI.
La modifica dell’originale cancella le traduzioni che arrivano senza modifiche — non corrispondono più all’originale; una traduzione inviata con un valore diverso viene salvata come correzione manuale. Questa cancellazione avviene solo se la traduzione automatica è attiva nella rete.
Un valore in una lingua non pubblicata viene rifiutato; un valore in una lingua non inclusa nell’insieme delle lingue della rete viene ignorato.

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Esempio: ru

translationsobjectobbligatorio

Valore per codice lingua; nessuna traduzione — nessuna chiave

Valori del dizionario

string

date_availablestring (DataTimeFormat)

Esempio: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Esempio: 17:45 06/05/2024

days_of_weekarray of integerobbligatorio

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

curl -X POST 'https://foodsoul.pro/api/crm/v2/categories.add?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: it' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"name":{"default":"ru","translations":{"ru":"Пицца","en":"Pizza"}},"date_available":"17:45 06/05/2024","date_expiration":"17:45 06/05/2024","days_of_week":[1],"time_periods":["11:24 - 12:34"],"hide_for_districts_ids":[1],"hide_for_pickups_ids":[1],"parent_id":1}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/categories.add?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'it',
        'role' => 'partner',
    ],
    'json' => [
        'name' => [
            'default' => 'ru',
            'translations' => [
                'ru' => 'Пицца',
                'en' => 'Pizza',
            ],
        ],
        'date_available' => '17:45 06/05/2024',
        'date_expiration' => '17:45 06/05/2024',
        'days_of_week' => [
            1,
        ],
        'time_periods' => [
            '11:24 - 12:34',
        ],
        'hide_for_districts_ids' => [
            1,
        ],
        'hide_for_pickups_ids' => [
            1,
        ],
        'parent_id' => 1,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/categories.add?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "it",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "name": {
            "default": "ru",
            "translations": {
                "ru": "Пицца",
                "en": "Pizza"
            }
        },
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "days_of_week": [
            1
        ],
        "time_periods": [
            "11:24 - 12:34"
        ],
        "hide_for_districts_ids": [
            1
        ],
        "hide_for_pickups_ids": [
            1
        ],
        "parent_id": 1
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/categories.add?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "it",
        "role": "partner",
    },
    json={
        "name": {
            "default": "ru",
            "translations": {
                "ru": "Пицца",
                "en": "Pizza",
            },
        },
        "date_available": "17:45 06/05/2024",
        "date_expiration": "17:45 06/05/2024",
        "days_of_week": [
            1,
        ],
        "time_periods": [
            "11:24 - 12:34",
        ],
        "hide_for_districts_ids": [
            1,
        ],
        "hide_for_pickups_ids": [
            1,
        ],
        "parent_id": 1,
    },
)
data = response.json()

Risposta 200

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

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

Creare una categoria

Autorizzazione

Parametri della richiesta

Corpo della richiesta application/json

Risposte

Corpo della richiesta `application/json`