Ապրանքների մնացորդներ

Ուղղորդիչ:  REST API (ամպային տարբերակ) > Հաշվետվություններ >

Ապրանքների մնացորդներ

 Previous pageReturn to chapter overviewNext page

Բացել/Փակել թաքցված տեքստը

API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող  ապրանքների մնացորդներ հաշվետվությունը։

 

URI

https://api.armsoft.am/trade/v1/reports/productsbalances/short

URL Swagger

https://api.armsoft.am/trade/swagger/index.html#/Reports/post_v1_reports_productsbalances_short

GitHub

https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/reports/productsbalances-short.md

Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:

-H 'apiKey: hJk:|^&99։՛(=0#biWc:'

 

Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:

 

Հարցման պարամետրեր (Request Body)

Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։

Անվանում

Տեսակ

Կիրառումը

Նկարագրություն

pageSize

Integer

Optional

Սահմանում է մեկ հարցմամբ վերադարձվող գրառումների քանակը։ Նվազագույն վերադարձվող քանակը 5000 տող է․ եթե փոխանցված արժեքը փոքր է 5000-ից, համակարգը միևնույն է վերադարձնում է առնվազն 5000 գրառում։ Եթե pageSize = 0, վեչադարձվում են բոլոր հասանելի տվյալները։ Առավելագույն սահմանաչափ ներկայումս սահմանված չէ։

Վերադարձվող օբյեկտում առկա է hasMore լոգիկական (boolean) դաշտ, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

date

Date(YYYY-MM-DD)

*Required

Մնացորդների ձևավորման ամսաթիվը: Եթե ամսաթիվը չի փոխանցվում, ապա օգտագործվում է սերվերի ընթացիկ ամսաթիվը:

storages [0..n]

Array

Optional

Reference type

Դատարկ թողնելու դեպքում կընդգրկվեն բոլոր պահեստների մնացորդները:

group

String(5)

Optional

Reference type

Ապրանքի կամ ծառայության խմբի կոդը: Դատարկ լինելու դեպքում հաշվետվության մեջ կընդգրկվեն բոլոր   խմբերի ապրանքները։

codes [0..n]

Array

Optional

Reference type

Ապրանքի կոդը:

showQuantitiesWithAdditionalUnits

Boolean

Optional

True արժեքի դեպքում քանակները ցուցադրվում են լրացուցիչ չափման միավորով:

   priceType

String(2)

Optional

Reference type

Կարելի է լրացնել կազմակերպությունում գործող որևէ գնի տեսակ, և եթե տվյալ ապրանքն ունի սահմանված այդ տեսակի գին, ապա այն կերևա հաշվետվության մեջ։

showZeroRows

Boolean

Optional

Սահմանում է՝ արդյոք հաշվետվության մեջ պետք է ցուցադրվեն նաև այն ապրանքները, որոնց մնացորդը հավասար է 0-ի։ True արժեքի դեպքում հաշվետվության մեջ կցուցադրվեն նաև այն ապրանքները, որոնց ընթացիկ մնացորդը 0 է, սակայն նրանց նկատմամբ երբևէ գրանցվել է առնվազն մեկ գործողություն (մուտք, ելք, տեղափոխություն և այլն)։

Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)

Անվանում

Տեսակ

Նկարագրություն

id

Integer

Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։

hasMore

Boolean

Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

data[]

Array

Տվյալների ցուցակ (մասսիվ),  որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։

Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)

Անվանում

Տեսակ

Նկարագրություն

salePrice

Decimal

Ապրանքի  վաճառքի գին։

salePriceAmount

Decimal

Ապրանքի  վաճառքի գումար։

id

Integer

Ապրանքի  ներքին նույնացուցիչ։

code

String

Ապրանքի  կոդ:

name

String

Ապրանքի  անվանում։

fullName

String

Ապրանքի  լրիվ անվանում։

specification

String

Ապրանքի  բնութագիր։

unitMeasure

String

Ապրանքի  չափման միավորի կոդ։

unitMeasureAbbreviation

String

Ապրանքի  չափման միավորի հապավում։

quantity

Decimal

Ապրանքի մնացորդ։

costAmountWithoutVAT

Decimal

Ապրանքի ինքնարժեքի գումարը առանց ԱԱՀ։

