API

Obtenir les statistiques des canaux de vente

GET/api/crm/v2/sales_channelsv2
operationId: salesChannels.default

Retourne le chiffre d'affaires, le nombre de commandes et le panier moyen pour chaque canal de vente. Jusqu'à deux périodes peuvent être retournées par requête afin de comparer, par exemple, un mois à un autre. Les totaux de chaque période sont déjà calculés, et pour les graphiques, seules les heures non vides en UTC sont renvoyées. Convertissez-les dans le fuseau horaire de l'utilisateur et regroupez-les par jour ou par mois. Seules les commandes effectuées sont incluses dans le chiffre d'affaires.

Autorisation

api-token + language + role

Paramètres de requête

date_creation_fromstring

Exemple: 01/08/2026

date_creation_tostring

Exemple: 31/08/2026

date_comparison_fromstring

Deuxième période ; vide s'il n'y a pas de comparaison possible

Exemple: 01/07/2026

date_comparison_tostring

Exemple: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Mode de livraison : coursier ou retrait sur place

Valeurs:courierpickup

payment_statusstring (OrderPayment)

Statut du paiement : non payé, en attente, payé

Valeurs:not_paidwaitingpaid

operator_idinteger
downloadstring

Renvoie un tableau récapitulatif de la période A au format CSV au lieu de JSON

Valeurs:yes

Exemple: yes

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

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

date_creation_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

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

date_creation_rangeobject (FilterDateRange)

Périodes prédéfinies pour le filtre de date ; la limite inférieure est calculée selon le fuseau horaire de l'utilisateur. value — période correspondant aux valeurs actuelles de *_from et *_to ; null — période personnalisée. default — période que le serveur applique à une requête sans dates : elle est également utilisée lors du premier chargement de la section et lors de la réinitialisation. La limite supérieure de la période correspond toujours au jour actuel de l'utilisateur, c'est pourquoi option ne la contient pas : il n'est pas nécessaire de transmettre *_to pour une période prédéfinie, le serveur la définit automatiquement. Une période de plus d'un an est tronquée du côté de la limite la plus récente.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

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

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

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

date_comparison_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

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

date_comparison_rangeobject (FilterDateRangeOptional)

Périodes prédéfinies pour le filtre de dates sans valeur par défaut : default est toujours égal à null.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

chain_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

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

delivery_methodobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
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

payment_statusobject (FilterEnum)

Filtre d’énumération — liste plate de valeurs d’énumération

valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of string
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

operator_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

downloadobject (FilterButtonDownloadCsv)

Bouton de téléchargement de la sélection : lors du clic, transmettez download=yes

valuestring

Exemple: Download

typestringobligatoire

Exemple: button_download_csv

periodsarray of object

Un élément par période ; le second uniquement si une période de comparaison est spécifiée

keystringobligatoire

a — période principale, b — période de comparaison

Valeurs:ab

Exemple: a

date_fromstringobligatoire

Exemple: 01/08/2026

date_tostringobligatoire

Exemple: 31/08/2026

totalobject (SalesChannelsTotal) obligatoire

Résultats de la période pour tous les canaux

orders_countintegerobligatoire

Exemple: 4120

completed_countintegerobligatoire

Exemple: 3894

completed_percentnumberobligatoire

Exemple: 94.51

revenuenumberobligatoire

Exemple: 4361280

averagenumberobligatoire

Exemple: 1120

channelsarray of objectobligatoire

Un élément pour chaque canal avec des commandes, dans un ordre fixe. Il n'y a pas d'élément « tous les canaux » : pour cela, utilisez total.

platformstring (OrderPlatform) obligatoire

Plateforme de commande

Valeurs:androidapifbiosvksite

orders_countintegerobligatoire

Exemple: 1810

orders_sharenumberobligatoire

Part des commandes sur la période en pourcentage

Exemple: 43.93

completed_countintegerobligatoire

Exemple: 1702

completed_percentnumberobligatoire

Exemple: 94.03

revenuenumberobligatoire

Exemple: 1855180

revenue_sharenumberobligatoire

Part de chiffre d'affaires pour la période, en pourcentage

Exemple: 42.54

averagenumberobligatoire

Chiffre d'affaires divisé par le nombre de commandes effectuées

Exemple: 1090

deltaobject (SalesChannelsDelta) obligatoirepeut être nul

Comparaison du canal avec le même canal pendant la période B. null si la période B n'est pas définie.

revenue_absolutenumberobligatoire

Exemple: -120400

revenue_percentnumberobligatoirepeut être nul

null si le canal n’a généré aucun revenu pendant la période B : il n’y a pas de pourcentage de croissance à partir de zéro

Exemple: -6.09

bucketsarray of objectobligatoire

Commandes regroupées par heure ; uniquement les heures non vides. Convertissez l'heure dans le fuseau horaire de l'utilisateur, puis regroupez les heures en points de graphique : graphique linéaire — par jours ou mois, graphique à barres — par mois calendaires. Additionnez count, completed_count et revenue ; ne faites pas la moyenne des valeurs moyennes.

datetimestringobligatoire

Heure à laquelle les commandes se rapportent, en UTC

Exemple: 2026-08-01 09:00:00

countintegerobligatoire

Exemple: 12

completed_countintegerobligatoire

Exemple: 11

revenuenumberobligatoire

Exemple: 12100