API-ի միջոցով հնարավոր է ստանալ (POST) ընտրման պայմաններին համապատասխանող գնացուցակ հաշվետվությունը։
URI |
https://api.armsoft.am/trade/v1/reports/pricelist |
Տվյալ ռեսուրսի համար պահանջվում է ավտորիզացիա՝ API բանալու օգտագործմամբ։ Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում. API բանալին ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
-H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Հարցման պարամետրեր (Request Body)
Հաշվետվության ձևավորման պարամետրերը (ցուցադրվող սյուներ, ֆիլտրացում, խմբավորում) փոխանցվում են հարցման մարմնում (Request Body)՝ JSON ձևաչափով։
Անվանում |
Տեսակ |
Կիրառումը |
Նկարագրություն |
date |
Date(YYYY-MM-DD) |
Պարտադիր լրացվող ամսաթիվ տիպի դաշտ է: Գնացուցակը ձևավորվում է այդ ամսաթվով գործող գների համար։ |
|
priceListTypes |
Array |
Դաշտում կարելի է նշել մեկ կամ մի քանի գնի տեսակներ։ |
|
itemType |
Enum |
Ընդունում է 1 - Ապրանք կամ 2 -Ծառայություն արժեքները։ Եթե նշված չէ, գնացուցակը ձևավորվում է և’ ապրանքների, և’ ծառայությունների համար։ |
|
group |
String(5) |
Ապրանքների (ծառայությունների) խմբի կոդը։ |
|
itemCodes |
String(20) |
Ապրանքի կամ ծառայության կոդը, ընդունում է արժեքներ Ապրանքներ և ծառայություններ տեղեկատուից։ Այս դաշտը դատարկ լինելու դեպքում տեղեկատուի մեջ ընդգրկվում են բոլոր ապրանքներն ու ծառայությունները: |
|
itemShowMode |
Enum |
Գնացուցակում ընգրկվածները ընտրելու դեպքում գնացուցակում ընդգրկվում են միայն այն ապրանքները (ծառայությունները), որոնց համար Ցույց տալ գնացուցակում դրոշակը դրված է, Գնացուցակում չընդգրկվածները ընտրելու դեպքում` այն ապրանքները (ծառայությունները), որոնց համար Ցույց տալ գնացուցակում դրոշակը դրված չէ և Բոլորն ընտրելու դեպքում ընդգրկվում են բոլոր ապրանքները (ծառայությունները)։ |
|
showAvailables |
Boolean |
Դրոշակը միացված լինելու դեպքում գնացուցակը կձևավորվի մնացորդներ ունեցող ապրանքների համար: |
Վերադարձվող օբյեկտի ատրիբուտներ (Object Attributes)
Անվանում |
Տեսակ |
Նկարագրություն |
itemid |
Decimal |
Ապրանքի ներքին նույնացուցիչ։ |
itemcode |
string |
Ապրանքի կոդ։ |
itemname |
string |
Ապրանքի անվանումը։ |
unitMeasure |
string |
Ապրանքի չափման միավորի կոդը։ |
unitMeasureAbbreviation |
string |
Ապրանքի չափման միավորի հապավումը։ |
group |
string |
Ապրանքների (ծառայությունների) խմբի կոդը։ |
groupName |
string |
Ապրանքի Խմբի անվանում։ |
specification |
string |
Ապրանքի բնութագիր։ |
prices |
string |
Ապրանքի գինը։ |
|