ҮНДСЭН ТАЙЛБАР ->
API Endpoint
https://apiv2.system-area.mn/api
SWAGGER REQUEST TESTING
https://apiv2.system-area.mn/docs
Энэхүү веб апи нь манай байгууллагын хүргэлтийн системтэй холболт хийх зорилготой бөгөөд дараах үндсэн дарааллаар ажиллана.
Тухайн байгууллагын онцлогоос шалтгаалж нийтлэг шийдлүүд дээр өөрчлөлт оруулах боломжтой.
Та манай хүргэлтийн АПИ хэрэглэхийг хүсвэл бидэнтэй дараах хаягаар холбогдоорой. Баярлалаа.
Холбоо барих дугаар : (+976) 99011084, (+976) 99293338
0.АПИ Стандарт ->
Request JSON standart :
{
"Version":"SampleVersion",
"FunctionID":"SampleFunctionName",
"JObject":{
"SampleField1":""
}
}
Result JSON standart :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"AnyJsonStructures": ""
}
}
АПИ - руу нэвтрэхээс бусад бүх үйлдлүүд нэгдсэн ижил стандартаар өгөгдлийг солилцоно.
Нэвтрэхээс бусад бүх үйлдлүүд дараах холбоосоор дуудагдана.
https://apiv2.system-area.mn/api/callfunction
REQUEST STANDART
Аливаа өгөгдөл илгээхэд JObject талбар дотор тухайн функцийн тодорхойлолтод заасны дагуу өгөгдлийг илгээнэ.
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | Дуудаж байгаа функцийн хувилбар |
| FunctionID | String | Дуудаж байгаа функцийн нэр |
| JObject | String | Тухайн функцийн тодорхойлолтод заасан утга (optional) |
RESPONSE STANDART
Хүсэлтийн хариу data талбараас бусад утга нэгдсэн байдлаар ижил байна.
data талбарт буцах утга тухайн функцийн заавраас шалтгаалж өөр өөр байна.
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | Тухайн функцийн тодорхойлолтод заасан хариу утга |
1. НЭВТРЭХ ТОКЕН АВАХ ->
METHOD : POST
curl POST 'https://apiv2.system-area.mn/api/account/login' \
--header 'Content-Type: application/json' \
--data-raw '{
"ApiKey": "xxxx",
"UserName": "xxxx",
"Password": "xxxx"
}'
Системтэй холбогдон ажиллахын тулд манайхаас илгээсэн нэр нууц үг болон АПИ түлхүүр ашиглан дараах нэвтрэлтийг гүйцэтгэнэ :
https://apiv2.system-area.mn/api/account/login
Request JSON sample :
{
"ApiKey": "xxx",
"UserName": "xxx",
"Password": "xxx"
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"token": "JWT Token"
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| ApiKey | String | Олгосон түлхүүр |
| UserName | String | Байгууллагад оноосон нэвтрэх нэр |
| Password | String | Байгууллагад оноосон нууц үг |
ХҮРГЭЛТ ->
API Endpoint
https://apiv2.system-area.mn/api
SWAGGER REQUEST TESTING
https://apiv2.system-area.mn/docs
Энэ хэсэг нь зөвхөн хүргэлтийн захиалга үүсгэхэд ашиглах ба зөвхөн хүргэлт баталгаажсан тохиолдолд үүсгэнэ.
Тухайн хүргэлтийг агуулахад өөрөө аваачсан болон хүргэлтийн ажилтан илгээмжийг авснаас хойш устгах болон засварлах боломжгүй болно.
2. ХАЯГИЙН МЭДЭЭЛЭЛ ->
METHOD : POST
curl POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version": "1.0.0",
"FunctionID": "FN_100"
}'
Хүргэлтийн хаягийн мэдээллийг дараах функцээр авах бөгөөд тухайн бүст хүргэлт хийгдэх үнийн мэдээллийг мөн энэ сервисээр авч ашиглана.
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version": "1.0.0",
"FunctionID": "FN_100"
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"Address": [
{
"Oid": "E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Code": "110",
"DistrictName": "Баянгол",
"KhorooName": "14-р хороо",
"FullAddress": "(110),Улаанбаатар,Баянгол,14-р хороо",
"Zone": "A",
"Price": [
{
"Code": 0,
"SizeDescr": "Жижиг",
"Amount": 5000
},
{
"Code": 1,
"SizeDescr": "Дунд",
"Amount": 7000
},
{
"Code": 2,
"SizeDescr": "Том",
"Amount": 10000
}
]
},
{
"Oid": "176DF956-9788-4322-A5DF-30AA4C183DAC",
"Code": "110",
"DistrictName": "Сонгинохайрхан",
"KhorooName": "10-р хороо",
"FullAddress": "(110),Улаанбаатар,Сонгинохайрхан,10-р хороо",
"Zone": "A",
"Price": [
{
"Code": 0,
"SizeDescr": "Жижиг",
"Amount": 5000
},
{
"Code": 1,
"SizeDescr": "Дунд",
"Amount": 7000
}
]
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_100" |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
Address - Хаягийн жагсаалт -Address[n].Oid - Хаягийн код -Address[n].Code - Хялбар код -Address[n].DistrictName - Дүүрэг -Address[n].KhorooName - Хороо -Address[n].FullAddress - Бүрэн хаягийн нэршил -Address[n].Zone - Хүргэлтийн бүс --Address[n].Price - Тухайн хаяг дээрх хүргэлтийн үнэ ---Address[n].Price[n].Code - Илгээмжийн овор хэмжээний код ---Address[n].Price[n].SizeDescr - Илгээмжийн овор хэмжээний нэршил ---Address[n].Price[n].Amount - Тухайн овор хэмжээтэй илгээмжийг хүргэх үнэ |
3. ХҮРГЭЛТИЙН ЗАХИАЛГА ҮҮСГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_101",
"JObject":{
"OrderNo":"",
"RowStatus":"I",
"Type":"1",
"Size":0,
"AddressOid":"CF569A26-B228-4A82-AB71-03639437E454",
"LastName":"LastName",
"FirstName":"FirstName",
"Phone1":"98568799",
"Phone2":"98568799",
"AdditionalInfo":"111111",
"Price":10000,
"ItemCode":"SHIPMENT01",
"Qty":2
}
}'
Сонгогдсон нэгж хүргэлтийн захиалгыг дараах сервисээр үүсгэнэ
Нэг удаа үүсгэсэн хүсэлтийг нэг удаагийн хүргэлт гэж тооцно.
Жишээ нь : Хэрэв 5 ширхэг илгээмж хүргүүлэх бол багцлаад нэг хүргэлт гэж үүсгэнэ
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_101",
"JObject":{
"OrderNo":"",
"RowStatus":"I",
"Type":"1",
"Size":0,
"AddressOid":"CF569A26-B228-4A82-AB71-03639437E454",
"LastName":"LastName",
"FirstName":"FirstName",
"Phone1":"98568799",
"Phone2":"98568799",
"AdditionalInfo":"111111",
"Price":10000,
"ItemCode":"SHIPMENT01",
"Qty":2
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"Order": {
"OrderNo": "600-0035-036"
}
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_101" |
| JObject | JObject |
OrderNo - (Readonly) Систем дээр үүссэн захиалгын дугаар. Засварлах эсвэл устгах хүргэлтийн захиалгын дугаар. Шинээр үүсгэж байгаа бол утга бөглөх шаардлагагүй RowStatus - Хүсэлтийн төрөл. --Захиалга шинээр үүсгэж байгаа бол = "I" --Захиалга засварлаж байгаа бол = "U" --Захиалга устгаж байгаа бол = "D" Type - Хүргэлтийн төрөл. --Энгийн хүргэлт = "1" --Агуулах дээр байршуулах бол = "2" Size - Илгээмжийн үнийн код. Address[n].Price[n].Code талбар дээрх өгөгдлийг бөглөж явуулна. AddressOid - Илгээмжийн хүргэлтийн хаяг. Address[n].Oid талбар дээрх өгөгдлийг бөглөж явуулна. LastName - Хүлээн авагчийн овог. FirstName - Хүлээн авагчийн нэр. Phone1 - Хүлээн авагчийн утас1. Phone2 - Хүлээн авагчийн утас2. AdditionalInfo - Хүлээн авагчийн хаягийн дэлгэрэнгүй тайлбар. Price - Хүргэлтийн үнэ Address[n].Price[n].Amount талбар дээрх өгөгдлийг бөглөж явуулна. ItemCode - Илгээмжийн код Энэ талбарын өгөгдөл давхцах боломжгүй бөгөөд холбогдсон системийн дотоод код байна! Qty - Илгээмжийн тоо Жишээ нь : 1 гутал, 2 оймс хүргүүлж байгаа бол 3 гэсэн утгыг илгээнэ. |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | Order.OrderNo - Систем дээр үүссэн захиалгын дугаар |
4. ХҮРГЭЛТИЙН ТӨЛӨВ ШАЛГАХ ->
METHOD : POST
curl POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version": "1.0.0",
"FunctionID": "FN_102"
}'
Хүргэлтийн одоо ямар төлөв дээр байгааг дараах функцээр авах бөгөөд тухайн захиалгын дугаар эсвэл нийт хүргэлтийн төлөвийн мэдээллийг авна.
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_102",
"JObject":{
"OrderNo":""
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"Order": [
{
"OrderNo": "600-0035-182",
"ItemCode": "2030000363436",
"Qty": 2,
"CreatedDate": "2022.01.04 17:06:36",
"IsTake": true,
"TakeDate": "2022.01.04 17:18:56",
"Delivery": []
},
{
"OrderNo": "600-0035-183",
"ItemCode": "2020000363941",
"Qty": 1,
"CreatedDate": "2022.01.04 17:07:08",
"IsTake": true,
"TakeDate": "2022.01.04 17:18:56",
"Delivery": [
{
"RegDate": "2022.01.04 17:26:01",
"StatusValue": 4,
"StatusName": "Хүргэлтийг цуглуулж байна"
},
{
"RegDate": "2022.01.04 17:26:33",
"StatusValue": 5,
"StatusName": "Хүргэлтийн мэдээллийг шалгаж байна"
},
{
"RegDate": "2022.01.04 17:26:43",
"StatusValue": 7,
"StatusName": "Хүргэлт хийгдэж байна"
},
{
"RegDate": "2022.01.04 17:26:59",
"StatusValue": 8,
"StatusName": "Хүргэлт хийгдэж дууссан байна"
}
]
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_102" |
| JObject | JObject |
OrderNo - Систем дээр үүссэн захиалгын дугаар.
Хэрэв энэ утгыг хоосон явуулбал нийт захиалгын төлөвийг дуудна Хэрэв энэ утгыг өгөгдлөөр дүүргэн явуулбал тухайн захиалгын төлөвийг дуудна |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
Order - Нэгж илгээмж -Order[n].OrderNo - Захиалгын дугаар -Order[n].ItemCode - Илгээмжийн код -Order[n].Qty - Илгээмжийн тоо -Order[n].CreatedDate - Үүсгэсэн огноо -Order[n].IsTake - Илгээмжийг илгээгчээс очиж авсан эсэх -Order[n].TakeDate - Илгээмжийг илгээгчээс очиж авсан огноо --Order[n].Delivery - Илгээмжийн төлөвүүд ---Order[n].Delivery[n].RegDate - Төлөвт шилжсэн огноо ---Order[n].Delivery[n].StatusValue - Төлвийн код ---Order[n].Delivery[n].StatusName - Төлвийн нэр |
5. ХҮРГЭЛТ интерфейс ДУУДАХ ->
IMPORT Defaults
https://apiv2.system-area.mn/css/DeliveryUIDefault.css
https://apiv2.system-area.mn/js/DeliveryUIDefault.js
Хэрвээ тухайн дуудагдаж байгаа загварыг өөрчлөх гэж байгаа бол
зөвхөн JS импорт хийнэ
https://apiv2.system-area.mn/js/DeliveryUIDefault.js
Дээр байгаа замыг импорт хийсний дараа үндсэн KgbOrderInit функцийг
дуудаж интерфейс харуулна.
Жишээ нь JS:
KgbOrderInit({
Authorization: '',
ContainerDivName: 'deliveryForm',
FirstName: 'Дулмаа',
LastName: 'Бат',
Phone1: '99293338',
Phone2: '99293339',
AdditionalInfo: '',
SubmitButtonText: 'Үргэлжлүүлэх',
SizeCode: 1,
StatusChangeEvent: KgbOrder_StatusChanged
});
Үүнээс цааш үйлдлийг интерфейс өөрөө тооцоолох бөгөөд тооцооллын
өөрчлөлт болгонд дараах байдлаар хариу авна.
Хариу авах функцийг KgbOrderInit.StatusChangeEvent - рүү зарлаж
явуулах бөгөөд уг event тухай бүрд хариу өгнө.
Жишээ нь JS:
function KgbOrder_StatusChanged(KGBOrder) {
console.log('KgbOrder_StatusChanged', KGBOrder);
}
Хүргэлтийн мэдээлэл бөглөсний дараа захиалгыг баталгаажуулах функц.
Хэрэв баталгаажсан бол засварлах боломжгүйг анхаарна уу!
Функц ажиллаж дууссаны дараа хариу StatusChangeEvent - д зарласан функцийг шууд дуудна.
Жишээ нь JS:
KGBConfirmOrder('@OrderNo');
Баталгаажсан хүргэлтийн мэдээллийг хүчингүй болгох функц.
Зөвхөн баталгаажсан захиалгыг хүчингүй болгоно!
Функц ажиллаж дууссаны дараа хариу StatusChangeEvent - д зарласан функцийг шууд дуудна.
Жишээ нь JS:
KGBVoidOrder('@OrderNo');
ЖИШЭЭ HTML ФАЙЛ ТАТАХ
Энэ хэсгээр та баруун талд харагдаж байгаа жишээний дагуу бэлэн хүргэлтийн загвар HTML ашиглах боломжтой бөгөөд энэ нь цаг хугацаа болон зардал хэмнэх ач тустай юм.
Жишээ зургийг доор харуулав.
Тухайн загварын CSS танай системд тохирохгүй бол та өөрийн CSS загварыг ашиглах боломжтой.
KgbOrderInit функцийн параметер тайлбар
| Field | Type | Description |
|---|---|---|
| Authorization | String | Json Web Token манайхаас олгосон нэр нууц үгийг ашиглан generate хийн авна.(Required) |
| ContainerDivName | String | Загварыг зурах div элементийн нэр(Required) |
| SubmitButtonText | String | Хүргэлтийн мэдээллийг баталгаажуулах товчны текст утга(Required) |
| SizeCode | int |
Хүргэгдэх барааны овор хэмжээ(Required)
SizeCode=0 - Жижиг SizeCode=1 - Дунд SizeCode=2 - Том |
| StatusChangeEvent | function(result){} |
Тухай бүрд дуудагдах функц(Required) result.OrderNo Үүссэн захиалгын дугаар result.Status Төлөв Төлөвүүдийн тайлбар result.Status=1 Загвар дуудсан result.Status=2 Хадгалах дарсан result.Status=3 Захиалга баталгаажсан (Засварлах боломжгүй) result.Status=4 Захиалга хүчингүй болсон (Засварлах боломжгүй) |
| FirstName | String | Хүлээн авагчийн нэр (Optional) |
| LastName | String | Хүлээн авагчийн овог (Optional) |
| Phone1 | String | Хүлээн авагчийн утас1 (Optional) |
| Phone2 | String | Хүлээн авагчийн утас2 (Optional) |
| AdditionalInfo | String | Хүлээн авагчийн хаягийн дэлгэрэнгүй мэдээлэл (Optional) |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | null |
АГУУЛАХ ->
API Endpoint
https://apiv2.system-area.mn/api
SWAGGER REQUEST TESTING
https://apiv2.system-area.mn/docs
Энэ хэсэг нь агуулахад бараа байршуулах/fullfillment/ үед ашиглана.
Харилцагч болон компанийн гэрээнд тусгасан шаардлага шалтгаануудаас тухай бүрд шалгалтууд өөр өөр байна.
6. ХАРИЛЦАГЧ БҮРТГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_200",
"JObject":{
"RowStatus":"I",
"MerchantCode":"001",
"MerchantType":"C",
"RegNo":"0000038",
"Name":"Нэр",
"Contact":"Холбоо барих хүн",
"Phone":"Холбоо барих утас",
"Email":"Холбоо барих и-мэйл",
"FKAddress":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5"
}
}'
Холбогдсон систем нь өөр дээрээ нэг болон түүнээс олон харилцагчтай байх боломжтой бөгөөд тухай бүрд харилцагчийн мэдээллийг бүртгүүлнэ
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_200",
"JObject":{
"RowStatus":"I",
"MerchantCode":"001",
"MerchantType":"C",
"RegNo":"0000038",
"Name":"Нэр",
"Contact":"Холбоо барих хүн",
"Phone":"Холбоо барих утас",
"Email":"Холбоо барих и-мэйл",
"FKAddress":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5"
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": null
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_200" |
| JObject | JObject |
RowStatus - Хүсэлтийн төрөл. --Харилцагч шинээр үүсгэж байгаа бол = "I" --Харилцагч засварлаж байгаа бол = "U" MerchantCode - Харилцагчийн код. Системийн хувьд дахин давхцахгүй утга байна MerchantType - Харилцагчийн төрөл. "C" - Байгууллага "P" - Хувь хүн RegNo - Харилцагчийн регистрийн дугаар. "MerchantType" : "C" бол байгууллагын регистрийн дугаар "MerchantType" : "P" бол хувь хүний регистрийн дугаар Name - Харилцагчийн нэр. Contact - Харилцагчийн холбоо барих хүний нэр Phone - Харилцагчийн холбоо барих хүний утасны дугаар Email - Харилцагчийн холбоо барих хүний и-мэйл хаяг FKAddress - Харилцагчийн түгээх бүсийн хаягийн Oid. ХАЯГИЙН МЭДЭЭЛЭЛ : FN_100 функцээс ирсэн Oid-г бөглөнө. Оруулахгүй байсан ч болно. Хэрэв хүргэлтийн захиалга үүсгэх бол заавал бөглөнө |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | null |
6a. ХАРИЛЦАГЧ ТАТАХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_200a",
"JObject":{
"MerchantCode":"001"
}
}'
Бүртгэсэн харилцагчийн мэдээллийг татах
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_200a",
"JObject":{
"MerchantCode":"001"
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"Merchant": [
{
"MerchantCode": "1",
"MerchantType": "C",
"RegNo": "0000038",
"Name": "Test",
"Contact": "admin",
"Phone": "1122",
"Email": "98568799",
"FKAddress": "E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"CreatedDate": "2022.01.14 17:44:42"
}
]
}
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_200a" |
| JObject | JObject |
MerchantCode - Харилцагчийн код. Хэрэв утга олгохгүй бол бүх харилцагчийн мэдээллийг татна |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
Merchant - Үүссэн харилцагч --Merchant[n].MerchantCode - Мерчантын код. --Merchant[n].MerchantType - Харилцагчийн төрөл. --Merchant[n].RegNo - Харилцагчийн РД. --Merchant[n].Name - Харилцагчийн нэр. --Merchant[n].Contact - Холбоо барих хүн. --Merchant[n].Phone - Утас. --Merchant[n].Email - И-Мэйл. --Merchant[n].FKAddress - Харицлагчийн хаяг. Бүсчлэлийн код --Merchant[n].CreatedDate - Сервер дээр үүссэн огноо. |
7. БАРАА БҮРТГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_201",
"JObject":{
"RowStatus":"I",
"MerchantCode":"001",
"ItemCode":"Барааны код",
"Name":"Барааны нэр",
"NetWeight":130,
"GrossWeight":145
}
}'
Тухайн мерчант-д харгалзах барааг бүртгүүлнэ. MerchantCode,ItemCode талбарууд unique талбар байна
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_201",
"JObject":{
"RowStatus":"I",
"MerchantCode":"1",
"ItemCode":"Барааны код",
"Name":"Барааны нэр",
"NetWeight":130,
"GrossWeight":145
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": null
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_201" |
| JObject | JObject |
RowStatus --Бараа шинээр үүсгэж байгаа бол = "I" --Бараа засварлаж байгаа бол = "U" --Бараа устгаж байгаа бол = "D" MerchantCode - Харилцагчийн код ItemCode - Барааны код Name - Барааны нэр NetWeight - Барааны цэвэр жин (optional) GrossWeight - Барааны бохир жин (optional) |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | null |
7a. БАРААНЫ ХЭМЖИХ НЭГЖ БҮРТГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_202",
"JObject":{
"RowStatus":"U",
"MerchantCode":"1",
"ItemCode":"Барааны код",
"UnitCode":"BLACK-XL",
"UnitName":"Жижиг",
"BarCode":""
}
}'
Тухайн мерчантын бараанд харгалзах хэмжих нэгжийг бүртгүүлнэ. MerchantCode,ItemCode,UnitCode талбарууд unique талбар байна
Жишээ нь Цагаан цамц гэсэн бараа үндсэн бараагаар бүртгэсэн бол түүнд харгалзах размер өнгөөр ялган бүртгэх боломжтой
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_202",
"JObject":{
"RowStatus":"U",
"MerchantCode":"1",
"ItemCode":"Барааны код",
"UnitCode":"BLACK-XL",
"UnitName":"Жижиг",
"BarCode":""
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": null
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_201" |
| JObject | JObject |
RowStatus --Хэмжих нэгж шинээр үүсгэж байгаа бол = "I" --Хэмжих нэгж засварлаж байгаа бол = "U" --Хэмжих нэгж устгаж байгаа бол = "D" MerchantCode - Харилцагчийн код ItemCode - Барааны код Өмнө бүртгэсэн ItemCode UnitCode - Хэмжих нэгжийн код UnitName - Хэмжих нэгжийн нэр эсвэл тайлбар BarCode - Барааны бар код (optional) |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject | null |
8. БАЙРШУУЛАХ ЗАХИАЛГА ҮҮСГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_203",
"JObject":{
"RowStatus":"I",
"MerchantCode":"1",
"OrderType":"CM",
"Descr":"Descr",
"Address":"Address",
"AddressOid":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Items":[
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Барааны нэр",
"ReceiveUnitQty":1,
"ReceiveUnitPrice":2
},
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Барааны нэр",
"ReceiveUnitQty":1,
"ReceiveUnitPrice":2
}
]
}
}'
Энэ функцийг ашиглан мерчант болгоноор агуулахруу бараа буулгах хуваарийг үүсгэнэ.
Тухайн мерчантын бараанд харгалзах ItemCode,UnitCode,ReceiveUnitQty,ReceiveUnitPrice талбаруудыг бөглөн явуулж захиалга үүсгэнэ
Амжилттай үүссэний дараа ирсэн хариуг хадгалж авна уу!!!
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_203",
"JObject":{
"RowStatus":"I",
"MerchantCode":"1",
"OrderType":"CM",
"Descr":"Descr",
"Address":"Address",
"AddressOid":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Items":[
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Барааны нэр",
"ReceiveUnitQty":1,
"ReceiveUnitPrice":2
},
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Барааны нэр",
"ReceiveUnitQty":1,
"ReceiveUnitPrice":2
}
]
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"CreatedItems": [
{
"ShipSchdNo": "SS00000006",
"Items": [
{
"ShipSchdItemID": 11,
"MerchantCode": "1",
"ItemCode": "Барааны код",
"UnitCode": "Барааны нэр",
"ReceiveUnitQty": 1,
"ReceiveUnitPrice": 2
},
{
"ShipSchdItemID": 12,
"MerchantCode": "1",
"ItemCode": "Барааны код",
"UnitCode": "Барааны нэр",
"ReceiveUnitQty": 1,
"ReceiveUnitPrice": 2
}
]
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_203" |
| JObject | JObject |
RowStatus --Шинээр үүсгэж байгаа бол = "I" --Засварлаж байгаа бол = "U" --Устгаж байгаа бол = "D" ShipSchdNo - Буулгах хуваарийн дугаар. Шинээр бүртгэж байгаа үед хоосон байна MerchantCode - Харилцагчийн код OrderType - Захиалгын төрөл. "CM" - Ирж авах "TO" - Өөрийн машинаар буулгах Descr - Тайлбар ReqDate - Захиалга биелэх огноо (optional), IF OrderType = "TO" THEN required ArriveDate - Захиалга биелэх цаг (optional) TransportNo - Тээврийн хэрэгслийн улсын дугаар (optional) Address - Хэрэв захиалгын төрөл [OrderType:CM] байвал очиж авах дэлгэрэнгүй хаяг оруулна. AddressOid - Хэрэв захиалгын төрөл [OrderType:CM] байвал очиж авах бүсчлэлийн кодыг ХАЯГИЙН МЭДЭЭЛЭЛ серсисийн Address[n].Oid талбарыг бөглөн явуулна. -Items - Захиалсан бараанууд --Items[n].RowStatus --Шинээр үүсгэж байгаа бол = "I" --Засварлаж байгаа бол = "U" --Устгаж байгаа бол = "D" --Items[n].ItemCode - Харилцагчийн барааны код --Items[n].UnitCode - Харилцагчийн барааны хэмжих нэгж --Items[n].ReceiveUnitQty - Захиалсан барааны тоо --Items[n].ReceiveUnitPrice - Захиалсан барааны нэгж үнэ |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
CreatedItems - Үүссэн багц буулгах хуваарь -CreatedItems.ShipSchdNo - Буулгах хуваарийн дугаар. Өөрийн бааз руу хадгална уу! -CreatedItems.Items - Багцад харгалзах бараанууд --CreatedItems.Items[n].ShipSchdItemID - Буулгах хуваарийн барааны мөрийн дугаар. Өөрийн бааз руу хадгална уу! --CreatedItems.Items[n].MerchantCode - Мерчантын код. --CreatedItems.Items[n].ItemCode - Барааны код. --CreatedItems.Items[n].UnitCode - Барааны хэмжих нэгжийн код. --CreatedItems.Items[n].ReceiveUnitQty - Захиалсан тоо. --CreatedItems.Items[n].ReceiveUnitPrice - Захиалсан үнэ. |
9. ХҮРГЭЛТИЙН ЗАХИАЛГА ҮҮСГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_204",
"JObject":{
"RowStatus":"I",
"SONo": "",
"MerchantCode":"1",
"Descr":"Descr",
"Recipient":{
"Size":"1",
"AddressOid":"AED758C6-F48B-46C4-B335-03C6755A2C68",
"LastName":"Батаа",
"FirstName":"Дулмаа",
"Phone1":"99887744",
"Phone2":"88775544",
"AdditionalInfo":"Алтаргана хотхон 3 дахьбайр 12 дав 43 тоот орцны код #5544",
"Price":1000
},
"Items":[
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Хэмжих нэгжийн код",
"UnitQty":1,
"UnitPrice":2,
"OrderItemType":"WS",
"FKAddress":"",
"Address":"",
},
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Хэмжих нэгжийн код",
"UnitQty":1,
"UnitPrice":2,
"OrderItemType":"ST",
"FKAddress":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Address":"Дэлгэрэнгүй хаяг",
}
]
}
}'
Тухайн худалдан авалт баталгаажсан бол энэ функцийг ашиглан хүргэлтийн захиалга үүсгэнэ
Тухайн бараанд харгалзах ItemCode,UnitCode,UnitQty,UnitPrice талбаруудыг бөглөн явуулж захиалга үүсгэнэ
Хэрэв мөрийн барааны захиалгын төрөл(OrderItemType) WS байвал шууд агуулахаас хүргэлт хийгдэнэ.
Хэрэв мөрийн барааны захиалгын төрөл(OrderItemType) ST очиж цуглуулах бүсийн код(FKAddress) болон дэлгэрэнгүй хаягийн(Address) мэдээллийнг заавал оруулна!
Амжилттай үүссэний дараа ирсэн хариуг хадгалж авна уу!!!
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_204",
"JObject":{
"RowStatus":"I",
"SONo": "",
"MerchantCode":"1",
"Descr":"Descr",
"Recipient":{
"Size":"1",
"AddressOid":"AED758C6-F48B-46C4-B335-03C6755A2C68",
"LastName":"Батаа",
"FirstName":"Дулмаа",
"Phone1":"99887744",
"Phone2":"88775544",
"AdditionalInfo":"Алтаргана хотхон 3 дахьбайр 12 дав 43 тоот орцны код #5544",
"Price":1000
},
"Items":[
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Хэмжих нэгжийн код",
"UnitQty":1,
"UnitPrice":2,
"OrderItemType":"WS",
"FKAddress":"",
"Address":"",
},
{
"RowStatus":"I",
"ItemCode":"Барааны код",
"UnitCode":"Хэмжих нэгжийн код",
"UnitQty":1,
"UnitPrice":2,
"OrderItemType":"ST",
"FKAddress":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Address":"Дэлгэрэнгүй хаяг",
}
]
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"CreatedItems": [
{
"SONo": "SO00000008",
"Recipient": [
{
"Size": "1",
"AddressOid": "AED758C6-F48B-46C4-B335-03C6755A2C68",
"LastName": "Батаа",
"FirstName": "Дулмаа",
"Phone1": "99887744",
"Phone2": "88775544",
"AdditionalInfo": "Алтаргана хотхон 3 дахьбайр 12 дав 43 тоот орцны код #5544",
"Price": 1000,
"Items": [
{
"SOItemID": 14,
"MerchantCode": "1",
"ItemCode": "Барааны код",
"UnitCode": "Барааны нэр",
"UnitQty": 1,
"UnitPrice": 2,
"OrderItemType":"ST",
"FKAddress":"E4BBFE25-2320-4B75-8CF1-BD2D004297A5",
"Address":"Дэлгэрэнгүй хаяг",
},
{
"SOItemID": 15,
"MerchantCode": "1",
"ItemCode": "Барааны код",
"UnitCode": "Барааны нэр",
"UnitQty": 1,
"UnitPrice": 2,
"OrderItemType":"WS",
"FKAddress":"",
"Address":"",
}
]
}
]
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_204" |
| JObject | JObject |
RowStatus --Шинээр үүсгэж байгаа бол = "I" --Засварлаж байгаа бол = "U" --Устгаж байгаа бол = "D" SONo - Хүргэлтийн захиалгын дугаар. Шинээр бүртгэж байгаа үед хоосон байна MerchantCode - Харилцагчийн код Descr - Тайлбар -Recipient - Хүлээн авагчийн мэдээлэл --Recipient.Size - Илгээмжийн үнийн код. Address[n].Price[n].Code талбар дээрх өгөгдлийг бөглөж явуулна. --Recipient.AddressOid - Илгээмжийн хүргэлтийн хаяг. Address[n].Oid талбар дээрх өгөгдлийг бөглөж явуулна. --Recipient.LastName - Хүлээн авагчийн овог. --Recipient.FirstName - Хүлээн авагчийн нэр. --Recipient.Phone1 - Хүлээн авагчийн утас1. --Recipient.Phone2 - Хүлээн авагчийн утас2. --Recipient.AdditionalInfo - Хүлээн авагчийн хаягийн дэлгэрэнгүй тайлбар. --Recipient.Price - Хүргэлтийн үнэ Address[n].Price[n].Amount талбар дээрх өгөгдлийг бөглөж явуулна. -Items - Захиалсан бараанууд --Items[n].RowStatus --Шинээр үүсгэж байгаа бол = "I" --Засварлаж байгаа бол = "U" --Устгаж байгаа бол = "D" --Items[n].ItemCode - Харилцагчийн барааны код --Items[n].UnitCode - Харилцагчийн барааны хэмжих нэгж --Items[n].UnitQty - Захиалсан барааны тоо --Items[n].UnitPrice - Захиалсан барааны нэгж үнэ --Items[n].OrderItemType - --Агуулахаас шууд гаргах бол = "WS" --Харилцагчийн байршлаас цуглуулах бол = "ST" --Items[n].FKAddress - Items[n].OrderItemType = ST бол очиж цуглуулах бүсчлэлийн код заавал оруулна! --Items[n].Address - Items[n].OrderItemType = ST бол очиж цуглуулах хаягийн дэлгэрэнгүй заавал оруулна! |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
CreatedItems - Үүссэн багц буулгах хуваарь -CreatedItems.SONo - Хүргэлтийн захиалгын дугаар. Өөрийн бааз руу хадгална уу! --CreatedItems.Recipient.Items[n].SOItemID - Захиалсан барааны мөрийн дугаар. Өөрийн бааз руу хадгална уу! Бусад мэдээлэл таны илгээсэн мэдээллийн манай сан дээрх өгөгдөл бөгөөд баталгаажуулах зорилготой болно |
ЛАВЛАГАА /optional/ ->
API Endpoint
https://apiv2.system-area.mn/api
АГУУЛАХЫН МОДУЛЬТАЙ ХОЛБООТОЙ ЛАВЛАХ ТАЙЛАНГУУДЫГ ТАТНА
10. БАРААНЫ ҮЛДЭГДЭЛ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_300",
"JObject":{
"MerchantCode":"1",
"ItemCode":"1",
"UnitCode":"1"
}
}'
Энэ функцийг ашиглан мерчант болгоноор агуулахад байгаа барааны үлдэгдлийг татна
MerchantCode заавал илгээх ба ItemCode,UnitCode талбарууд optional байна.
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_300",
"JObject":{
"MerchantCode":"1",
"ItemCode":"1",
"UnitCode":"1"
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"ItemBin": [
{
"MerchantCode": "1",
"ItemCode": "ITEMCODE",
"UnitCode": "UNITCODE",
"Name": "Барааны нэр",
"HandQty": 10,
"AvailableQty": 8
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_300" |
| JObject | JObject |
MerchantCode - Харилцагчийн код ItemCode - Харилцагчийн барааны код /optional/ UnitCode - Харилцагчийн барааны хэмжих нэгж код /optional/ |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
ItemBin - Барааны үлдэгдлийн жагсаалт -ItemBin[n].MerchantCode - Харилцгачийн код -ItemBin[n].ItemCode - Мерчантын код. -ItemBin[n].UnitCode - Барааны код. -ItemBin[n].Name - Барааны хэмжих нэгжийн код. -ItemBin[n].HandQty - Гар дээрх үлдэгдэл. -ItemBin[n].AvailableQty - Боломжит үлдэгдэл. |
11. ГҮЙЛГЭЭНИЙ ТҮҮХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_301",
"JObject":{
"MerchantCode":"1",
"BegDate":"2021.12.01",
"EndDate":"2022.01.20",
"ItemCode":"1",
"UnitCode":"1"
}
}'
Энэ функцийг ашиглан мерчант болгоноор тухайн барааны хөдөлгөөний түүхийг харуулна.
MerchantCode,BegDate,EndDate заавал илгээх ба ItemCode,UnitCode талбарууд optional байна.
BegDate - EndDate 90 хоног дотор хайлт хийнэ
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_301",
"JObject":{
"MerchantCode":"1",
"BegDate":"2021.12.01",
"EndDate":"2022.01.20",
"ItemCode":"1",
"UnitCode":"1"
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"TxnHist": [
{
"MerchantCode": "1",
"ItemCode": "ITEMCODE",
"UnitCode": "UNITCODE",
"Name": "Барааны нэр",
"UnitName": "Барааны нэр",
"TxnDate":"2022.01.05",
"TxnNo": "SO00000008",
"TxnItemID": 1,
"TxnType":"INWS",
"TxnTypeName":"Орлого авах - Буулгах хуваариас",
"UnitQty":10,
"UnitAmt":15000,
"UnitTotalAmt": 150000,
"CreatedDate":"2022.01.05 19:01:12"
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_301" |
| JObject | JObject |
MerchantCode - Харилцагчийн код BegDate - Эхлэх огноо yyyy.MM.dd форматтай байна EndDate - Дуусах огноо yyyy.MM.dd форматтай байна ItemCode - Харилцагчийн барааны код /optional/ UnitCode - Харилцагчийн барааны хэмжих нэгж код /optional/ |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
TxnHist - Барааны түүх жагсаалт -TxnHist[n].MerchantCode - Харилцагчийн код -TxnHist[n].ItemCode - Мерчантын код. -TxnHist[n].UnitCode - Барааны код. -TxnHist[n].Name - Барааны нэр. -TxnHist[n].UnitName - Барааны хэмжих нэгжийн нэр. -TxnHist[n].TxnDate - Гүйлгээ хийсэн огноо. -TxnHist[n].TxnNo - Гүйлгээний дугаар. -TxnHist[n].TxnItemID - Гүйлгээний мөрийн дугаар. -TxnHist[n].TxnType - Гүйлгээний төрлийн код. -TxnHist[n].TxnTypeName - Гүйлгээний төрлийн нэр. -TxnHist[n].UnitQty - Тоо. -TxnHist[n].UnitAmt - Нэгж үнэ. -TxnHist[n].UnitTotalAmt - Нийт үнэ. -TxnHist[n].UnitTotalAmt - Үүсгэсэн огноо. |
ОЛОН УЛСЫН ЗАХИАЛГА
API Endpoint
https://apiv2.system-area.mn/api
Олон улсын захиалгатай холбоотой сервисүүд
12. ЗАХИАЛГА ҮҮСГЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_400",
"JObject":{
"RowStatus":"I",
"Oid":"",
"BatchNo":"",
"Currency":"KRW",
"OrderType":1,
"ItemName":"ItemName",
"FKCargoType":1,
"WebSite":"",
"IsDelivery":true,
"FKAddress":"",
"ContactPhone":"",
"Apt":"",
"AptNumber":"",
"ReceiverFirstName":"",
"ReceiverLastName":"",
"ReceiverPhone1":"",
"ReceiverPhone2":"",
"ReceiverDescription":"",
"AllowDelivery":"NONPAID",
"Items":[
{
"RowStatus":"",
"Oid":"",
"No":1,
"FKCategory":1,
"Qty":2,
"Price":1500,
"ItemName":"",
"BrandName":"",
"TrackNumber":"xxxxxx"
}
]
}
}'
Олон улсын захиалгын мэдээлэл илгээх функц. Мэдээллийг илгээсний дараа оператор баталгаажуулснаас хойш захиалга баталгаажих юм.
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_400",
"JObject":{
"RowStatus":"I",
"Oid":"",
"BatchNo":"",
"Currency":"KRW",
"OrderType":1,
"ItemName":"ItemName",
"FKCargoType":1,
"WebSite":"",
"IsDelivery":true,
"FKAddress":"",
"ContactPhone":"",
"Apt":"",
"AptNumber":"",
"ReceiverFirstName":"",
"ReceiverLastName":"",
"ReceiverPhone1":"",
"ReceiverPhone2":"",
"ReceiverDescription":"",
"AllowDelivery":"NONPAID",
"Items":[
{
"RowStatus":"",
"Oid":"",
"No":1,
"FKCategory":1,
"Qty":2,
"Price":1500,
"ItemName":"",
"BrandName":"",
"TrackNumber":"xxxxxx"
}
]
}
}
Result JSON sample :
{
"success":true,
"message":"",
"errordesc":null,
"errorcode":0,
"data":{
"OrderNo":"300-5794-595",
"BatchNo":"@BatchNo",
"Oid":"822C908B-3F5E-44C0-9252-0008922DC2A5",
"Items":[
{
"Oid":"C389E669-2119-4359-8289-46452C54BF58",
"No":1,
"TrackNumber":"@TrackNumber",
}
]
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_400" |
| JObject | JObject |
RowStatus - Хүсэлтийн төрөл. --Захиалга шинээр үүсгэж байгаа бол = "I" --Захиалга засварлаж байгаа бол = "U" --Захиалга устгаж байгаа бол = "D" Oid - Засвар хийх үед бөглөнө /optional/ BatchNo - Багцлалт буюу нэг захиалгын дугаар Currency - Валют KRW хатуу бөглөн илгээнэ OrderType - Төрөл. Хувийн илгээмж бол = 1 Онлайн захиалга бол = 2 ItemName - Барааны нэр тайлбар FKCargoType - Тээврийн төрөл. Агаар = 1 Газар = 2 IsDelivery - Хот доторх хүргэлт хийгдэх эсэх FKAddress - Хаягын Oid (FN_100 функц дээрээс сонгон илгээнэ) ContactPhone - Холбоо барих утасны дугаар Apt - Хүргэлт хийгдэх хаяг, байр AptNumber - Хүргэлт хийгдэх хаяг, байр тоот ReceiverFirstName - Хүлээн авагчийн нэр ReceiverLastName - Хүлээн авагчийн овог ReceiverPhone1 - Хүлээн авагчийн утас 1 ReceiverPhone2 - Хүлээн авагчийн утас 2 ReceiverDescription - Хүлээн авагчийн дэлгэрэнгүй хаяг AllowDelivery - Тухайн илгээмжийн төлбөрийн хэлбэр NONPAID = Төлбөр төлөгдөөгүй тул хүргэлтэд гарахгүй PAID = Төлбөр төлөгдсөн хүргэлтэд гаргана -Items - Захиалсан илгээмжийн дэлгэрэнгүй. --Items[n].RowStatus - Мөр шинээр үүсгэж байгаа бол = "I" --Мөр засварлаж байгаа бол = "U" --Мөр устгаж байгаа бол = "D" --Items[n].Oid - Илгээмжийн дэлгэрэнгүй Oid. Засвар хийх үед бөглөнө /optional/ --Items[n].No - Мөрийн дугаар --Items[n].FKCategory - Ангилал --Items[n].Qty - Тоо ширхэг --Items[n].Price - Нийт үнэ --Items[n].ItemName - Нэр --Items[n].BrandName - Брэнд нэр --Items[n].TrackNumber - Трак дугаар |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
OrderNo - Системийн трак дугаар Oid - Систем дээр үүссэн код -Items[n].Oid - Мөрийн код. -Items[n].No - Дэс дугаар. |
13. ЗАХИАЛГЫН ТӨЛӨВИЙГ ИЛГЭЭХ /callback url/ ->
Холболт хийгдсэн систем дараах драфтаар хүлээн авах GET сервис бэлдэх ба амжлттай хүлээн авсан үед үндсэн төлөв 200 статус буцаавал дахин илгээгдэхгүй болно.
URL PARAMETERS
| Field | Type | Description |
|---|---|---|
| CallBackKey | String | Манай системээс олгосон түлхүүр очих бөгөөд хэрэв энэ утга манайхаас олгосон түлхүүр талбар биш бол асуудалтай хүсэлт гэсэн үг |
| OrderNo | String | XXX-XXXX-XXX форматтай захиалгын дугаар |
| Oid | String | Guid систем дээр үүссэн код |
| Status | int | Төлөвийн код |
| StatusName | String | Төлөвийн нэр |
14. ЗАХИАЛГА ТӨЛӨВ ШАЛГАХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_401",
"JObject":{
"Oid":"",
"OrderNo":""
}
}'
Олон улсын захиалгын төлвийн мэдээлэл сүүлчийн байдлаар татах функц. Үнэ жингийн мэдээллүүд анхны төлвөөс хойш бөглөгдөнө
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_401",
"JObject":{
"Oid":"",
"OrderNo":"",
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": {
"Order": {
"Oid": "87D5588C-7A68-4CFE-B924-34A2AD7FE88F",
"OrderNo": "300-6669-610",
"Status": 6,
"StatusName": "Түгээлтэнд гарсан",
"IsDelivery": 1,
"DeliveryTotalPrice": 2500,
"CargoUnitPrice": 7500,
"CargoTotalPrice": 7500,
"TotalPrice": 10000,
"PackageWeight": 0.62,
"CreatedDate": "2023-11-24T08:32:39.647"
}
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_401" |
| JObject | JObject |
Oid - Засвар хийх үед бөглөнө /optional/ OrderNo - 300 prefix тэй захиалгын № |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
Oid - Систем дээр үүссэн код OrderNo - Системийн трак дугаар Status - Төлвийн код StatusName - Төлвийн нэр IsDelivery - Улаанбаатар хот доторх хүргэлттэй эсэх DeliveryTotalPrice - Улаанбаатар хот доторх хүргэлтйи үнэ CargoUnitPrice - Карго нэгж жингийн үнэлгээ CargoTotalPrice - Карго нийт жингийн үнэлгээ TotalPrice - Нийт тооцсон үнэ PackageWeight - Илгээмжийн жин CreatedDate - Үүсгэсэн огноо |
15. ЗАХИАЛГА ТӨЛБӨРИЙН ТӨЛӨВ ИЛГЭЭХ ->
METHOD : POST
curl --location --request POST 'https://apiv2.system-area.mn/api/CallFunction' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data-raw '{
"Version":"1.0.0",
"FunctionID":"FN_402",
"JObject":{
"Oid":"",
"OrderNo":"",
"AllowDelivery":""
}
}'
Тухайн илгээмжийг тодорхой шалтгааны улмаас хүргэлтэд гаргахгүй байх мөн түүнийг цуцлах үед ашиглана
https://apiv2.system-area.mn/api/callfunction
Request JSON sample :
{
"Version":"1.0.0",
"FunctionID":"FN_402",
"JObject":{
"Oid":"",
"OrderNo":"",
"AllowDelivery":""
}
}
Result JSON sample :
{
"success": true,
"message": "",
"errordesc": null,
"errorcode": 0,
"data": null
}
}
JSON PARAMETERS
| Field | Type | Description |
|---|---|---|
| Version | String | "1.0.0" |
| FunctionID | String | "FN_402" |
| JObject | JObject |
Oid - Засвар хийх үед бөглөнө /optional/ OrderNo - 300 prefix тэй захиалгын № AllowDelivery - Тухайн илгээмжийн төлбөрийн хэлбэр NONPAID = Төлбөр төлөгдөөгүй тул хүргэлтэд гарахгүй PAID = Төлбөр төлөгдсөн хүргэлтэд гаргана |
JSON RESULTS
| Field | Type | Description |
|---|---|---|
| success | bool | Хэрэв дуудсан функц алдаагүй ажилласан бол "true" үгүй бол "false" утга буцаана |
| message | String | Дуудаж байгаа функц амжилттай ажилласан талаарх тайлбар |
| errordesc | String | success = false бол алдааны мэдээлэл |
| errorcode | int | Алдааны код |
| data | JObject |
5. Алдааны тайлбар ->
Илгээсэн хүсэлт болгон дээр дараах алдаанууд ирэх боломжтой бөгөөд энэ нь HTTP.STATUSCODE = 200 үед биелнэ
| errorcode | Тайлбар |
|---|---|
| 0 | Алдаа гараагүй |
| 100 | Системийн алдаа. Энэ тохиолдолд систем админтай холбогдон шалгуулна. |
| 101 | Шалгуур хангаагүй алдаа 1 буюу Validation даваагүй алдаа. Энэ тохиолдолд мөн админаас асуух эсвэл гарын авлагыг дахин сайтар унших хэрэгтэй |
| 102 | Шалгуур хангаагүй алдаа 2 буюу Validation даваагүй алдаа. Энэ тохиолдолд мөн админаас асуух эсвэл гарын авлагыг дахин сайтар унших хэрэгтэй |