API

Obtenir la liste des catégories

GET/api/crm/v2/categoriesv2
operationId: categories.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object
idintegerobligatoire

Exemple: 1

nameobject (TranslationField) obligatoire

Champ traduisible du catalogue ; structure identique dans la réponse et la requête.
Lors de la création, chaque langue du réseau absente de translations reste vide et est mise en file d’attente pour une traduction automatique par IA.
Lors de la modification, seules les langues présentes dans translations sont enregistrées : une langue absente de l’objet conserve sa valeur précédente si l’original n’a pas changé ; une valeur vide efface la traduction et la met en file d’attente pour une traduction automatique par IA.
La modification de l’original efface les traductions inchangées reçues — elles ne correspondent plus à l’original ; une traduction transmise avec une valeur différente est conservée comme correction manuelle. Cette suppression n’a lieu que si la traduction automatique est activée pour le réseau.
Une valeur dans une langue non publiée est rejetée ; une valeur dans une langue hors du jeu de langues du réseau est ignorée.

defaultstring

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

Exemple: ru

translationsobjectobligatoire

Valeur par code de langue ; pas de traduction — pas de clé

Valeurs du dictionnaire
string
parent_idinteger

Exemple: 1

discount_enabledboolean

Exemple: true

minimum_sum_enabledboolean

Exemple: true

free_delivery_enabledboolean

Exemple: true

sortintegerobligatoire

Exemple: 1

publishedboolean

Exemple: true

hide_for_districts_idsarray of integer
hide_for_pickups_idsarray of integer
date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

days_of_weekarray of integer
time_periodsarray of string