Create a category

POST/api/crm/v2/categories.addv2

operationId: categories.add

Creates a category. The SEO URL is generated automatically and checked for uniqueness. The publication, discounts, minimum amount, and free delivery flags are enabled by default.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 1

Request body `application/json`

object

nameobject (TranslationField) required

Translatable catalog field; has the same structure in both response and request. When creating, each network language not present in translations remains empty and is queued for AI translation. When updating, only languages from translations are saved: a language not present in the object retains its previous value if the original has not changed; an empty value clears the translation and queues it for AI translation. Changing the original clears translations that were not updated—these no longer match the original; a translation submitted with a different value is saved as a manual edit. This clearing occurs only while automatic translation is enabled for the network. Values in unpublished languages are rejected; values in languages outside the network's language set are ignored.

defaultstring

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

Example: ru

translationsobjectrequired

Value by language code; if no translation — no key

Dictionary values

string

date_availablestring (DataTimeFormat)

Example: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Example: 17:45 06/05/2024

days_of_weekarray of integerrequired

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

curl -X POST 'https://foodsoul.ru/api/crm/v2/categories.add?branch_id=1' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -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.ru/api/crm/v2/categories.add?branch_id=1', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        '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.ru/api/crm/v2/categories.add?branch_id=1", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "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.ru/api/crm/v2/categories.add?branch_id=1",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "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()

Response 200

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

Requests are sent to foodsoul.ru — the host of this portal; you cannot choose another one.

Create a category

Authorization

Query parameters

Request body application/json

Responses

Request body `application/json`