Skip to content

API Specification

Thawatchai Jongsuwanpaisan edited this page Jun 11, 2023 · 22 revisions

API Product list

คำอธิบาย

สำหรับไว้แสดงรายการสินค้า

URL: /api/v1/product

METHOD: GET

Response

Header

Content-Type: application/json

Body
status code : 200
{
    "total": 2,
    "products": [
        {
            "id": 1,
            "product_name": "Balance Training Bicycle",
            "product_price": 119.95,
            "product_image": "/Balance_Training_Bicycle.png"
        },
        {
            "id": 2,
            "product_name": "43 Piece dinner Set",
            "product_price": 12.95,
            "product_image": "/43_Piece_dinner_Set.png"
        }
    ]
}
Name Type Description
total int จำนวนสินค้า
id int รหัสสินค้า
product_name string ชื่อสินค้า
product_price decimal ราคาสินค้า
product_image string รูปภาพสินค้า

API: Product Detail

คำอธิบาย

สำหรับแสดงข้อมูลของสินค้าชิ้นนั้น

URL: /api/v1/product/:id

Example: /api/v1/product/2

METHOD: GET

Request

Header
{
    "Accept": "application/json"
}

Response

Body
status code : 200
{
    "id": 2,
    "product_name": "43 Piece dinner Set",
    "product_price": 12.95,
    "product_image": "/43_Piece_dinner_Set.png",
    "quantity": 10,
    "product_brand": "CoolKidz"
}
Name Type Description
product_name string ชื่อสินค้า
product_price decimal ราคาสินค้า
product_quantity int จำนวนสินค้า
product_brand string ยี่ห้อสินค้า
product_image string รูปภาพสินค้า

API : Submit Order

คำอธิบาย

ยืนยันการสั่งซื้อสินค้า โดยจะส่งข้อมูลสินค้าและที่อยู่ในการจัดส่ง

URL : /api/v1/order

METHOD: POST

Request

Header
{
    "Content-Type": "application/json"
}
Body
{
	"cart":[
		{
			"product_id": 2,
			"quantity": 1
		}
	],
	"shipping_method": "Kerry",
	"shipping_address": "405/37 ถ.มหิดล",
	"shipping_sub_district": "ท่าศาลา",
	"shipping_district": "เมือง",
	"shipping_province": "เชียงใหม่",
	"shipping_zip_code": "50000",
	"recipient_name": "ณัฐญา ชุติบุตร",
	"recipient_phone_number": "0970809292"
}
Name Type Description
cart object ตะกร้าสินค้า
product_id int หมายเลขคำสั่งซื้อ
quantity int จำนวนสินค้า
shipping_method string วิธีการจัดส่ง
shipping_address string ที่อยู่
shipping_sub_district string ตำบล
shipping_district string อำเภอ
shipping_province string จังหวัด
shipping_zip_code string รหัสไปรษณีย์
recipient_name string ชื่อผู้รับ
recipient_phone_number string เบอร์โทรศัพท์

Response

Header
{
    "Content-Type": "application/json"
}
Body
status code : 200
{
    "order_id": 8004359122,
    "total_price": 14.95
}
Name Type Description
order_id int รหัสคำสั่งซื้อ
total_price decimal ราคารวม

API : Confirm Payment

คำอธิบาย

ยืนยันการชำระเงิน โดยจะส่งข้อมูลการชำระเงินเพื่อนำไปตัดเงินที่ธนาคารและส่งข้อมูลที่อยู่ในการจัดส่งให้กับทางขนส่งสินค้า

URL : /api/v1/confirmPayment

METHOD: POST

Request

Header
{
    "Content-Type": "application/json"
}
Body
{
    "order_id" : 8004359122,
    "payment_type" : "credit",
    "type" : "visa",
    "card_number" : "4719700591590995",
    "cvv" : "752",
    "expired_month" : 7,
    "expired_year" : 20,
    "card_name" : "Karnwat Wongudom",
    "total_price" : 14.95
}
Name Type Description
order_id int เลขของออเดอร์
payment_type string วิธีการชำระเงิน
type string ประเภทบัตร
card_number string หมายเลขบัตร
cvv string ยี่ห้อสินค้า
expired_month int เดือนที่หมดอายุของบัตร
expired_year int ปีที่หมดอายุของบัตร
card_name string ชื่อผู้ถือบัตร
total_price decimal ราคารวม

Response

Header
{
    "Content-Type": "application/json"
}
Body
// Success (status code: 200)
{
    "notify_message": "วันเวลาที่ชำระเงิน 1/3/2020 13:30:00 หมายเลขคำสั่งซื้อ 8004359122 คุณสามารถติดตามสินค้าผ่านช่องทาง Kerry หมายเลข 1785261900"
}
Name Type Description
notify_message string ข้อความแจ้งเตือน