OMSOrder Promotion
Danh sách Order Promotion
Trả về danh sách khuyến mãi đã áp dụng trên đơn hàng, hỗ trợ phân trang và nhiều bộ lọc.
Endpoint
GET /v1/orderpromotions
Headers
| Tên | Bắt buộc | Mô tả |
|---|---|---|
Authorization | Có | <JWT> của người dùng có quyền xem đơn hàng (order.view) |
Query Parameters
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | int | Có | ID công ty (tenant), phải trùng với công ty của phiên đăng nhập |
page | int | Trang hiện tại (mặc định 1) | |
limit | int | Số bản ghi mỗi trang (mặc định và tối đa 50) | |
sort_by | string | Sắp xếp theo: id, date_created, date_modified, ymd. Mặc định: id | |
sort_type | string | Kiểu sắp xếp: ASC, DESC. Mặc định: DESC | |
id | int | Lọc theo ID order promotion | |
status | int | Lọc theo trạng thái (1: Hoạt động, 3: Vô hiệu hóa) | |
date_started | int | Thời gian tạo từ (UNIX timestamp) | |
date_ended | int | Thời gian tạo đến (UNIX timestamp) | |
sale_order_id | int | Lọc theo ID đơn hàng | |
customer_id | int | Lọc theo ID khách hàng | |
product_id | int | Lọc theo ID sản phẩm | |
product_variant_id | int | Lọc theo ID biến thể sản phẩm | |
ymd | int | Lọc theo ngày (định dạng YYYYMMDD) | |
promotion_id | int | Lọc theo ID chương trình khuyến mãi | |
promotion_type | int | Lọc theo loại khuyến mãi | |
promotion_scope | int | Lọc theo phạm vi khuyến mãi | |
coupon_code | string | Lọc theo mã coupon |
Response Schema
HTTP 200 - JSON Object
{
"total": 150,
"currentpage": 1,
"limit": 50,
"items": [
{
"id": 5001,
"company_id": 10311,
"sale_order_id": 10002414,
"promotion_id": 200,
"discount_amount": 98180,
"status": 1,
"...": "..."
}
]
}Mỗi item trong mảng items là một đối tượng Order Promotion Object, bao gồm các enriched fields (promotion, customer, customer_name, customer_phone).
Error Codes
| HTTP | Code | Mô tả |
|---|---|---|
| 401 | error_jwt_is_required | Thiếu token xác thực |
| 403 | error_role_not_available | Không có quyền order.view |