Crear una categoría

POST/api/crm/v2/categories.addv2

operationId: categories.add

Crea una categoría. La URL SEO se genera automáticamente y se verifica su unicidad. Los flags de publicación, descuentos, monto mínimo y envío gratuito están habilitados por defecto.

Autorización

api-token + language + role

Parámetros de consulta

branch_idintegerobligatorio

Ejemplo: 1

Cuerpo de la solicitud `application/json`

object

nameobject (TranslationField) obligatorio

Campo traducible del catálogo; tiene la misma estructura en la respuesta y en la solicitud.
Al crear, cada idioma de la red que no esté en translations permanece vacío y se pone en cola para traducción automática por IA.
Al modificar, solo se guardan los idiomas presentes en translations: un idioma que no esté en el objeto mantiene su valor anterior si el original no ha cambiado; un valor vacío elimina la traducción y la pone en cola para traducción automática por IA.
El cambio del original elimina las traducciones que no hayan sido modificadas, ya que ya no corresponden al original; una traducción enviada con un valor diferente se guarda como corrección manual. Esta limpieza ocurre solo mientras la traducción automática esté habilitada en la red.
Un valor en un idioma no publicado es rechazado; un valor en un idioma fuera del conjunto de idiomas de la red es ignorado.

defaultstring

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

Ejemplo: ru

translationsobjectobligatorio

Valor por código de idioma; si no hay traducción, no hay clave

Valores del diccionario

string

date_availablestring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Ejemplo: 17:45 06/05/2024

days_of_weekarray of integerobligatorio

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

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

Respuesta 200

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

Las solicitudes se envían a foodsoul.pro, que es el host de este portal; no se puede elegir otro.

Crear una categoría

Autorización

Parámetros de consulta

Cuerpo de la solicitud application/json

Respuestas

Cuerpo de la solicitud `application/json`