查询订单(API v1)
api_ts 与历史别名 ts 二选一;实际传入的字段参与 v1
全参数签名。请求输入和空值处理遵循 v1 兼容规则。
GET
/orders/{order_code}deprecatedPath parameters
order_codestringrequiredmin length 3 · max length 40
Query parameters
api_keystringrequiredapi_tsstring与 `ts` 二选一,必须按 string 参与对应版本签名。
tsstring`api_ts` 的历史别名;与 `api_ts` 二选一。
api_sigstringrequiredmatches ^[a-f0-9]{64}$
Responses
200成功或 v1 业务错误;找不到订单时 `error_code=121`。
error_codeintegerrequiredAllowed:
01251525354565758596162717281121151152153error_msgstringrequiredorderOrderShow propertiesHide properties
idstringrequireddatestringrequiredhourstringrequiredstatusstringrequiredstore_idstringrequiredplansOrderService[]requiredShow propertiesHide properties
Array of
OrderServiceidstringrequirednamestringrequiredpricestring | numberrequiredShow propertiesHide properties
One of:
string
stringnumber
numbernumberintegerrequiredcreated_atstringrequiredcoupon_codestringrequiredtotal_pricestring | numberrequiredShow propertiesHide properties
One of:
string
stringnumber
numberprepayPrepaymentrequiredShow propertiesHide properties
amountstringrequiredmethodstringrequiredremarkstringrequiredcontactCustomerContactrequiredShow propertiesHide properties
namestringrequiredemailstringrequiredarea_codestringrequiredmobilestringrequiredkidChildShow propertiesHide properties
namestringrequiredgenderstringrequiredbirthdaystringrequiredagestringrequiredcustomer_remarkstringteam_remarkstringauto_login_urlstring<uri>长期有效的顾客免登录链接,属于敏感凭据。不得记录到日志、转发给无关系统或用于新功能。
customerCustomerShow propertiesHide properties
idstringrequiredstore_idstringrequirednamestringrequiredarea_codestringrequiredmobilestringrequiredemailstringrequiredgenderstringrequiredorder_idsstring[]required429已超过 v1 的 20 requests/min/key 配额;服务端返回标准 HTTP 429。
Request
curl -X GET "https://api.darkroom.net/v1/orders/string?api_key=string&api_sig=string"const response = await fetch("https://api.darkroom.net/v1/orders/string?api_key=string&api_sig=string", {
method: "GET"
});import requests
response = requests.get(
"https://api.darkroom.net/v1/orders/string?api_key=string&api_sig=string",
)Response
{
"error_code": 0,
"error_msg": "string",
"order": {
"id": "string",
"date": "string",
"hour": "string",
"status": "string",
"store_id": "string",
"plans": [
{
"id": "string",
"name": "string",
"price": "string",
"number": 0
}
],
"created_at": "string",
"coupon_code": "string",
"total_price": "string",
"prepay": {
"amount": "string",
"method": "string",
"remark": "string"
},
"contact": {
"name": "string",
"email": "string",
"area_code": "string",
"mobile": "string"
},
"kid": {
"name": "string",
"gender": "string",
"birthday": "string",
"age": "string"
},
"customer_remark": "string",
"team_remark": "string",
"auto_login_url": "<uri>"
},
"customer": {
"id": "string",
"store_id": "string",
"name": "string",
"area_code": "string",
"mobile": "string",
"email": "string",
"gender": "string",
"order_ids": [
"string"
]
}
}已超过 v1 的 20 requests/min/key 配额;服务端返回标准 HTTP 429。
