语言
EN繁简

文档导航

概览认证与签名Endpoint活动列表创建订单封存订单QR Code 解析验证订单核销订单测试流程

封存订单

此页展示签名接口的 request 与 response 结构，供日后让商户把不再需要出现在日常操作流程中的历史订单作封存。

POST/api/integrations/merchant/orders/archive

商户封存订单接口的结构。

Request 字段

字段
类型
必填
说明
orderId
string
是
要封存的订单 Id。
reason
string
否
可选的封存原因，供 audit 使用。

Response 字段

字段
类型
说明
code
number
返回代码。
success
boolean
封存成功时会出现。
message
string
可读消息。

返回代码

为了让商户文档及收银员界面更简单，Yuter 将此集成返回统一成四个顶层代码。

代码
含义
备注
1
成功
订单验证成功或已成功核销。
2
已核销
此订单在本次请求前已完成核销。
3
无效订单
booking id 无效，或找不到相关订单。
4
其他错误
认证失败、不可核销、商户无权限，或其他受控错误。

封存订单 cURL

封存订单 endpoint 的 request 与 response。

cURL 示例

API_KEY='<raw merchant api key>'
TIMESTAMP=$(($(date +%s) * 1000))
NONCE=$(uuidgen)
BODY='{"orderId":"69ce982e96a5b33a356ac111","reason":"merchant_closed_case"}'
PATH='/api/integrations/merchant/orders/archive'
PAYLOAD="POST
$PATH
$TIMESTAMP
$NONCE
$BODY"
SIGNATURE=$(printf "%s" "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_KEY" -hex | sed 's/^.* //')

curl -X POST "https://www.yuterwellness.com$PATH" \
  -H "Content-Type: application/json" \
  -H "x-api-key: $API_KEY" \
  -H "x-timestamp: $TIMESTAMP" \
  -H "x-nonce: $NONCE" \
  -H "x-signature: $SIGNATURE" \
  -d "$BODY"

响应示例

{
  "code": 1,
  "success": true,
  "message": "Order archived successfully"
}