orders-list

เอกสารถูกนำเข้าจากไฟล์ Postman collection อัตโนมัติ

ใช้สำหรับดึงรายการคำสั่งซื้อของร้านค้า โดยรองรับ Pagination และการกรองตามสถานะคำสั่งซื้อ วันที่สร้าง และวันที่อัปเดตคำสั่งซื้อ

Request

Method: GET
URL: {{api_url}}/v1/orders/get_list
View common parameters

Query params

Properties	Type	Required	Description
app_key	string	Yes	Partner application key
app_secret	string	Yes	Partner application secret
shop_id	string	Yes	Shop ID
access_token	string	Yes	Partner access token
page	integer	No	หน้าที่ต้องการดึงข้อมูล ค่าเริ่มต้นคือ `1`
page_size	integer	No	จำนวนรายการต่อหน้า ค่าเริ่มต้นคือ `25` รองรับตั้งแต่ `1` ถึง `100`
order_status	string / array	No	กรองตามสถานะคำสั่งซื้อ สามารถระบุสถานะเดียวหรือหลายสถานะได้
created_date_from	string	No	วันที่เริ่มต้นของวันที่สร้างคำสั่งซื้อ รูปแบบ `YYYY-MM-DD`
created_date_to	string	No	วันที่สิ้นสุดของวันที่สร้างคำสั่งซื้อ รูปแบบ `YYYY-MM-DD`
updated_date_from	string	No	วันที่เริ่มต้นของวันที่แก้ไขคำสั่งซื้อล่าสุด รูปแบบ `YYYY-MM-DD`
updated_date_to	string	No	วันที่สิ้นสุดของวันที่แก้ไขคำสั่งซื้อล่าสุด รูปแบบ `YYYY-MM-DD`

Supported order statuses

order_status รองรับสถานะดังต่อไปนี้:

Status	Description
`PENDING_PAYMENT`	รอการชำระเงิน
`ITEMS_TO_PACK`	สินค้าที่ต้องบรรจุ
`READY_TO_SHIP`	ที่ต้องจัดส่ง
`WAITING_COURIER_PICKUP`	รอรถเข้ารับ
`SHIPPED`	ระหว่างจัดส่ง
`DELIVERED`	ส่งแล้ว
`ORDER_CANCELLED`	คำสั่งซื้อถูกยกเลิก
`ITEM_RETURNED`	สินค้าถูกคืน
`DELIVERY_FAILED`	จัดส่งไม่สำเร็จ
`PACKAGE_LOST_OR_DAMAGED`	พัสดุสูญหายและเสียหาย
`PAYMENT_FAILED`	การชำระเงินล้มเหลว
`PAYMENT_VERIFICATION`	รอการตรวจสอบการชำระเงิน
`RETURN_REQUEST`	ขอคืนสินค้า

สามารถระบุได้มากกว่า 1 สถานะ เช่น:

หากระบุสถานะที่ไม่รองรับ API จะคืน HTTP Status 422

หมายเหตุ: ค่า order_status ที่ปรากฏในข้อมูลคำสั่งซื้อบางรายการอาจมีสถานะอื่นจาก workflow ภายในหรือข้อมูลเดิมของระบบ แม้ว่าสถานะดังกล่าวจะไม่สามารถใช้เป็นค่า filter ผ่าน order_status ได้

Filter behavior

Order status

สามารถกรองสถานะเดียวได้ด้วย:

หากต้องการหลายสถานะ สามารถส่ง parameter แบบ array ได้:

ระบบจะคืนคำสั่งซื้อที่ตรงกับสถานะใดสถานะหนึ่งที่ระบุ

หากส่ง order_status ที่ไม่มีอยู่ในระบบ API จะคืน HTTP Status 422

Created date

สามารถกรองคำสั่งซื้อตามวันที่สร้างได้ เช่น:

created_date_from จะนับตั้งแต่เวลา 00:00:00 ของวันที่ระบุ และ created_date_to จะนับถึงเวลา 23:59:59 ของวันที่ระบุ

Updated date

สามารถกรองคำสั่งซื้อที่มีการอัปเดตภายในช่วงวันที่ได้ เช่น:

เหมาะสำหรับ Partner ที่ต้องการ Sync รายการคำสั่งซื้อที่มีการเปลี่ยนแปลง เช่น การเปลี่ยนสถานะคำสั่งซื้อหรือข้อมูลจัดส่ง

updated_date_from จะนับตั้งแต่เวลา 00:00:00 ของวันที่ระบุ และ updated_date_to จะนับถึงเวลา 23:59:59 ของวันที่ระบุ

หากวันที่เริ่มต้นมากกว่าวันที่สิ้นสุด API จะคืน HTTP Status 422

Request example

Example response

Status: 200

Response fields

Properties	Type	Description
status	boolean	สถานะการทำงานของ API
code	string	Response code
message	string	รายละเอียดผลลัพธ์
data.current_page	integer	หน้าปัจจุบัน
data.items	array	รายการคำสั่งซื้อ
data.items[].order_id	integer	Internal order ID
data.items[].order_number	string	หมายเลขคำสั่งซื้อ
data.items[].order_status	string / null	รหัสสถานะคำสั่งซื้อ
data.total_count	integer	จำนวนรายการทั้งหมดที่ตรงกับเงื่อนไข
data.has_next_page	boolean	ระบุว่ายังมีหน้าถัดไปหรือไม่
request_id	string	Request reference ID สำหรับใช้ตรวจสอบ Log หรือแจ้งปัญหา

Error response

Invalid date range

Status: 422

Invalid order status