Order Details Retrieval Interface

Get detailed information of a specified order, including order status, product information, shipping address, and complete order data.

Points to note

  • The interface uses the GET method and does not require the submission of request body data
  • Access requires user login
  • Can only retrieve order details belonging to the current user
  • Return complete order information, product details, and shipping address information

Request address

{域名地址}/api/order/detail

Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/order/detail

Request Syntax

GET {域名地址}/api/order/detail

Request Headers

This interface also involves common request headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Request parameters

Field name Type Required Description
order_id string Is Order ID

Response header

This interface only involves public response headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

Field name Type Description
code int Error code
msg string Error description
data object Order details data

Data result parameter

Field name Type Description
id int Order ID
order_id string Order Number
payment_id string Payment流水ID
user_id int User ID
remark string Order remarks
type string Order Type
original amount int Order Original Total Price
amount int Total Actual Order Amount
Paid Time int Payment Time
End Time int Estimated Auto Completion Time
deliver_time int Delivery 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 Promoter's earnings
share_parent_amount int incomes_of_promoter_s_upline
express_company string express_company
tracking number string express delivery waybill number
details object[] Order details information
created_time int order timestamp
updated_time int update 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
order_address object order delivery address

order_address parameter

Field name Type Description
id int Address ID
name string Recipient
phone string Contact phone number
Province string Province
City string City
Country string district
address information string detailed address
postal code string postcode

Details item parameters

Field name Type Description
id int order detail 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
original amount int Original Total Product Price
quantity int Product Quantity
status int Status
goods object product information

goods parameters

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 keyword
description string Document Introduction
module_id int Document Model ID
category_id int Document Category ID
Views int Document Views
Comment Count int Document Comment Volume
Images string array document group chart
Logo string Document Logo
thumbnail 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, in cents
stock int inventory quantity

Usage Example

Request example

GET /api/order/detail?order_id=202211232209080046 HTTP/1.1
Host: www.anqicms.com
Content-Type: application/json

Response Example

{
  "code": 0,
  "msg": "",
  "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": "",
    "order_address": {
      "id": 1,
      "created_time": 1669212548,
      "updated_time": 1669212548,
      "user_id": 1000,
      "name": "王先生",
      "phone": "13888888888",
      "province": "河南省",
      "city": "郑州市",
      "country": "中原区",
      "address_info": "中原西路233号",
      "postcode": "450000",
      "status": 1
    },
    "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
      }
    ]
  }
}

error code

Error code Description
0 OK
-1 Error, the reason is indicated in msg
1001 Not logged in
1002 Not authorized
200 API request OK
So Outside Technology Security CMS
Privacy Terms 粤ICP备2024356999号 © 2020-2026 Shenzhen Souwai Technology Co., Ltd. All Rights Reserved, Created ByAnQi Content Management System (AnqiCMS)