API

Iegūt pasūtījumu laika siltuma karti

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

Atgriež pasūtījumu siltuma karti: diennakts stundas pēc nedēļas dienām, kalendārajiem datumiem vai mēnešiem. Vienā pieprasījumā var atgriezt līdz diviem periodiem, lai salīdzinātu nedēļu ar nedēļu vai mēnesi ar mēnesi. Pasūtījumi tiek apkopoti pa stundām UTC, un tiek atgrieztas tikai tās stundas, kurās ir pasūtījumi. Lietotāja laika joslas pārveidošana, rindu grupēšana un tukšo šūnu apstrāde jāveic klienta pusē.

Autorizācija

api-token + language + role

Vaicājuma parametri

date_creation_fromstring

Piemērs: 25/04/2024

date_creation_tostring

Piemērs: 26/04/2024

date_comparison_fromstring

Otrais periods; tukšs, ja nav ar ko salīdzināt

Piemērs: 25/03/2024

date_comparison_tostring

Piemērs: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Režģa rindas: nedēļas dienas, kalendāra dienas vai mēneši. Ietekmē tikai attēlojumu un nekad — agregāciju.

Vērtības:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Pasūtījuma statuss: ceļā, izpildīts, komplektēšana, virtuvē, neapstrādāts, gatavs nosūtīšanai, gaida nosūtīšanu uz virtuvi, gaida pārstrādi, atcelts, apstiprināts, pagatavots

Vērtības:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Piemērs: confirmed

platformstring (OrderPlatform)

Pasūtījumu platforma

Vērtības:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Piegādes veids: kurjers vai pašizņemšana

Vērtības:courierpickup

payment_statusstring (OrderPayment)

Apmaksas statuss: nav apmaksāts, gaida, apmaksāts

Vērtības:not_paidwaitingpaid

operator_idinteger
courier_idinteger

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_creation_rangeobject (FilterDateRange)

Gatavi datuma filtra periodi; apakšējā robeža tiek aprēķināta lietotāja laika joslā. value — periods, kuram atbilst pašreizējie *_from un *_to; null — patvaļīgs periods. default — periods, kuru serveris izmanto pieprasījumā bez datumiem: tas tiek piemērots arī sadaļas pirmajā ielādē un pie atiestatīšanas. Perioda augšējā robeža vienmēr ir vienāda ar lietotāja pašreizējo dienu, tāpēc option to nesatur: gatavam periodam nav jānosūta *_to, serveris to iestata pats. Periods, kas ir garāks par gadu, tiek apgriezts no svaigākās robežas puses.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringvar būt null

Piemērs: 2026-08-01 00:00:00

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_comparison_toobject (FilterDateTo)
valuestringvar būt null

Piemērs: 2026-08-31 23:59:59

typestringobligāts

Piemērs: date

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Gatavi datumu filtra periodi bez noklusējuma vērtības: default vienmēr ir null.

valuestring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

defaultstring (DateRange) var būt null

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

typestringobligāts

Piemērs: select

optionarray of objectobligāts
valuestring (DateRange) obligāts

Gatavs datuma filtra periods. Tam nav sava vaicājuma parametra: apakšējā robeža jau ir aprēķināta option un tiek izmantota kā *_from. Augšējā robeža netiek nodota ne atbildē, ne vaicājumā — tā vienmēr ir vienāda ar lietotāja pašreizējo dienu un tiek noteikta serverī.

Vērtības:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Piemērs: today

date_fromstringobligāts

Piemērs: 25/08/2026

granularityobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

chain_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

order_statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

platformobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

delivery_methodobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

payment_statusobject (FilterEnum)

Filtrs-enums — plakans uzskaitījuma vērtību saraksts

valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of string
modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

periodsarray of object
keystringobligāts

Vērtības:ab

Piemērs: a

date_fromstringobligāts

Piemērs: 25/04/2024

date_tostringobligāts

Piemērs: 26/04/2024

rangestringobligātsvar būt null

Gatavs periods ar noteiktām robežām; null, ja periods ir patvaļīgs

Piemērs: week

totalobject (OrdersOverTimeValues) obligāts
countintegerobligāts

Piemērs: 47

sumnumberobligāts

Piemērs: 52640

averagenumberobligāts

Piemērs: 1120

bucketsarray of objectobligātsvar būt null

Pasūtījumi, grupēti pa stundām; tikai nestundas ar pasūtījumiem. Pārvērtiet laiku lietotāja laika joslā, pēc tam pēc rezultāta nosakiet rindu un kolonnu un aizpildiet tukšumus ar nullēm.

datetimestringobligāts

Laiks, uz kuru attiecas pasūtījumi, UTC

Piemērs: 2024-04-25 14:00:00

countintegerobligāts

Piemērs: 47

sumnumberobligāts

Piemērs: 52640