API

Ստանալ պատվերների ջերմային քարտեզը ըստ ժամանակի

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

Վերադարձնում է պատվերների ջերմային քարտեզը՝ օրվա ժամերը ըստ շաբաթվա օրերի, օրացուցային օրերի կամ ամիսների։ Մեկ հարցմամբ վերադարձվում է մինչև երկու ժամանակաշրջան՝ շաբաթը շաբաթին կամ ամիսը ամսին համեմատելու համար։ Պատվերները ագրեգացվում են ըստ ժամերի UTC-ում, և վերադարձվում են միայն ոչ դատարկ ժամերը։ Ժամային գոտու փոխարկումը, տողերով խմբավորումը և դատարկ բջիջները իրականացվում են հաճախորդի կողմից։.

Հավաստագրում

api-token + language + role

Հարցման պարամետրեր

date_creation_fromstring

Օրինակ: 25/04/2024

date_creation_tostring

Օրինակ: 26/04/2024

date_comparison_fromstring

Երկրորդ ժամանակահատվածը; դատարկ է, եթե համեմատելու ոչինչ չկա

Օրինակ: 25/03/2024

date_comparison_tostring

Օրինակ: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Ցանցի տողեր՝ շաբաթվա օրեր, օրացուցային օրեր կամ ամիսներ։ Ազդում է միայն ցուցադրման վրա և երբեք՝ ագրեգացման։.

Արժեքներ:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Պատվերի կարգավիճակ՝ ճանապարհին, ավարտված, հավաքում, խոհանոցում, չմշակված, պատրաստ առաքման, սպասում է խոհանոց ուղարկմանը, սպասում է վերամշակման, չեղարկված, հաստատված, պատրաստված

Արժեքներ:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Օրինակ: confirmed

platformstring (OrderPlatform)

Պատվերի հարթակ

Արժեքներ:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Առաքման եղանակը՝ սուրհանդակ կամ ինքնաբերում

Արժեքներ:courierpickup

payment_statusstring (OrderPayment)

Վճարման կարգավիճակ՝ չվճարված, սպասում է, վճարված

Արժեքներ:not_paidwaitingpaid

operator_idinteger
courier_idinteger

Պատասխաններ

OK

object
statusstringպարտադիր

Արժեքներ:successerror

Օրինակ: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringկարող է լինել null

Օրինակ: 2026-08-01 00:00:00

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_creation_toobject (FilterDateTo)
valuestringկարող է լինել null

Օրինակ: 2026-08-31 23:59:59

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_creation_rangeobject (FilterDateRange)

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատվածներ; ստորին սահմանը հաշվարկվում է օգտագործողի ժամային գոտու հիման վրա։ value — ժամանակահատված, որին համապատասխանում են ընթացիկ *_from և *_to; null — կամայական ժամանակահատված։ default — ժամանակահատված, որը սերվերը օգտագործում է առանց ամսաթվերի հարցման դեպքում. նույնը կիրառվում է բաժնի առաջին բեռնումից և վերականգնման ժամանակ։ Ժամանակահատվածի վերին սահմանը միշտ համընկնում է օգտագործողի ընթացիկ օրվա հետ, ուստի option-ը այն չի պարունակում. պատրաստի ժամանակահատվածի համար անհրաժեշտ չէ փոխանցել *_to, սերվերը այն սահմանում է ինքնուրույն։ Տարեկանից երկար ժամանակահատվածը կրճատվում է թարմ սահմանից։.

valuestring (DateRange) կարող է լինել null

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

defaultstring (DateRange) պարտադիր

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

typestringպարտադիր

Օրինակ: select

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

optionarray of objectպարտադիր
valuestring (DateRange) պարտադիր

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

date_fromstringպարտադիր

Օրինակ: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringկարող է լինել null

Օրինակ: 2026-08-01 00:00:00

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_comparison_toobject (FilterDateTo)
valuestringկարող է լինել null

Օրինակ: 2026-08-31 23:59:59

typestringպարտադիր

Օրինակ: date

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Պատրաստի ամսաթվային միջակայքերի ֆիլտրեր առանց լռելյայն արժեքի՝ default միշտ հավասար է null:.

valuestring (DateRange) կարող է լինել null

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

defaultstring (DateRange) կարող է լինել null

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

typestringպարտադիր

Օրինակ: select

optionarray of objectպարտադիր
valuestring (DateRange) պարտադիր

Պատրաստի ամսաթվային ֆիլտրի ժամանակահատված։ Այն չունի սեփական հարցման պարամետր․ ստորին սահմանը արդեն հաշվարկված է գալիս option-ում և օգտագործվում է որպես *_from։ Վերին սահմանը չի փոխանցվում ոչ պատասխանով, ոչ հարցմամբ՝ այն միշտ հավասար է օգտագործողի ընթացիկ օրվան և սահմանվում է սերվերի կողմից։.

Արժեքներ:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Օրինակ: today

date_fromstringպարտադիր

Օրինակ: 25/08/2026

granularityobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

chain_idobject (FilterSelectInteger)
valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object
valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object
valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

order_statusobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

platformobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

delivery_methodobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

payment_statusobject (FilterEnum)

Զտիչ-թվարկում — թվարկման արժեքների հարթ ցուցակ

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object
valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Օրինակ: 8920

typestringպարտադիր

Օրինակ: select

optionarray of object
valueintegerպարտադիր

Օրինակ: 8920

namestringպարտադիր

Օրինակ: Green Basket | Kaliningrad

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

periodsarray of object
keystringպարտադիր

Արժեքներ:ab

Օրինակ: a

date_fromstringպարտադիր

Օրինակ: 25/04/2024

date_tostringպարտադիր

Օրինակ: 26/04/2024

rangestringպարտադիրկարող է լինել null

Պատրաստ ժամանակահատված, որի սահմաններին համապատասխանում է; null, եթե ժամանակահատվածը կամայական է

Օրինակ: week

totalobject (OrdersOverTimeValues) պարտադիր
countintegerպարտադիր

Օրինակ: 47

sumnumberպարտադիր

Օրինակ: 52640

averagenumberպարտադիր

Օրինակ: 1120

bucketsarray of objectպարտադիրկարող է լինել null

Պատվերները, խմբավորված ըստ ժամերի; միայն ոչ դատարկ ժամերը։ Ժամանակը փոխարկեք օգտագործողի ժամային գոտուն, ապա արդյունքի հիման վրա որոշեք տողը և սյունակը և լրացրեք բացերը զրոներով։.

datetimestringպարտադիր

Այն ժամը (UTC), որի համար վերաբերում են պատվերները

Օրինակ: 2024-04-25 14:00:00

countintegerպարտադիր

Օրինակ: 47

sumnumberպարտադիր

Օրինակ: 52640