API

Siparişlerin zamana göre ısı haritasını alın

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

Siparişlerin ısı haritasını döndürür: haftanın günlerine, takvim günlerine veya aylara göre günün saatleri. Bir istekte iki döneme kadar döndürülebilir, böylece hafta-hafta veya ay-ay karşılaştırması yapılabilir. Siparişler UTC saatlerine göre gruplanır ve yalnızca dolu saatler döndürülür. Zaman dilimine dönüştürme, satırlara göre gruplama ve boş hücreler istemci tarafında yapılır.

Yetkilendirme

api-token + language + role

Sorgu parametreleri

date_creation_fromstring

Örnek: 25/04/2024

date_creation_tostring

Örnek: 26/04/2024

date_comparison_fromstring

İkinci dönem; karşılaştıracak bir şey yoksa boştur

Örnek: 25/03/2024

date_comparison_tostring

Örnek: 26/03/2024

granularitystring (OrdersOverTimeGranularity)

Izgara satırları: haftanın günleri, takvim günleri veya aylar. Yalnızca görünüme etki eder, asla toplama işlemini etkilemez.

Değerler:weekdaydaymonth

chain_idinteger
branch_idinteger
order_statusstring (OrderStatus)

Sipariş durumu: yolda, tamamlandı, hazırlanıyor, mutfakta, işlenmedi, gönderime hazır, mutfağa gönderilmeyi bekliyor, yeniden yapılmayı bekliyor, iptal edildi, onaylandı, hazırlandı

Değerler:in_transitdoneassemblyin_kitchennot_processedready_to_transitwait_to_kitchenwait_remadecanceledconfirmedcooked

Örnek: confirmed

platformstring (OrderPlatform)

Sipariş platformu

Değerler:androidapifbiosvksite

delivery_methodstring (OrderDelivery)

Teslimat yöntemi: kurye veya self-servis

Değerler:courierpickup

payment_statusstring (OrderPayment)

Ödeme durumu: ödenmedi, beklemede, ödendi

Değerler:not_paidwaitingpaid

operator_idinteger
courier_idinteger

Yanıtlar

OK

object
statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull olabilir

Örnek: 2026-08-01 00:00:00

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_toobject (FilterDateTo)
valuestringnull olabilir

Örnek: 2026-08-31 23:59:59

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarih filtre dönemleri; alt sınır, kullanıcının saat diliminde hesaplanır. value — mevcut *_from ve *_to ile eşleşen dönem; null — özel dönem. default — sunucunun tarih belirtilmeyen istekte kullandığı dönemdir: ayrıca bölüm ilk yüklendiğinde ve sıfırlama yapıldığında da uygulanır. Dönemin üst sınırı her zaman kullanıcının bugünkü tarihine eşittir, bu nedenle option bunu içermez: hazır dönem için *_to göndermeye gerek yoktur, sunucu bunu otomatik olarak ayarlar. Bir yıldan uzun dönemler, yeni tarihe yakın taraftan kesilir.

valuestring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

defaultstring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

typestringzorunlu

Örnek: select

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

optionarray of objectzorunlu
valuestring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

date_fromstringzorunlu

Örnek: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringnull olabilir

Örnek: 2026-08-01 00:00:00

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_comparison_toobject (FilterDateTo)
valuestringnull olabilir

Örnek: 2026-08-31 23:59:59

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Hazır tarih aralığı filtreleri, varsayılan değer olmadan: default her zaman null'dır.

valuestring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

defaultstring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

typestringzorunlu

Örnek: select

optionarray of objectzorunlu
valuestring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

date_fromstringzorunlu

Örnek: 25/08/2026

granularityobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

chain_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

order_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

platformobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

delivery_methodobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

payment_statusobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

courier_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

periodsarray of object
keystringzorunlu

Değerler:ab

Örnek: a

date_fromstringzorunlu

Örnek: 25/04/2024

date_tostringzorunlu

Örnek: 26/04/2024

rangestringzorunlunull olabilir

Hazır bir dönem, sınırları belirlenmiş; dönem özelse null

Örnek: week

totalobject (OrdersOverTimeValues) zorunlu
countintegerzorunlu

Örnek: 47

sumnumberzorunlu

Örnek: 52640

averagenumberzorunlu

Örnek: 1120

bucketsarray of objectzorunlunull olabilir

Saatlere göre gruplanmış siparişler; yalnızca boş olmayan saatler. Zamanı önce kullanıcının saat dilimine çevirin, ardından sonuçlara göre satır ve sütunu belirleyin ve eksik değerleri sıfır ile doldurun.

datetimestringzorunlu

Siparişlerin ait olduğu saat, UTC cinsinden

Örnek: 2024-04-25 14:00:00

countintegerzorunlu

Örnek: 47

sumnumberzorunlu

Örnek: 52640