Get order list interface

API Call Address

{域名地址}/api/orders

Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/orders

Calling method

GET

Request parameters

Field name Type Required Description
status string No Order status, default is empty, supported values are: empty, waiting, paid, delivery, finished, refunding
current int No Get specified pagination data, current page number
Page size int No Display quantity, items per page

Return parameters

Field name Type Description
code int error code
msg string error reason description
data object[] result content
Total int Total count

data result item parameters

Field name Type Description
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 Order Original Total Amount
Amount int Order Actual Total Amount
paid_time int Payment Time
End Time int Order Estimated Auto Completion Time
Deliver Time int Shipment Time
Finished Time int Order Completion Time
discount_amount int Discount Amount
seller_id int Seller ID
seller_amount int Seller's Earnings
share_user_id int Promoter ID
share_parent_user_id int Promoter's Superior ID
share_amount int Earnings from promoter
share_parent_amount int Earnings from promoter's superior
express_company string express company
tracking_number string tracking number
user object Buyer User Information
details object[] Order Details Information
Created Time int order timestamp
status int Order status: -1 Cancelled, 0 Pending payment, 1 Paid, 2 Shipped, 3 Completed, 8 Refunding, 9 Refunded
refund_status int refund_status: -1 Refund failed, 0 No refund or in progress, 1 Refunded

Buyer User Information

Field name Type Description
id int User ID
parent_id int Parent 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 a Distributor
balance int user_balance
total_reward int Distributor Cumulative Earnings
invite_code int User Invite Code
Last Login int Last Login Time
expire_time int expiration_time
Created Time int registration_timestamp
updated_time int update timestamp
status int display status

Order Details Information Item

Field name Type Description
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 Product Price
Amount int Actual Total Product Price
Origin Amount int Original Total Product Price
quantity int Product Quantity
status int Status
goods object Product Information

Product Information

Field name Type Description
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 Summary
module_id int Document Model ID
category_id int Document Category ID
Views int Document Views
Comment Count int Document comments count
images string[] Document group image
Logo string Document Logo
Thumb string Document thumbnail
canonical_url string canonical url
fixed_link string document fixed link
Created Time int document publish timestamp
updated_time int Document update timestamp
status int Document display status
user_id int User ID
price int Price, unit in cents
stock int Inventory quantity
user_id int User ID

request data example

Parameter Value
current 1

Return 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": "https://en.anqicms.com/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": "https://en.anqicms.com/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 Description
0 OK
-1 Error, the reason is indicated in the msg
1001 Not logged in
1002 Unauthorized
200 API request OK
AnQiCMS (AnqiCMS)
渝ICP备19130249号 © 2020-2025 Chongqing Souwai Technology Co., Ltd. All Rights Reserved, Created BySecurity Content Management System (AnqiCMS)