API

Ստանալ հաճախորդների բոնուսային գործողությունների ցանկը

GET/api/crm/v2/clients_bonusesv2
operationId: clientsBonuses.default

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

api-token + language + role

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

page_numberinteger

Օրինակ: 1

date_creation_fromstring

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

date_creation_tostring

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

chain_idinteger

Օրինակ: 1

branch_idinteger
phone_format_idinteger

Օրինակ: 1

phone_numberstring

Օրինակ: 9999999999

genderstring

Արժեքներ:womanman

downloadstring

Արժեքներ:yes

Օրինակ: yes

Պատասխաններ

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

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

phone_format_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

phone_numberobject (FilterInput)
valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

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

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

genderobject (FilterEnum)

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

valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: select

optionarray of string
modestring (FilterMode)

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

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

downloadobject (FilterButtonDownloadCsv)

Նմուշի ներբեռնման կոճակ՝ սեղմելիս փոխանցեք download=yes

valuestring

Օրինակ: Download

typestringպարտադիր

Օրինակ: button_download_csv

system_automationboolean

Օրինակ: true

listarray of object
idintegerպարտադիր

Օրինակ: 1

date_creationstring (DataTimeFormatSQL) պարտադիր

Օրինակ: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

typestringպարտադիր

Արժեքներ:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Օրինակ: gift

descriptionstring

Օրինակ: bonuses for the registration

sumnumberպարտադիր

Օրինակ: 135

order_idinteger

Օրինակ: 0

feedback_idinteger

Օրինակ: 0

statusstringպարտադիր

Արժեքներ:availablenot_available

Օրինակ: available

branch_idinteger

Օրինակ: 1

order_numberinteger

Օրինակ: 1

feedback_datestring (DataTimeFormatSQL)

Օրինակ: 2024-05-02 08:31:16

client_namestring

Օրինակ: client name

client_phone_format_idinteger

Օրինակ: 1

client_phone_numberstring

Օրինակ: 9638887321

chain_namestring

Օրինակ: Green Basket

spent_sumnumberպարտադիր

Օրինակ: 135

paginationobject (Pagination)
max_countintegerպարտադիր

Էջի տարրերի քանակը

Օրինակ: 30

page_numberintegerպարտադիր

Ընթացիկ էջի համարը; սահմանափակված է այնպես, որ շեղումը չգերազանցի 1000

Օրինակ: 1

has_nextbooleanպարտադիր

Հաջորդ էջը առկա է

Օրինակ: true

has_previousbooleanպարտադիր

Կա արդյոք նախորդ էջ

Օրինակ: false