v2.discount.get_discount_list
GET /api/v2/discount/get_discount_list
Sử dụng API này để lấy danh sách chương trình giảm giá của cửa hàng
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/discount/get_discount_list
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dấu thời gian của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token để truy cập API, dùng để xác định quyền của bạn với API. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo bởi partner_id, đường dẫn API, timestamp, access_token, shop_id và partner_key thông qua thuật toán băm HMAC-SHA256. Chi tiết hơn: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| discount_status | string | True | ongoing | Bộ lọc trạng thái để truy xuất danh sách giảm giá. Giá trị có thể dùng: upcoming/ongoing/expired/all. |
| page_no | int | True | 1 | Chỉ định số trang dữ liệu cần trả về trong lần gọi hiện tại. Bắt đầu từ 1. Nếu dữ liệu nhiều hơn một trang, page_no có thể dùng làm điểm bắt đầu cho lần gọi tiếp theo. |
| page_size | int | True | 100 | Nếu có nhiều sản phẩm cần truy xuất, bạn có thể cần gọi GetDiscountsList nhiều lần. Mỗi kết quả được trả về theo từng trang. Dùng bộ lọc Phân trang để kiểm soát số mục tối đa (<= 100) trả về mỗi trang và số offset để bắt đầu lần gọi tiếp theo. |
| update_time_from | timestamp | False | 1643860467 | Các trường update_time_from và update_time_to chỉ định khoảng ngày để truy xuất đơn hàng (dựa trên thời gian cập nhật giảm giá). Khoảng ngày tối đa là 30 ngày. |
| update_time_to | timestamp | False | 1646020467 | Các trường update_time_from và update_time_to chỉ định khoảng ngày để truy xuất đơn hàng (dựa trên thời gian cập nhật giảm giá). Khoảng ngày tối đa là 30 ngày. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Loại lỗi nếu có lỗi xảy ra. Rỗng nếu không có lỗi. | |
| message | string | Chi tiết lỗi nếu có lỗi xảy ra. Rỗng nếu không có lỗi. | |
| request_id | string | da6b348a4a5e4162b885ecc73c85297f | Định danh của yêu cầu API để theo dõi lỗi. |
| response | object | Thông tin chi tiết bạn đang truy vấn. | |
| discount_list | object[] | Các chương trình giảm giá được tạo trong cửa hàng này. | |
| status | string | ongoing | Trạng thái của chương trình giảm giá. |
| discount_name | string | testqwert001 | Tiêu đề của chương trình giảm giá. |
| start_time | timestamp | 1644910200 | Thời gian bắt đầu chương trình giảm giá. |
| end_time | timestamp | 1645864200 | Thời gian kết thúc chương trình giảm giá. |
| discount_id | int | 665270257590299 | Định danh duy nhất của Shopee cho một chương trình giảm giá. |
| source | int | 0 | Nguồn gốc của chương trình giảm giá. 7: livestream, 1: admin, 0: khác |
| more | boolean | false | Cho biết danh sách sản phẩm có nhiều hơn một trang hay không. Nếu giá trị này là true, bạn có thể tiếp tục kiểm tra trang tiếp theo để lấy các sản phẩm còn lại. |