跳到内容
API 文档
Esc
切换打开⌘J预览

查询订单(API v1)

api_ts 与历史别名 ts 二选一;实际传入的字段参与 v1 全参数签名。请求输入和空值处理遵循 v1 兼容规则。

GET/orders/{order_code}deprecated
Path parameters
order_codestringrequired
min length 3 · max length 40
Query parameters
api_keystringrequired
api_tsstring
与 `ts` 二选一,必须按 string 参与对应版本签名。
tsstring
`api_ts` 的历史别名;与 `api_ts` 二选一。
api_sigstringrequired
matches ^[a-f0-9]{64}$
Responses
200成功或 v1 业务错误;找不到订单时 `error_code=121`。
error_codeintegerrequired
Allowed:01251525354565758596162717281121151152153
error_msgstringrequired
orderOrder
Show properties
idstringrequired
datestringrequired
hourstringrequired
statusstringrequired
store_idstringrequired
plansOrderService[]required
Show properties
Array of OrderService
idstringrequired
namestringrequired
pricestring | numberrequired
Show properties
One of:
string
string
number
number
numberintegerrequired
created_atstringrequired
coupon_codestringrequired
total_pricestring | numberrequired
Show properties
One of:
string
string
number
number
prepayPrepaymentrequired
Show properties
amountstringrequired
methodstringrequired
remarkstringrequired
contactCustomerContactrequired
Show properties
namestringrequired
emailstringrequired
area_codestringrequired
mobilestringrequired
kidChild
Show properties
namestringrequired
genderstringrequired
birthdaystringrequired
agestringrequired
customer_remarkstring
team_remarkstring
auto_login_urlstring<uri>
长期有效的顾客免登录链接,属于敏感凭据。不得记录到日志、转发给无关系统或用于新功能。
customerCustomer
Show properties
idstringrequired
store_idstringrequired
namestringrequired
area_codestringrequired
mobilestringrequired
emailstringrequired
genderstringrequired
order_idsstring[]required
429已超过 v1 的 20 requests/min/key 配额;服务端返回标准 HTTP 429。
Request
curl -X 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"
    ]
  }
}