API

Obțineți harta termică a comenzilor în funcție de timp

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

Returnează o hartă termică a comenzilor: orele zilei pe zilele săptămânii, zile calendaristice sau luni. Un singur request poate returna până la două perioade pentru a compara săptămână la săptămână sau lună la lună. Comenzile sunt agregate pe ore în UTC și sunt returnate doar orele nenule. Conversia în fusul orar al utilizatorului, gruparea pe rânduri și celulele goale se realizează pe partea clientului.

Autorizare

api-token + language + role

Parametri de interogare

date_creation_fromstring

Exemplu: 25/04/2024

date_creation_tostring

Exemplu: 26/04/2024

date_comparison_fromstring

Al doilea interval; gol dacă nu există cu ce compara

Exemplu: 25/03/2024

date_comparison_tostring

Exemplu: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Linii de grilă: zilele săptămânii, zile calendaristice sau luni. Afectează doar afișarea și niciodată agregarea.

Valori:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Stare comandă: în drum, finalizat, în asamblare, la bucătărie, neprocesat, gata de expediere, așteaptă trimiterea la bucătărie, așteaptă refacere, anulat, confirmat, pregătit

Valori:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Exemplu: confirmed

platformstring (OrderPlatform)

Platforma de comandă

Valori:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Metoda de livrare: curier sau ridicare personală

Valori:courierpickup

payment_statusstring (OrderPayment)

Stare plată: neplătit, în așteptare, plătit

Valori:not_paidwaitingpaid

operator_idinteger
courier_idinteger

Răspunsuri

OK

object
statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpoate fi null

Exemplu: 2026-08-01 00:00:00

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_toobject (FilterDateTo)
valuestringpoate fi null

Exemplu: 2026-08-31 23:59:59

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_creation_rangeobject (FilterDateRange)

Perioade predefinite pentru filtrul de dată; limita inferioară este calculată în fusul orar al utilizatorului. value — perioada pentru care corespund valorile curente *_from și *_to; null — perioadă personalizată. default — perioada pe care serverul o setează în cererile fără date: aceasta se aplică la prima încărcare a secțiunii și la resetare. Limita superioară a perioadei este întotdeauna egală cu ziua curentă a utilizatorului, de aceea option nu o conține: nu este necesar să transmiteți *_to pentru o perioadă predefinită, serverul o setează automat. O perioadă mai lungă de un an este tăiată dinspre limita recentă.

valuestring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

defaultstring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

typestringobligatoriu

Exemplu: select

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

optionarray of objectobligatoriu
valuestring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

date_fromstringobligatoriu

Exemplu: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpoate fi null

Exemplu: 2026-08-01 00:00:00

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_comparison_toobject (FilterDateTo)
valuestringpoate fi null

Exemplu: 2026-08-31 23:59:59

typestringobligatoriu

Exemplu: date

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Perioade predefinite pentru filtrul de date fără valoare implicită: default este întotdeauna null.

valuestring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

defaultstring (DateRange) poate fi null

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

typestringobligatoriu

Exemplu: select

optionarray of objectobligatoriu
valuestring (DateRange) obligatoriu

Perioadă de filtrare predefinită după dată. Nu are propriul parametru de interogare: limita inferioară este deja calculată în option și este transmisă în *_from. Limita superioară nu este transmisă nici în răspuns, nici în cerere — este întotdeauna egală cu ziua curentă a utilizatorului și este setată de server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplu: today

date_fromstringobligatoriu

Exemplu: 25/08/2026

granularityobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

chain_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

order_statusobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

platformobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

delivery_methodobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

payment_statusobject (FilterEnum)

Filtru-enumerație — listă plată de valori ale enumerației

valuestring

Exemplu: example

typestringobligatoriu

Exemplu: select

optionarray of string
modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

periodsarray of object
keystringobligatoriu

Valori:ab

Exemplu: a

date_fromstringobligatoriu

Exemplu: 25/04/2024

date_tostringobligatoriu

Exemplu: 26/04/2024

rangestringobligatoriupoate fi null

Perioadă predefinită corespunzătoare limitelor; null dacă perioada este personalizată

Exemplu: week

totalobject (OrdersOverTimeValues) obligatoriu
countintegerobligatoriu

Exemplu: 47

sumnumberobligatoriu

Exemplu: 52640

averagenumberobligatoriu

Exemplu: 1120

bucketsarray of objectobligatoriupoate fi null

Comenzi grupate pe ore; doar orele care nu sunt goale. Conversia timpului se face în fusul orar al utilizatorului, apoi determinați rândul și coloana pe baza rezultatului și completați lipsurile cu zerouri.

datetimestringobligatoriu

Ora la care se referă comenzile, în UTC

Exemplu: 2024-04-25 14:00:00

countintegerobligatoriu

Exemplu: 47

sumnumberobligatoriu

Exemplu: 52640