skip to content W3C SVG

list order: 獲取 訂單 資料 12-13 15:16

list order: 獲取 訂單 資料

更新時間：2022-12-13 15:16:10

HTTP Request

POST: manager/order/list

Body Parameters

Parameter Type Status Description
langCode string optional 語言, langCode=zhGB / zhHK / zhCN
limit int optional 最大數量
page int optional 第幾頁
order object optional 排序, 目前只支援單一column排序
    name string required column name
    direction string required asc / desc
    natural boolean required 開啟自然排序
filters object required

Response Structure

Parameter Type Status Description
status int required 0: 成功, 非0: 失敗
data object optional
    data object[] optional
        id int required orders.id
        order_state int required orders.order_state_id
        total int required orders.total
        user user required users.id
        user_name user required users.name
        user_email user required users.email
        user_first_name user required users.first_name
        user_last_name user required users.last_name
        items item[] required
            item int required items.id
            quantity int required items.quantity
            price float required items.price
            total float required items.total
            item_name string required items.name
            item_title_enHK string required items.title_enHK
            item_title_zhHK string required items.title_zhHK
            item_title_zhCN string required items.title_zhCN
            item_description_enHK string required items.description_enHK
            item_description_zhHK string required items.description_zhHK
            item_description_zhCN string required items.description_zhCN
        action object required 應用於RJCMS上
            props object required
                id int optional orders.id
    limit int required 最大顯示數量
    page int required 當前頁數
    maxPage int required 最大頁數
    total int required 總數
    order object required 排序
        name string required column name
        direction string required ASC / DESC
    filters object required

Example usage

Example #1

POST: manager/order/list

Body

{
    "limit": 2,
    "page": 1
}

Response(200,status=0)

{
    "status": 0,
    "data": {
        "data": [
            {
                "id": 1,
                "order_state": 2,
                "action": {
                    "props": {
                        "id": 1
                    }
                },
                "total": 300,
                "user": 0,
                "user_name": null,
                "user_email": null,
                "user_tel": null,
                "user_first_name": null,
                "user_last_name": null,
                "items": [
                    {
                        "quantity": 1,
                        "price": 100,
                        "total": 100,
                        "item": 1,
                        "item_name": "new item",
                        "item_title_enHK": "new item zhCN",
                        "item_description_enHK": "add item description zhHK",
                        "item_description_zhCN": "add item description zhCN"
                    },
                    {
                        "quantity": 2,
                        "price": 100,
                        "total": 200,
                        "item": 2,
                        "item_name": "bb",
                        "item_title_enHK": "bb",
                        "item_description_enHK": "bb",
                        "item_description_zhCN": "bb"
                    }
                ]
            },
            {
                "id": 2,
                "order_state": 1,
                "action": {
                    "props": {
                        "id": 2
                    }
                },
                "total": 300,
                "user": 0,
                "user_name": null,
                "user_email": null,
                "user_tel": null,
                "user_first_name": null,
                "user_last_name": null,
                "items": [
                    {
                        "quantity": 1,
                        "price": 100,
                        "total": 100,
                        "item": 1,
                        "item_name": "new item",
                        "item_title_enHK": "new item zhCN",
                        "item_description_enHK": "add item description zhHK",
                        "item_description_zhCN": "add item description zhCN"
                    },
                    {
                        "quantity": 2,
                        "price": 100,
                        "total": 200,
                        "item": 2,
                        "item_name": "bb",
                        "item_title_enHK": "bb",
                        "item_description_enHK": "bb",
                        "item_description_zhCN": "bb"
                    }
                ]
            },
            {
                "id": 3,
                "order_state": 1,
                "action": {
                    "props": {
                        "id": 3
                    }
                },
                "total": 300,
                "user": 0,
                "user_name": null,
                "user_email": null,
                "user_tel": null,
                "user_first_name": null,
                "user_last_name": null,
                "items": [
                    {
                        "quantity": 1,
                        "price": 100,
                        "total": 100,
                        "item": 1,
                        "item_name": "new item",
                        "item_title_enHK": "new item zhCN",
                        "item_description_enHK": "add item description zhHK",
                        "item_description_zhCN": "add item description zhCN"
                    },
                    {
                        "quantity": 2,
                        "price": 100,
                        "total": 200,
                        "item": 2,
                        "item_name": "bb",
                        "item_title_enHK": "bb",
                        "item_description_enHK": "bb",
                        "item_description_zhCN": "bb"
                    }
                ]
            },
            {
                "id": 4,
                "order_state": 1,
                "action": {
                    "props": {
                        "id": 4
                    }
                },
                "total": 300,
                "user": 0,
                "user_name": null,
                "user_email": null,
                "user_tel": null,
                "user_first_name": null,
                "user_last_name": null,
                "items": [
                    {
                        "quantity": 1,
                        "price": 100,
                        "total": 100,
                        "item": 1,
                        "item_name": "new item",
                        "item_title_enHK": "new item zhCN",
                        "item_description_enHK": "add item description zhHK",
                        "item_description_zhCN": "add item description zhCN"
                    },
                    {
                        "quantity": 2,
                        "price": 100,
                        "total": 200,
                        "item": 2,
                        "item_name": "bb",
                        "item_title_enHK": "bb",
                        "item_description_enHK": "bb",
                        "item_description_zhCN": "bb"
                    }
                ]
            },
            {
                "id": 5,
                "order_state": 1,
                "action": {
                    "props": {
                        "id": 5
                    }
                },
                "total": 300,
                "user": 0,
                "user_name": null,
                "user_email": null,
                "user_tel": null,
                "user_first_name": null,
                "user_last_name": null,
                "items": [
                    {
                        "quantity": 1,
                        "price": 100,
                        "total": 100,
                        "item": 1,
                        "item_name": "new item",
                        "item_title_enHK": "new item zhCN",
                        "item_description_enHK": "add item description zhHK",
                        "item_description_zhCN": "add item description zhCN"
                    },
                    {
                        "quantity": 2,
                        "price": 100,
                        "total": 200,
                        "item": 2,
                        "item_name": "bb",
                        "item_title_enHK": "bb",
                        "item_description_enHK": "bb",
                        "item_description_zhCN": "bb"
                    }
                ]
            }
        ],
        "page": 1,
        "filters": [],
        "limit": 5,
        "order": {
            "name": "id",
            "direction": "asc"
        },
        "maxPage": 2,
        "total": 10
    }
}