Գծիկավոր կոդերի ցուցակ

Ուղղորդիչ:  REST API (ամպային տարբերակ) > Տեղեկատուներ > Ապրանքներ և ծառայություններ >

Գծիկավոր կոդերի ցուցակ

 Previous pageReturn to chapter overviewNext page

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

API-ի միջոցով հնարավոր է ստանալ (POST) գծիկավոր կոդերի ցուցակը։

URI

https://api.armsoft.am/trade/v1/directories/barcodes/list

URL Swagger

https://api.armsoft.am/trade/swagger/index.html#/Barcodes/post_v1_directories_barcodes_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 արժեքը ցույց է տալիս, որ կան դեռ չվերադարձված գրառումներ. այսինքն ՝ առկա են հաջորդ էջեր։

  itemCodes[]

Array

Optional

Reference type

Ապրանքների և ծառայությունների ցուցակ (մասսիվ):

 

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

Անվանում

Տեսակ

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

id

Integer

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

hasMore

Boolean

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

data[]

Array

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

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

Անվանում

Տեսակ

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

code

String

Ապրանքի (ծառայության) գծիկավոր կոդ։

itemId

Integer

Ապրանքի (ծառայության) ներքին նույնացուցիչ։

itemCode

String

Ապրանքի (ծառայության)  կոդ։

itemName

String

Ապրանքի (ծառայության) անվանում։

unitMeasure

String

Ապրանքի (ծառայության) չափման միավորի կոդ։

unitMeasureAbbreviation

String

Ապրանքի (ծառայության) չափման միավորի հապավում։

weightItem

Boolean

Նշվում է` տվյալ ապրանքը քաշային է, թե ոչ: Կիրառվում է էլեկտրոնային կշեռքով աշխատելու դեպքում:

 

GitHub

https://github.com/armsoft/trade-public-api-docs/tree/main/examples/csharp/directories/barcodes

Օրինակ 1. Գծիկավոր կոդերի ցուցակի ստացում

POST

Request

 

curl -X POST \

 'https://api.armsoft.am/trade/v1/directories/barcodes/list' \

 -H 'accept: text/plain' \

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

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

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

 -d '

{

 

}'

 

Response body (201 Created)

 

{

 "data": [

{

 "code": "11112",

 "itemId": 100000,

 "itemCode": "1001",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

},

{

 "code": "1001",

 "itemId": 100000,

 "itemCode": "1001",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

},

{

 "code": "1002",

 "itemId": 100001,

 "itemCode": "1002",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

}

]

}

 

Օրինակ 1. Նշված կոդերով ապրանքների և ծառայությունների գծիկավոր կոդերի ցուցակի ստացում

POST

Request

 

curl -X POST \

 'https://api.armsoft.am/trade/v1/directories/barcodes/list' \

 -H 'accept: text/plain' \

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

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

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

 -d '

{

 "itemCodes": [

 "1001",

 "1002"

]

}'

Response body (201 Created)

 

{

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

 "hasMore": true,

 "data": [

{

 "code": "1001",

 "itemId": 100000,

 "itemCode": "1001",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

},

{

 "code": "11112",

 "itemId": 100000,

 "itemCode": "1001",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

},

{

 "code": "1002",

 "itemId": 100001,

 "itemCode": "1002",

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

 "unitMeasure": "001",

 "unitMeasureAbbreviation": "հատ",

 "weightItem": false

}

]

}