API

Ստանալ աֆիլիատ հաշվետվությունները

GET/api/crm/v2/affiliate_reportsv2
operationId: affiliateReports.default

Վերադարձնում է աֆիլիատների հաշվետվությունները։ Երբ download=yes, ընտրանքը վերադարձվում է որպես CSV ֆայլ JSON-ի փոխարեն։.

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

api-token + language + role

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

page_numberinteger

Օրինակ: 1

date_fromstring

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

date_tostring

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

downloadstring

yes փոխանցեք՝ ընտրանքը CSV ֆայլով ներբեռնելու համար; մյուս արժեքները անտեսվում են

Օրինակ: yes

Պատասխաններ

OK

object
statusstringպարտադիր

Արժեքներ:successerror

Օրինակ: success

dataobject
filtersobject
date_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_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_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

downloadobject (FilterButtonDownloadCsv)

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

valuestring

Օրինակ: Download

typestringպարտադիր

Օրինակ: button_download_csv

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

Օրինակ: 1

branch_sumnumberպարտադիր

Օրինակ: 100

affiliate_coefficientnumberպարտադիր

Օրինակ: 0.1

affiliate_sumnumberպարտադիր

Օրինակ: 100

typestring (TypeReports) պարտադիր

Արժեքներ:annulrefundaccrualwithdraw

Օրինակ: accrual

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

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

descriptionstring

Օրինակ: text

tax_rateinteger

Օրինակ: 10

vat_rateinteger

Օրինակ: 10

city_namestringպարտադիր

Օրինակ: Kaliningrad

chain_country_currency_codestring (CurrencyCode)

Արժույթի կոդ

Արժեքներ:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Օրինակ: RUB

affiliate_country_currency_codestring (CurrencyCode)

Արժույթի կոդ

Արժեքներ:AMDAZNBYNCZKEURGELIDRKZTKGSMDLPLNPRBRONTJSTRYUAHRUBUSDUZS

Օրինակ: RUB

chain_namestringպարտադիր

Օրինակ: Green Basket

entity_namestring

Օրինակ: Sole proprietor

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

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

Օրինակ: 30

page_numberintegerպարտադիր

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

Օրինակ: 1

has_nextbooleanպարտադիր

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

Օրինակ: true

has_previousbooleanպարտադիր

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

Օրինակ: false