Get detailed information of a specified order, including order status, product information, shipping address, and complete order data.
Precautions
- This 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
- Returns complete order information, product details, and shipping address information
Request address
{域名地址}/api/order/detail
Description:{域名地址}Need to replace it with your domain address, such ashttps://en.anqicms.com/api/order/detail
Request syntax
GET {域名地址}/api/order/detail
Request header
This interface also involves common request headers. For more information, please seeCommon Request Headers (Common Request Headers).
Request Parameters
| Field Name |
Type |
Required |
Description |
| order_id |
string |
Yes |
Order ID |
Response Headers
This interface only involves public response headers. More information, please refer toCommon Request Headers (Common Request Headers).
Return parameters
| Field Name |
Type |
Description |
| code |
integer |
Error code |
| message |
string |
Error Description |
| data |
object |
Order details data |
Data result parameters
| Field Name |
Type |
Description |
| id |
integer |
Order ID |
| order_id |
string |
Order Number |
| payment_id |
string |
Payment Transaction ID |
| user_id |
integer |
User ID |
| remark |
string |
Order notes |
| type |
string |
Order Type |
| origin_amount |
integer |
Order Original Total Amount |
| amount |
integer |
Order Actual Total Amount |
| paid_time |
integer |
Payment Time |
| End Time |
integer |
Expected Order Auto Completion Time |
| Delivery Time |
integer |
Shipping Time |
| finished_time |
integer |
Order completion time |
| Discount amount |
integer |
Discount amount |
| Seller ID |
integer |
seller ID |
| seller amount |
integer |
seller's profit |
| share user ID |
integer |
promoter ID |
| share_parent_user_id |
integer |
Promoter's Superior ID |
| share_amount |
integer |
Promoter's Earnings |
| share_parent_amount |
integer |
Promoter's superior income |
| express_company |
string |
Courier company |
| tracking_number |
string |
Express delivery tracking number |
| details |
object[] |
Order details information |
| created_time |
integer |
Order timestamp |
| updated_time |
integer |
update timestamp |
| status |
integer |
Order status: -1 Cancelled, 0 Pending payment, 1 Paid, 2 Shipped, 3 Completed, 8 Refunding, 9 Refunded |
| Refund status |
integer |
Refund status: -1 Refund failed, 0 None or in progress, 1 Refunded |
| order_address |
object |
order shipping address |
order_address parameter
| Field Name |
Type |
Description |
| id |
integer |
Address ID |
| name |
string |
Recipient |
| phone |
string |
Phone Number |
| province |
string |
province |
| city |
string |
City |
| Country |
string |
District |
| Address Information |
string |
Detailed Address |
| postcode |
string |
Postal Code |
details item parameters
| Field Name |
Type |
Description |
| id |
integer |
Order detail ID |
| order_id |
string |
Order Number |
| user_id |
integer |
User ID |
| goods_id |
integer |
Product ID |
| goods_item_id |
integer |
Product SKU ID |
| Price |
integer |
product price |
| Original Price |
integer |
original product price |
| amount |
integer |
Product Actual Total Price |
| origin_amount |
integer |
Product Original Total Price |
| quantity |
integer |
quantity of goods |
| status |
integer |
Status |
| Goods |
object |
Product Information |
Goods Parameters
| Field Name |
Type |
Description |
| id |
integer |
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 |
integer |
Document Model ID |
| category_id |
integer |
Document Category ID |
| views |
integer |
Document views |
| comment_count |
integer |
Document comments |
| images |
string array |
Document Group Image |
| Logo |
string |
Document Logo |
| Thumbnail |
string |
Document Thumbnail |
| Canonical URL |
string |
Canonical URL |
| fixed_link |
string |
Document Fixed Link |
| created_time |
integer |
Document Publish Timestamp |
| updated_time |
integer |
Document Update Timestamp |
| status |
integer |
Document Display Status |
| user_id |
integer |
User ID |
| Price |
integer |
Price, in cents |
| Stock |
integer |
Stock Quantity |
Example Usage
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 |
Unauthorized |
| 200 |
API request OK |