costAmountWithVAT

Decimal

Ապրանքի ինքնարժեքի գումարը ներառյալ ԱԱՀ։

costAmountCurrency

Decimal

Ապրանքի ինքնարժեքի գումարը արտարժույթով։

 

GitHub

https://github.com/armsoft/trade-public-api-docs/blob/main/examples/csharp/reports/productsbalances-short.cs

Օրինակ 1. 31.01.2026թ.-ի դրությամբ բոլոր ապրանքների մնացորդների ստացում (կրճատ տվյալներով)

POST

Request

 

curl -X POST \

 'https://api.armsoft.am/trade/v1/reports/productsbalances/short' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: %}uPbv>T0xZ}3beLxR{1' \

 -H 'Content-Type: application/json' \

 -d '

{

"date": "2026-01-31"

}'

 

Response body (201 Created)

 

{

 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

 "hasMore": false,

   "data": [

       {

           "salePrice": 0,

           "salePriceAmount": 0,

           "id": 100000,

           "code": "1001",

           "name": "Հեռուստացույց LED Panasonic TX-LR55ET5",

           "fullName": "Հեռուստացույց LED Panasonic TX-LR55ET5",

           "specification": "Smart VIERA LCD TV, Size: 55\" (140 cm), Full-HD",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "quantity": 6.0000,

           "costAmountWithoutVAT": 3771040.2900,

           "costAmountWithVAT": 3771040.2900,

           "costAmountCurrency": 11098.4200

       },

       {

           "salePrice": 0,

           "salePriceAmount": 0,

           "id": 100001,

           "code": "1002",

           "name": "Հեռուստացույց LED SONY KDL-55W905ABAEP",

           "fullName": "Հեռուստացույց LED SONY KDL-55W905ABAEP",

           "specification": "Edge LED TV , Size: 55\" (140 cm), Full HD",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "quantity": 10.0000,

           "costAmountWithoutVAT": 6809813.7700,

           "costAmountWithVAT": 6809813.7700,

           "costAmountCurrency": 20034.2500

       }

    ]

}

 

 

Օրինակ 2. 31.01.2026թ.-ի դրությամբ 00 պահեստում առկա նշված կոդերով ապրանքների մնացորդների և 02 գնի տեսակով գների ցանկի ստացում (կրճատ տվյալներով)

POST

Request

 

curl -X POST \

 'https://api.armsoft.am/trade/v1/reports/productsbalances/short' \

 -H 'accept: text/plain' \

 -H 'Accept-Language: hy-AM' \

 -H 'apiKey: %}uPbv>T0xZ}3beLxR{1' \

 -H 'Content-Type: application/json' \

 -d '

{

 "pageSize": 0,

 "date": "2026-01-31",

 "storages": [

   "00"

 ],

 "codes": [

  "1001",

  "1002"

 ],

 "priceType": "02"

}'

 

Response body (201 Created)

 

{

 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

 "hasMore": true,

   "data": [

       {

           "salePrice": 750150.00,

           "salePriceAmount": 2250450.00,

           "id": 100000,

           "code": "1001",

           "name": "Հեռուստացույց LED Panasonic TX-LR55ET5",

           "fullName": "Հեռուստացույց LED Panasonic TX-LR55ET5",

           "specification": "Smart VIERA LCD TV, Size: 55\" (140 cm), Full-HD",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "quantity": 3.0000,

           "costAmountWithoutVAT": 1917624.1700,

           "costAmountWithVAT": 1917624.1700,

           "costAmountCurrency": 5638.4400

       },

       {

           "salePrice": 920450.00,

           "salePriceAmount": 4602250.00,

           "id": 100001,

           "code": "1002",

           "name": "Հեռուստացույց LED SONY KDL-55W905ABAEP",

           "fullName": "Հեռուստացույց LED SONY KDL-55W905ABAEP",

           "specification": "Edge LED TV , Size: 55\" (140 cm), Full HD",

           "unitMeasure": "001",

           "unitMeasureAbbreviation": "հատ",

           "quantity": 5.0000,

           "costAmountWithoutVAT": 3403107.6900,

           "costAmountWithVAT": 3403107.6900,

           "costAmountCurrency": 10006.2400

       }

   ]

}