Создать категорию

POST/api/crm/v2/categories.addv2

operationId: categories.add

Создаёт категорию. SEO-адрес генерируется автоматически и проверяется на уникальность. Флаги публикации, скидок, минимальной суммы и бесплатной доставки по умолчанию включены.

Авторизация

api-token + language + role

Параметры запроса

branch_idintegerобязательный

Пример: 1

Тело запроса `application/json`

object

nameobject (TranslationField) обязательный

Переводимое поле каталога; одинаковой структуры в ответе и в запросе. При создании каждый язык сети, которого нет в translations, остаётся пустым и ставится в очередь на AI-перевод. При изменении записываются только языки из translations: язык, которого нет в объекте, сохраняет прежнее значение, если оригинал не изменился; пустое значение очищает перевод и ставит его в очередь на AI-перевод. Изменение оригинала очищает переводы, пришедшие без изменений, — они ему больше не соответствуют; перевод, переданный с другим значением, сохраняется как ручная правка. Такая очистка происходит, только пока у сети включён автоматический перевод. Значение на неопубликованном языке отклоняется; значение на языке вне набора языков сети игнорируется.

defaultstring

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

Пример: ru

translationsobjectобязательный

Значение по коду языка; нет перевода — нет ключа

Значения словаря

string

date_availablestring (DataTimeFormat)

Пример: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Пример: 17:45 06/05/2024

days_of_weekarray of integerобязательный

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Пример: 1

Ответы

object

statusstringобязательный

Значения:successerror

Пример: 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: ru' \ -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' => 'ru', '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": "ru", "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": "ru", "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()

Создать категорию

Авторизация

Параметры запроса

Тело запроса application/json

Ответы

Тело запроса `application/json`