ArtLab API : Order

Ider Z
ArtLab
Published in
3 min readJan 13, 2022

Энэ нийтлэлээр ЗАХИАЛГЫН СИСТЕМ-ийн захиалгатай ажиллахад шаардлагатай мэдээллийг хүргэнэ.

Эхлээд логин хийж authorization-token авах хэрэгтэй шүү. Яаж авахыг эндээс хараарай.

Захиалгыг хадгалах:

URL : https://api.artlab.mn/order
Method : POST
Content-type: application/json

Ямар нэг query parameter авахгүй. Харин request body дээрээ json обьект авна.

Параметр болж ирэх json обьект нь доорх бүтэцтэй байна.

Талбар            Төрөл      NotNull     Тайлбар
----------------------------------------------------------------
{
orderId long No Захиалгын ID
orderNum string No Захиалгын дугаар
department string No Салбарын код
customerCode string No Харилцагчийн код
phone1 int Yes Захиалга өгсөн утас 1
phone2 int No Захиалга өгсөн утас 2
description string No Нэмэлт тэмдэглэл
deliverAddr string No Хүргэлтийн хаяг
deliverAmt double No Хүргэлтийн нэмэлт хөлс
paymentType string No Урьдчилсан төлбөрийн хэлбэр
statusCode string No Төлөвийн код
dtlList[] list Yes Захиалгын дэлгэрэнгүй
}

orderId: Талбарт ямар нэг захиалгын ID-г өгвөл тухайн захиалгыг засах хэлбэрээр ажиллана. Харин ашиглахгүй эсвэл null байвал шинээр захиалга үүсгэнэ.

orderNum: Захиалгын дугаарыг шууд гараас өгч болно. Харин ашиглахгүй эсвэл null байвал систем автоматаар дугаарлана.

paymentType: Урьдчилсан төлбөрийн хэлбэр нь “cash”, “card”, “loan” статик утгууд байна.

statusCode: Шинэ захиалга үүсгэж байгаа үед ашиглахгүй эсвэл хоосон орхиж болно. Харин засах үйлдэл хийж байгаа бол заавал утгатай байна.

dtlList: нь доорх бүтэцтэй обьектын лист байна.

Талбар            Төрөл   NotNull    Тайлбар
--------------------------------------------------------------------
{
code string Yes Бараа бүтээгдэхүүний код
qty double Yes Тоо хэмжээ
price double Yes Нийт үнэ
disc double Yes Нийт хөнгөлөлт
srcList[] list No Дагалдах бүтээгдэхүүн
}
  • price: НӨАТ орсон, хөнгөлөлт тооцоогүй нийт үнэ байна. Өөрөөр хэлбэл шууд нэгж үнээрээ үржсэн үнэ байна.
  • disc: Нийт үнээс хөнгөлсөн үнийн дүн байна. Мөр бүр дээр өөр өөр хөнгөлөлт байх боломжтой.
  • srcList: Дагалдах бүтээгдэхүүн нь dtlList-тэй адилхан бүтэцтэй байна.

Буцаах утга нь доорх бүтэцтэй обьект байна.

Талбар            Төрөл    Тайлбар
-------------------------------------------------------------------
{
successful boolean Амжилттай болсон эсэх
value long Баримтын ID
error string Алдааны мсж
}
  • Алдааны мсж болон Захиалгын ID нь амжилттай хадгалсан эсэхээс хамаарч аль нэг нь л буцаж ирнэ.
  • Value нь long буюу 64bit int учир javascript-с дуудах үед асуудал үүсдэг юм. Тийм болохоор энэ линкийг уншаад энэний дагуу дуудаарай.

Жишээ:

Захиалгыг харах

URL : https://api.artlab.mn/order/{orderId}?dtl={boolean}
Method : GET

path parameter {orderId}: Захиалгын ID

query parameter dtl: Bool (true, false)-н утга авна. (dtl=true) үед захиалгын дэлгэрэнгүйг хамт дуудаж харуулна.

Буцаах утга нь доорх бүтэцтэй обьект байна.

    Талбар        Төрөл         Тайлбар
----------------------------------------------------------------
{
orderId long Захиалгын ID
orderNum string Захиалгын дугаар
department string Салбарын код
customerCode string Харилцагчийн код
customerName string Харилцагчийн нэр
phone1 int Захиалга өгсөн утас 1
phone2 int Захиалга өгсөн утас 2
description string Нэмэлт тэмдэглэл
deliverAddr string Хүргэлтийн хаяг
deliverAmt double Хүргэлтийн нэмэлт хөлс
paymentType string Урьдчилсан төлбөрийн хэлбэр
createdAt string Захиалга үүссэн огноо
statusCode string Сүүлийн төлөвийн код
statusName string Сүүлийн төлөвийн нэр
statusAt string Сүүлийн төлөвийн огноо

totalPrice double Нийт үнэ
totalDisc double Нийт хөнгөлөлт
totalVat double Нийт НӨАТ
totalCct double Нийт НХАТ
totalGross double Нийт төлөх дүн
dtlList[] list Захиалгын дэлгэрэнгүй
statusLog[] list Төлөвийн өөрчлөлтийн түүх
}

Жишээ 1: Захиалгын хураангуй мэдээлэл

Жишээ 2: Захиалгын дэлгэрэнгүй мэдээлэл

Асууж тодруулах зүйлс байвал доорх хаягаар холбогдоорой,
messenger: fb.me/artlab.mn
email: info@artlab.mn, ider@artlab.mn, gb@artlab.mn

--

--