Get the order list interface

API call address

{域名地址}/api/orders

illustrate:{域名地址}You need to replace it with your domain address, such as/api/orders

Calling methods

GET

Request parameters

Field name type Required illustrate
status string no The order status is empty by default. The supported values ​​are: empty value, waiting, paid, delivery, finished, refunding
Current int no Get the specified page data, current page number
pageSize int no Display quantity, quantity per page

Return parameters

Field name type illustrate
code int Error code
msg string Error Cause Description
data object[] Results content
Total int total

data result item parameter

Field name type illustrate
id int ID
order_id string Order number
payment_id string Payment ID
user_id int User ID
Remark string Order Notes
type string Order Type
origin_amount int Original total price of order
amount int Actual total price of order
paid_time int Payment time
end_time int The order is expected to be completed automatically
deliver_time int Shipping time
finished_time int Order completion time
discount_amount int Discount amount
seller_id int Seller ID
seller_amount int Seller's profits
share_user_id int Promoter ID
share_parent_user_id int Promoter's superior ID
share_amount int Promoters can get benefits
share_parent_amount share_parent_amount int Promoters can get benefits
express_company string Express delivery company
tracking_number string Express waybill number
user object Buyer user information
details object[] Order details
created_time int Order time stamp
status int Order status: -1 Cancel, 0 To be paid, 1 Payed, 2 Shipped, 3 Completed, 8 Refunds, 9 Refunded
refund_status int Refund status: -1 Refund failed, 0 None or refund is in progress, 1 Refunded

Buyer user information

Field name type illustrate
id int User ID
parent_id int Superior User ID
user_name string username
real_name string Real name
avatar_url string User avatar address
email string email address
Phone string Phone number
group_id int User group ID
is_retailer int Is it a distribution staff or not
balance int User balance
Total_reward int Distributor cumulative income
invite_code int User invitation code
last_login int Last login time
expire_time int Expiration time
created_time int Register time stamp
updated_time int Update time stamp
status int Display status

Order details item

Field name type illustrate
id int ID
order_id string Order number
user_id int User ID
goods_id int Product ID
goods_item_id int Product SKU ID
price int Product price
origin_price int Original price of the product
amount int Actual total price of the product
origin_amount int Original total price of the product
quantity int Quantity of products
status int state
Goods object Product Information

Product Information

Field name type illustrate
id int Document ID
title string Document title
seo_title string Document SEO title
url_token string Document URL alias
keywords string Document keywords
Description string Document Introduction
module_id int Document model ID
category_id int Document Classification ID
views int Document view count
comment_count int Document comments
images string[] Document group photo
logo string Document Logo
thumb string Document thumbnails
canonical_url string canonical url
fixed_link string Document Permalink
created_time int Document release timestamp
updated_time int Document update timestamp
status int Document display status
user_id int User ID
price int Price, unit points
stock int Inventory quantity
user_id int User ID

Request data example

parameter value
Current 1

Return to the data example

