Créer une catégorie

POST/api/crm/v2/categories.addv2

operationId: categories.add

Crée une catégorie. L'adresse SEO est générée automatiquement et vérifiée pour unicité. Les indicateurs de publication, de remises, de montant minimum et de livraison gratuite sont activés par défaut.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 1

Corps de la requête `application/json`

object

nameobject (TranslationField) obligatoire

Champ traduisible du catalogue ; structure identique dans la réponse et la requête.
Lors de la création, chaque langue du réseau absente de translations reste vide et est mise en file d’attente pour une traduction automatique par IA.
Lors de la modification, seules les langues présentes dans translations sont enregistrées : une langue absente de l’objet conserve sa valeur précédente si l’original n’a pas changé ; une valeur vide efface la traduction et la met en file d’attente pour une traduction automatique par IA.
La modification de l’original efface les traductions inchangées reçues — elles ne correspondent plus à l’original ; une traduction transmise avec une valeur différente est conservée comme correction manuelle. Cette suppression n’a lieu que si la traduction automatique est activée pour le réseau.
Une valeur dans une langue non publiée est rejetée ; une valeur dans une langue hors du jeu de langues du réseau est ignorée.

defaultstring

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

Exemple: ru

translationsobjectobligatoire

Valeur par code de langue ; pas de traduction — pas de clé

Valeurs du dictionnaire

string

date_availablestring (DataTimeFormat)

Exemple: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemple: 17:45 06/05/2024

days_of_weekarray of integerobligatoire

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

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

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.

Créer une catégorie

Autorisation

Paramètres de requête

Corps de la requête application/json

Réponses

Corps de la requête `application/json`