API-ի միջոցով հնարավոր է ստանալ (GET), ստեղծել (POST), թարմացնել (PUT) և հեռացնել (DELETE) ապրանքները և ծառայությունները։
URI |
https://api.armsoft.am/trade/v1/directories/products |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Այս հարցման դեպքում գործում է էջավորման մեխանիզմը:
Ապրանքների (ծառայությունների) օբյեկտի դաշտերը
Ստորև ներկայացված է օբյեկտի դաշտերի նկարագրությունը.
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
id |
Integer |
System defined |
Ապրանքի (ծառայության) ներքին նույնացուցիչ։ |
code |
String(20) |
*Required |
Ապրանքի (ծառայության) կոդ։ Արժեք չտալու դեպքում համակարգի կողմից ավտոմատ գեներացվում է հաջորդական կոդ։ |
name |
String(200) |
*Required |
Ապրանքի (ծառայության) անվանում։ |
fullName |
String(255) |
Optional |
Ապրանքի (ծառայության) լրիվ անվանում։ |
type |
Enum |
*Required |
Ընդունում է հետևյալ արժեքները․ 1 - Ապրանք 2 - Ծառայություն Արժեք չտալու դեպքում համակարգը ավտոմատ վերցնում է 1 արժեքը։ |
cpaClassifier |
String(12) |
Optional Reference type |
Ապրանքի (ծառայության) ԱՏԳԱԱ դասակարգիչ: |
group |
String(5) |
*Required Reference type |
Ապրանքի (ծառայության) խմբի կոդ: |
baseUnitMeasure |
String(3) |
*Required Reference type |
Հիմնական չափման միավորի կոդ։ |
baseUnitMeasureAbbreviation |
String(6) |
Read only |
Հիմնական չափման միավորի հապավում։ |
alternativeUnitMeasure |
String(3) |
*Conditional required Reference type |
Լրացուցիչ չափման միավորի կոդ։ |
alternativeUnitMeasureAbbreviation |
String(6) |
Read only |
Լրացուցիչ չափման միավորի հապավում։ |
barcode |
String(20) |
Optional |
Ապրանքի (ծառայության) գծիկավոր կոդ։ |
specification |
String(255) |
Optional |
Ապրանքի (ծառայության) բնութագիր։ |
externalCode |
String(20) |
Optional |
Ապրանքի (ծառայության) արտաքին կոդ։ |
costingMethod |
Enum |
*Required |
Ապրանքի հաշվառման մեթոդ։ Ընդունում է հետևյալ արժեքները․ 1 - ՖԻՖՈ (առաջինը մուտք՝ առաջինը ելք), 2 - ԼԻՖՈ (վերջինը մուտք՝ առաջինը ելք), 3 - Միջին կշռված գնով։ Արժեք չտալու համակարգը ավտոմատ վերցնում է 1 արժեքը։ |
vat |
Boolean |
Optional |
ԱԱՀ-ով հաշվառվող համարվելու հայտանիշ։ |
checkMarking |
Boolean |
Optional |
True արժեքի դեպքում տվյալ ապրանքը վաճառելիս դրոշմավորման կոդը լրացված չլինելու պարագայում համակարգը թույլ չի տալիս տպել ՀԴՄ կտրոն: |
weight |
Boolean |
Optional |
Նշվում է` տվյալ ապրանքը քաշային է, թե ոչ: Կիրառվում է էլեկտրոնային կշեռքով աշխատելու դեպքում: |
pluCode |
Integer |
Optional |
Ապրանքին տրվող չկրկնվող կոդ, որը ենթակա է արտահանման էլ. կշեռք։ |
showInPriceLists |
Boolean |
Optional |
Եթե որևէ օգտագործողի Փաստաթղթի դրույթներում Ցույց տալ միայն գնացուցակում ներառվածները դրոշակը նշված է, ապա տվյալ օգտագործողի համար բոլոր ապրանքների ընտրման ցանկում կերևան միայն այն ապրանքները, որոնց համար Ցույց տալ գնացուցակներում դրոշակը նշված է։ |
environmentalFeePercent |
Decimal |
Optional |
Ապրանքի (ծառայության) բնապահպանական հարկի %։ |
labelUnitMeasure |
String(3) |
Optional |
Գնապիտակի չափման միավորը այն չափման միավորի կոդն է, որով արտահայտված գինը որպես միավոր գին պետք է արտացոլվի պիտակի ձևանմուշում: |
labelUnitMeasureCoefficient |
Decimal |
Optional |
Գնապիտակի չափման միավորի հապավում։ |
country |
String(3) |
Optional Reference type |
Ապրանքը արտադրող երկիր։ |
producer |
String(4) |
Optional Reference type |
Ապրանքը արտադրող կազմակերպություն։ |
property1 |
String(4) |
Optional Reference type |
Ապրանքը (ծառայությունը) բնութագրող հատկություն 1-ի կոդ։ |
property2 |
String(4) |
Optional Reference type |
Ապրանքը (ծառայությունը) բնութագրող հատկություն 2-ի կոդ։ |
minimumQuantity |
Decimal |
Optional |
Ապրանքի մնացորդի նվազագույն քանակային մեծություն։ |
maximumQuantity |
Decimal |
Optional |
Ապրանքի մնացորդի առավելագույն քանակային մեծություն։ |
addedValuePercent |
Decimal |
Optional |
Ապրանքի (ծառայության) հավելագնի %։ |
aoeCoefficient |
Decimal |
*Required |
Հավելյալ ծախսերի բաշխման գործակից։ |
bonusPercent |
Decimal |
Optional |
Ապրանքի (ծառայության) բոնուսի տոկոս։ Արժեք չտալու դեպքում համակարգի կողմից ավտոմատ լրացվում է 1 արժեքը։ |
bonusPoint |
Decimal |
Optional |
Ապրանքի (ծառայության) բոնուսի միավոր։ |
discountPercent |
Decimal |
Optional |
Ապրանքի (ծառայության) զեղչի տոկոս։ |
mainSupplierId |
Integer |
System defined |
Ապրանքի (ծառայության) հիմնական մատակարարի ներքին նույնացուցիչ։ |
substituteItemsGroup |
String(5) |
Optional Reference type |
Փոխարինվող ապրանքների խմբի կոդ։ |
nameEN |
String(200) |
Optional |
Ապրանքի (ծառայության) անգլերեն անվանում։ |
nameRU |
String(200) |
Optional |
Ապրանքի (ծառայության) ռուսերեն անվանում։ |
additionalSpecification1 |
String(255) |
Optional |
Ապրանքի (ծառայության) լրացուցիչ բնութագիր 1։ |
additionalSpecification2 |
String(255) |
Optional |
Ապրանքի (ծառայության) լրացուցիչ բնութագիր 2։ |
baseUnitMeasureName |
String(3) |
Read only |
Ապրանքի (ծառայության) հիմնական չափման միավորի անվանում։ |
alternativeUnitMeasureName |
String(6) |
Read only |
Ապրանքի (ծառայության) լրացուցիչ չափման միավորի անվանում։ |
mainSupplierCode |
String(5) |
Optional Reference type |
Ապրանքի (ծառայության) հիմնական մատակարարի կոդ։ |
measureUnits [0..n] |
Array |
*Required |
Ապրանքների և ծառայությունների չափման միավորների ցուցակ (մասսիվ): Ցուցակը պետք է պարունակի չափման միավորի առնվազն մեկ տող։ |
barcodes [0..n] |
Array |
Optional |
Ապրանքների և ծառայությունների գծիկավոր կոդերի ցուցակ (մասսիվ): |
Չափման միավորների տողերի դաշտերը
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
default |
Boolean |
Optional |
Հիմնական չափման միավոր է, թե ոչ։ |
coefficient |
decimal |
Optional |
Նշվում է, թե տվյալ չափման մեկ միավորը քանի հիմնական չափման միավորի է հավասար։ |
code |
String(3) |
*Required Reference type |
Չափման միավորի կոդ։ Եթե արժեք չենք տալիս, համակարգը ավտոմատ լրացնում է հիմնական չափման միավորի կոդը։ |
abbreviation |
String(6) |
Read only |
Չափման միավորի հապավում։ Եթե արժեք չենք տալիս, համակարգը ավտոմատ լրացնում է հիմնական չափման միավորի հապավումը։ |
Գծիկավոր կոդերի տողերի դաշտերը
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
unitMeasure |
String(3) |
*Conditional required Reference type |
Չափման միավորի կոդ։ |
abbreviation |
String(6) |
Read only |
Չափման միավորի ի հապավում։ |
barcode |
String(20) |
Optional |
Գծիկավոր կոդ: |
GitHub |
https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/products |
Օրինակ 1. Ապրանքի կամ ծառայության ավելացում (պարտադիր դաշտերով)
|
Օրինակ 2. Ապրանքի կամ ծառայության ավելացում (լրացուցիչ դաշտերով)
POST |
|
Օրինակ 3. Նշված կոդով ապրանքի կամ ծառայության տեղեկատուի տվյալների ստացում
|
Օրինակ 4. Նշված կոդով ապրանքի կամ ծառայության դաշտերի խմբագրում
|
Օրինակ 5. Նշված կոդով ապրանքի կամ ծառայության տեղեկատուի հեռացում
|