Obtener la lista de categorías

GET/api/crm/v2/categoriesv2

operationId: categories.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 1

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

parent_idinteger

Ejemplo: 1

discount_enabledboolean

Ejemplo: true

minimum_sum_enabledboolean

Ejemplo: true

free_delivery_enabledboolean

Ejemplo: true

sortintegerobligatorio

Ejemplo: 1

publishedboolean

Ejemplo: true

hide_for_districts_idsarray of integer

hide_for_pickups_idsarray of integer

date_availablestring (DataTimeFormatSQL)

Ejemplo: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Ejemplo: 2024-05-02 08:31:16

days_of_weekarray of integer

time_periodsarray of string

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/categories', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'es', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/categories", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/categories", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "list": [ { "id": 1, "name": { "default": "ru", "translations": { "ru": "Пицца", "en": "Pizza" } }, "parent_id": 1, "discount_enabled": true, "minimum_sum_enabled": true, "free_delivery_enabled": true, "sort": 1, "published": true, "hide_for_districts_ids": [ 1 ], "hide_for_pickups_ids": [ 1 ], "date_available": "2024-05-02 08:31:16", "date_expiration": "2024-05-02 08:31:16", "days_of_week": [ 1 ], "time_periods": [ "11:24 - 12:34" ] } ] } }