API

Gauti užsakymų žurnalą

GET/api/crm/v2/log_ordersv2
operationId: logOrders.default

Grąžina užsakymų žurnalą. Su download=yes rezultatas grąžinamas CSV failu.

Autorizacija

api-token + language + role

Užklausos parametrai

date_fromstring

Pavyzdys: 29/05/2024

date_tostring

Pavyzdys: 30/05/2024

page_numberinteger

Pavyzdys: 1

chain_idinteger
branch_idinteger
order_numberinteger
operator_idinteger
downloadstring

Perduokite yes, kad atsisiųstumėte pasirinkimą CSV failu

Reikšmės:yes

Pavyzdys: yes

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_rangeobject (FilterDateRange)

Paruošti datos filtro laikotarpiai; apatinė riba apskaičiuojama pagal naudotojo laiko juostą. value — laikotarpis, kuriam atitinka dabartiniai *_from ir *_to; null — pasirinktinis laikotarpis. default — laikotarpis, kurį serveris naudoja užklausoje be datų: jis taip pat taikomas pirmą kartą įkėlus skyrių ir grąžinamas atstatant nustatymus. Viršutinė laikotarpio riba visada lygi dabartinei naudotojo dienai, todėl option jos neturi: perduoti *_to paruoštam laikotarpiui nereikia, serveris ją nustato automatiškai. Laikotarpis, ilgesnis nei metai, nukerpamas nuo naujesnės ribos.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

optionarray of objectprivalomas
valuestring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

order_numberobject (FilterId)
valueany

Pavyzdys: 0

typestringprivalomas

Pavyzdys: integer

placeholderstring

Pavyzdys: integer

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

downloadobject (FilterButtonDownloadCsv)

Atsisiuntimo mygtukas: paspaudus perduokite download=yes

valuestring

Pavyzdys: Download

typestringprivalomas

Pavyzdys: button_download_csv

listarray of object
idintegerprivalomas

Pavyzdys: 1197208

datestring (DataTimeFormatSQL) privalomas

Pavyzdys: 2024-05-02 08:31:16

textstringprivalomas

Pavyzdys: Order created

order_numberinteger

Pavyzdys: 109

branch_idintegerprivalomas

Pavyzdys: 1

branch_namestringprivalomas

Pavyzdys: Green Basket | Main

chain_namestringprivalomas

Pavyzdys: Green Basket

city_namestringprivalomas

Pavyzdys: Voronezh

paginationobject (Pagination)
max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false