API-ի միջոցով հնարավոր է ստանալ (POST) ապրանքների և ծառայությունների ցուցակը։
URI |
https://api.armsoft.am/trade/v1/directories/products/list |
URL Swagger |
https://api.armsoft.am/trade/swagger/index.html#/Products/post_v1_directories_products_list |
GitHub |
https://github.com/armsoft/trade-public-api-docs/blob/main/docs/api/directories/products/list.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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
showMode |
Enum |
*Required |
Ընդունում է հետևյալ արժեքները․ 1 - Գնացուցակում ընգրկվածները։ Այս դեպքում տեղեկատուում ընդգրկվում են միայն այն ապրանքները (ծառայությունները), որոնց համար Ցույց տալ գնացուցակում հայտանիշը նշված է, 2 - Գնացուցակում չընդգրկվածները։ Այս դեպքում տեղեկատուում ընդգրկվում են այն ապրանքները (ծառայությունները), որոնց համար Ցույց տալ գնացուցակում հայտանիշը նշված չէ։ 3 - Բոլորը։ Այս դեպքում տեղեկատուում ընդգրկվում են բոլոր ապրանքները (ծառայությունները)։ Արժեք չտալու դեպքում համակարգի կողմից ավտոմատ վերագրվում է 3 - Բոլորը արժեքը։ |
group |
String(5) |
Optional Reference type |
Ապրանքի խումբը։ |
type |
Enum |
Optional |
Ընդունում է հետևյալ արժեքները․ 1 - Ապրանք 2 - Ծառայություն |
codes[] |
Array |
Optional Reference type |
Ապրանքի կամ ծառայության կոդը։ |
priceListTypes[] |
Array |
Optional Reference type |
Գների տեսակների կոդերը։ |
extended |
Boolean |
Optional |
Տեղեկատուն ընլայնված սյուներով կանչելու հայտանիշ։ |
lastModifiedDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Optional |
Վերջին խմբագրման ամսաթիվ։ |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Հարցման ունիկալ նույնացուցիչ, որը գեներացվում է համակարգի կողմից և օգտագործվում է էջավորման (pagination) համար։ Եթե պատասխանում hasMore = true, ապա id-ն պետք է փոխանցել հաջորդ հարցման մեջ մնացած տվյալները ստանալու համար։ |
hasMore |
Boolean |
Լոգիկական(boolean) դաշտ է, որի true արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։ |
data[] |
Array |
Տվյալների ցուցակ (մասսիվ), որտեղ յուրաքանչյուր օբյեկտ ներկայացնում է 1 գրառում (ապրանք)։ |
Տվյալների օբյեկտի ատրիբուտներ (Data Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
id |
Integer |
Ապրանքի (ծառայության) ներքին նույնացուցիչ։ |
code |
String |
Ապրանքի (ծառայության) կոդ։ Արժեք չտալու դեպքում ընդունում է ծրագրից գեներացված հերթական համարը։ |
name |
String |
Ապրանքի (ծառայության) անվանում։ |
fullName |
String |
Ապրանքի (ծառայության) լրիվ անվանում։ |
type |
Enum |
Տեղեկատուի տեսակի կոդ։ Ընդունում է հետևյալ արժեքները․ 1 - Ապրանք 2 - Ծառայություն |
typeName |
String |
Տեղեկատուի տեսակի անվանում։ |
cpaClassifier |
String |
Ապրանքի (ծառայության) ԱՏԳԱԱ դասակարգիչ: |
group |
String |
Ապրանքի (ծառայության) խմբի կոդ: |
groupName |
String |
Ապրանքի (ծառայության) խմբի անվանում: |
groupPath |
String |
Դաշտը ցույց է տալիս, թե տվյալ խումբը որ խմբերի մեջ է մտնում։ |
baseUnitMeasure |
String |
Հիմնական չափման միավորի կոդ։ |
baseUnitMeasureAbbreviation |
String |
Հիմնական չափման միավորի հապավում։ |
alternativeUnitMeasure |
String |
Լրացուցիչ չափման միավորի կոդ։ |
alternativeUnitMeasureAbbreviation |
String |
Լրացուցիչ չափման միավորի հապավում։ |
barcode |
String |
Ապրանքի (ծառայության) գծիկավոր կոդ։ |
specification |
String |
Ապրանքի (ծառայության) բնութագիր։ |
externalCode |
String |
Ապրանքի (ծառայության) արտաքին կոդ։ |
costingMethod |
Enum |
Ապրանքի հաշվառման մեթոդի կոդ։ Ընդունում է հետևյալ արժեքները․ 1 - ՖԻՖՈ (առաջինը մուտք՝ առաջինը ելք), 2 - ԼԻՖՈ (վերջինը մուտք՝ առաջինը ելք), 3 - Միջին կշռված գնով։ |
costingMethodName |
String |
Ապրանքի հաշվառման մեթոդի անվանում։ |
vat |
Boolean |
ԱԱՀ-ով հաշվառվող համարվելու հայտանիշ։ |
checkMarking |
Boolean |
True արժեքի դեպքում տվյալ ապրանքը վաճառելիս դրոշմավորման կոդը լրացված չլինելու պարագայում համակարգը թույլ չի տալիս տպել ՀԴՄ կտրոն: |
weight |
Boolean |
Նշվում է` տվյալ ապրանքը քաշային է, թե ոչ: Կիրառվում է էլեկտրոնային կշեռքով աշխատելու դեպքում: |
pluCode |
String |
Ապրանքին տրվող չկրկնվող կոդ, որը ենթակա է արտահանման էլ. կշեռք։ |
showInPriceLists |
Boolean |
Եթե որևէ օգտագործողի Փաստաթղթի դրույթներում Ցույց տալ միայն գնացուցակում ներառվածները դրոշակը նշված է, ապա տվյալ օգտագործողի համար բոլոր ապրանքների ընտրման ցանկում կերևան միայն այն ապրանքները, որոնց համար Ցույց տալ գնացուցակներում դրոշակը նշված է։ |
environmentalFeePercent |
Decimal |
Ապրանքի (ծառայության) բնապահպանական հարկի %։ |
labelUnitMeasure |
String |
Գնապիտակի չափման միավորը այն չափման միավորի կոդն է, որով արտահայտված գինը որպես միավոր գին պետք է արտացոլվի պիտակի ձևանմուշում: |
labelUnitMeasureAbbreviation |
String |
Գնապիտակի չափման միավորի հապավում։ |
labelUnitMeasureCoefficient |
Decimal |
Գնապիտակի չափման միավորի վերահաշվարկի գործակից։ |
country |
String |
Ապրանքը արտադրող երկրի կոդ։ |
countryName |
String |
Ապրանքը արտադրող երկրի անվանում։ |
producer |
String |
Ապրանքը արտադրող կազմակերպության կոդ։ |
producerName |
String |
Ապրանքը արտադրող կազմակերպության անվանում։ |
property1 |
String |
Ապրանքը (ծառայությունը) բնութագրող հատկություն 1-ի կոդ։ |
property2 |
String |
Ապրանքը (ծառայությունը) բնութագրող հատկություն 2-ի կոդ։ |
minimumQuantity |
Decimal |
Ապրանքի մնացորդի նվազագույն քանակային մեծություն։ |
maximumQuantity |
Decimal |
Ապրանքի մնացորդի առավելագույն քանակային մեծություն։ |
addedValuePercent |
Decimal |
Ապրանքի (ծառայության) հավելագնի %։ |
aoeCoefficient |
Decimal |
Հավելյալ ծախսերի բաշխման գործակից։ |
bonusPercent |
Decimal |
Ապրանքի (ծառայության) բոնուսի տոկոս։ |
bonusPoint |
Decimal |
Ապրանքի (ծառայության) բոնուսի միավոր։ |
discountPercent |
Decimal |
Ապրանքի (ծառայության) զեղչի տոկոս։ |
mainSupplierId |
Integer |
Ապրանքի (ծառայության) հիմնական մատակարարի ներքին նույնացուցիչ։ |
mainSupplierName |
String |
Ապրանքի (ծառայության) հիմնական մատակարարի անվանում։ |
substituteItemsGroup |
String |
Փոխարինվող ապրանքների խմբի կոդ։ |
substituteItemsGroupName |
String |
Փոխարինվող ապրանքների խմբի անվանում։ |
nameEN |
String |
Ապրանքի (ծառայության) անգլերեն անվանում։ |
nameRU |
String |
Ապրանքի (ծառայության) ռուսերեն անվանում։ |
additionalSpecification1 |
String |
Ապրանքի (ծառայության) լրացուցիչ բնութագիր 1։ |
additionalSpecification2 |
String |
Ապրանքի (ծառայության) լրացուցիչ բնութագիր 2։ |
lastModifierName |
String |
Վերջին խմբագրողի անվանում։ |
lastModifyDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Վերջին խմբագրման ամսաթիվ։ |
creatorName |
String |
Ստեղծողի անվանում։ |
creationDate |
DateTime(YYYY-MM-DDTHH:mm:ss.SSSZ) |
Ստեղծման ամսաթիվ։ |
prices{} |
Dictionary |
Գների տեսակների կոդեր։ |
GitHub |
https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/products |
Օրինակ 1. Նշված գնի տեսակով և ընդլայնված տարբերակով ապրանքների և ծառայությունների ցուցակի ստացում
|