Criar categoria

POST/api/crm/v2/categories.addv2

operationId: categories.add

Cria uma categoria. O endereço SEO é gerado automaticamente e verificado quanto à exclusividade. Os flags de publicação, descontos, valor mínimo e entrega gratuita estão ativados por padrão.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 1

Corpo da solicitação `application/json`

object

nameobject (TranslationField) obrigatório

Campo traduzível do catálogo; mesma estrutura na resposta e na solicitação.
Ao criar, cada idioma da rede que não estiver em translations permanece vazio e é colocado na fila para tradução por IA.
Ao atualizar, apenas os idiomas presentes em translations são gravados: um idioma ausente no objeto mantém o valor anterior, se o original não foi alterado; um valor vazio limpa a tradução e a coloca na fila para tradução por IA.
Alterar o original limpa as traduções que não foram modificadas — elas não correspondem mais ao original; uma tradução enviada com outro valor é salva como edição manual. Essa limpeza ocorre apenas enquanto a tradução automática estiver ativada na rede.
Um valor em um idioma não publicado é rejeitado; um valor em um idioma fora do conjunto de idiomas da rede é ignorado.

defaultstring

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

Exemplo: ru

translationsobjectobrigatório

Valor pelo código do idioma; sem tradução — sem chave

Valores do dicionário

string

date_availablestring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

date_expirationstring (DataTimeFormat)

Exemplo: 17:45 06/05/2024

days_of_weekarray of integerobrigatório

time_periodsarray of string

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

parent_idinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

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

Resposta 200

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

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Criar categoria

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`