API

Obtenir une carte thermique des commandes par heure

GET/api/crm/v2/orders_over_timev2
operationId: ordersOverTime.default

Retourne une carte thermique des commandes : heures de la journée par jours de la semaine, jours calendaires ou mois. Jusqu'à deux périodes peuvent être retournées par requête pour comparer semaine à semaine ou mois à mois. Les commandes sont agrégées par heure en UTC, et seules les heures non vides sont retournées. La conversion au fuseau horaire de l'utilisateur, le regroupement par lignes et les cellules vides sont gérés côté client.

Autorisation

api-token + language + role

Paramètres de requête

date_creation_fromstring

Exemple: 25/04/2024

date_creation_tostring

Exemple: 26/04/2024

date_comparison_fromstring

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

Exemple: 25/03/2024

date_comparison_tostring

Exemple: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Lignes de la grille : jours de la semaine, jours calendaires ou mois. N'affecte que l'affichage et jamais l'agrégation.

Valeurs:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Statut de la commande : en cours de livraison, terminé, en préparation, en cuisine, non traité, prêt à être expédié, en attente d'envoi en cuisine, en attente de reprise, annulé, confirmé, préparé

Valeurs:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemple: confirmed

platformstring (OrderPlatform)

Plateforme de commande

Valeurs:androidapifbiosvksite

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
courier_idinteger

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

granularityobject (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

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

order_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

platformobject (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

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

courier_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

periodsarray of object
keystringobligatoire

Valeurs:ab

Exemple: a

date_fromstringobligatoire

Exemple: 25/04/2024

date_tostringobligatoire

Exemple: 26/04/2024

rangestringobligatoirepeut être nul

Période prédéfinie correspondant aux limites ; null si la période est personnalisée

Exemple: week

totalobject (OrdersOverTimeValues) obligatoire
countintegerobligatoire

Exemple: 47

sumnumberobligatoire

Exemple: 52640

averagenumberobligatoire

Exemple: 1120

bucketsarray of objectobligatoirepeut être nul

Commandes groupées par heure ; uniquement les heures non vides. Convertissez l'heure dans le fuseau horaire de l'utilisateur, puis déterminez la ligne et la colonne selon le résultat et complétez les valeurs manquantes par des zéros.

datetimestringobligatoire

Heure à laquelle les commandes se rapportent, en UTC

Exemple: 2024-04-25 14:00:00

countintegerobligatoire

Exemple: 47

sumnumberobligatoire

Exemple: 52640