{
    "code": 0,
    "data": [
        {
            "id": 46,
            "created_time": 1669212548,
            "updated_time": 1669212548,
            "order_id": "202211232209080046",
            "payment_id": "202211232209080016",
            "user_id": 1000,
            "address_id": 0,
            "remark": "英文外贸响应式通用主题wzl-008等",
            "type": "goods",
            "status": 0,
            "refund_status": 0,
            "origin_amount": 9900,
            "amount": 9900,
            "paid_time": 0,
            "end_time": 0,
            "deliver_time": 0,
            "finished_time": 0,
            "discount_amount": 0,
            "seller_id": 15,
            "seller_amount": 7920,
            "share_user_id": 0,
            "share_parent_user_id": 0,
            "share_amount": 0,
            "share_parent_amount": 0,
            "express_company": "",
            "tracking_number": "",
            "user": {
                "id": 1000,
                "created_time": 1669012062,
                "updated_time": 1679536756,
                "parent_id": 0,
                "user_name": "sinclair",
                "real_name": "",
                "avatar_url": "uploads/202211/21/14f56760596b5328.webp",
                "email": "",
                "phone": "",
                "group_id": 2,
                "status": 1,
                "is_retailer": 0,
                "balance": 0,
                "total_reward": 0,
                "invite_code": "1dzil93",
                "last_login": 1702912236,
                "expire_time": 1997404800,
                "integral": 9968520,
                "ai_remain": 30,
                "extra": null,
                "token": "",
                "group": null,
                "full_avatar_url": "",
                "link": ""
            },
            "is_updated": 0,
            "details": [
                {
                    "id": 16,
                    "created_time": 1669212548,
                    "updated_time": 1669212548,
                    "order_id": "202211232209080046",
                    "user_id": 1000,
                    "goods_id": 188,
                    "goods_item_id": 0,
                    "price": 9900,
                    "origin_price": 9900,
                    "amount": 9900,
                    "origin_amount": 9900,
                    "quantity": 1,
                    "status": 1,
                    "goods": {
                        "id": 188,
                        "created_time": 1669122751,
                        "updated_time": 1669122751,
                        "title": "英文外贸响应式通用主题wzl-008",
                        "seo_title": "",
                        "url_token": "ywwmxystyztw0-7",
                        "keywords": "英文外贸响应式通用主题wzl-008",
                        "description": "英文主题，外贸主题，响应式主题，通用英文企业站主题",
                        "module_id": 3,
                        "category_id": 36,
                        "views": 158,
                        "comment_count": 0,
                        "images": [
                            "https://en.anqicms.com/uploads/202211/22/6315f8a943b979a4.webp",
                            "https://en.anqicms.com/uploads/202211/22/c705ba844eb51aec.webp"
                        ],
                        "template": "",
                        "status": 1,
                        "canonical_url": "",
                        "fixed_link": "",
                        "flag": "",
                        "user_id": 15,
                        "price": 9900,
                        "stock": 9999999,
                        "read_level": 0,
                        "password": "",
                        "sort": 0,
                        "has_pseudo": 0,
                        "keyword_id": 0,
                        "origin_url": "",
                        "origin_title": "",
                        "origin_id": 0,
                        "category": null,
                        "module_name": "",
                        "data": null,
                        "logo": "https://en.anqicms.com/uploads/202211/22/6315f8a943b979a4.webp",
                        "thumb": "https://en.anqicms.com/uploads/202211/22/thumb_6315f8a943b979a4.webp",
                        "extra": null,
                        "link": "/endesign/188.html",
                        "has_ordered": false,
                        "favorable_price": 0,
                        "has_password": false,
                        "category_titles": null,
                        "category_ids": null
                    },
                    "group": null,
                }
            ]
        },
        {
            "id": 45,
            "created_time": 1669211097,
            "updated_time": 1669211131,
            "order_id": "202211232144570045",
            "payment_id": "202211232144570015",
            "user_id": 1000,
            "address_id": 0,
            "remark": "生物科技模板等",
            "type": "goods",
            "status": 3,
            "refund_status": 0,
            "origin_amount": 9900,
            "amount": 9900,
            "paid_time": 1669211131,
            "end_time": 0,
            "deliver_time": 0,
            "finished_time": 1669211131,
            "discount_amount": 0,
            "seller_id": 9,
            "seller_amount": 7920,
            "share_user_id": 0,
            "share_parent_user_id": 0,
            "share_amount": 0,
            "share_parent_amount": 0,
            "express_company": "",
            "tracking_number": "",
            "user": {
                "id": 1000,
                "created_time": 1669012062,
                "updated_time": 1679536756,
                "parent_id": 0,
                "user_name": "sinclair",
                "real_name": "",
                "avatar_url": "uploads/202211/21/14f56760596b5328.webp",
                "email": "",
                "phone": "",
                "group_id": 2,
                "status": 1,
                "is_retailer": 0,
                "balance": 0,
                "total_reward": 0,
                "invite_code": "1dzil93",
                "last_login": 1702912236,
                "expire_time": 1997404800,
                "integral": 9968520,
                "ai_remain": 30,
                "extra": null,
                "token": "",
                "group": null,
                "full_avatar_url": "",
                "link": ""
            },
            "is_updated": 0,
            "details": [
                {
                    "id": 15,
                    "created_time": 1669211097,
                    "updated_time": 1669211097,
                    "order_id": "202211232144570045",
                    "user_id": 1000,
                    "goods_id": 186,
                    "goods_item_id": 0,
                    "price": 9900,
                    "origin_price": 9900,
                    "amount": 9900,
                    "origin_amount": 9900,
                    "quantity": 1,
                    "status": 1,
                    "goods": {
                        "id": 186,
                        "created_time": 1669083705,
                        "updated_time": 1669083705,
                        "title": "生物科技模板",
                        "seo_title": "",
                        "url_token": "swkjmb",
                        "keywords": "生物科技模板",
                        "description": "生物科技主题，外贸主题，响应式主题，通用中英文企业站主题，这个改一下，中英文都可以使用",
                        "module_id": 3,
                        "category_id": 37,
                        "views": 258,
                        "comment_count": 0,
                        "images": [
                            "https://en.anqicms.com/uploads/202211/22/6dddf02aabf8bb8d.webp",
                            "https://en.anqicms.com/uploads/202211/22/3fe32e5fb80d36b1.webp"
                        ],
                        "template": "",
                        "status": 1,
                        "canonical_url": "",
                        "fixed_link": "",
                        "flag": "",
                        "user_id": 9,
                        "price": 9900,
                        "stock": 9999999,
                        "read_level": 0,
                        "password": "",
                        "sort": 0,
                        "has_pseudo": 0,
                        "keyword_id": 0,
                        "origin_url": "",
                        "origin_title": "",
                        "origin_id": 0,
                        "category": null,
                        "module_name": "",
                        "data": null,
                        "logo": "https://en.anqicms.com/uploads/202211/22/6dddf02aabf8bb8d.webp",
                        "thumb": "https://en.anqicms.com/uploads/202211/22/thumb_6dddf02aabf8bb8d.webp",
                        "extra": null,
                        "link": "/zhdesign/186.html",
                        "has_ordered": false,
                        "favorable_price": 0,
                        "has_password": false,
                        "category_titles": null,
                        "category_ids": null
                    },
                    "group": null
                }
            ]
        }
    ],
    "msg": "",
    "total": 2
}

Error code

Error code illustrate
0 OK
-1 Error, the cause of the error is pointed out in msg
1001 Not logged in
1002 Unauthorized
200 API request OK
AnqiCMS (AnqiCMS)
Chongqing ICP No. 19130249 © 2020-2025 Chongqing Souwai Technology Co., Ltd. All Rights Reserved, Created ByAnqiCMS