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