号卡订单预效验

POST

/webhook.php

用户下单且商品开启「订单预效验」时，平台在收单之前推送请求，验证通过后才会继续收单。

data 结构等同下单入参，参数含义可参考：https://s.apifox.cn/1cad9662-1cd9-48af-9649-cd23d7c9be7a/api-120422465

触发条件（需同时满足）

后台 WebHook 全局开关开启，且已配置有效 URL 与 Token，号卡订单预效验事件开关开启

商品「自动化扩展 → 订单预效验」开启

请求参数

Header 参数

Body 参数application/json

示例

{
  "event": "order.pre_valid",
  "data": {
    "source": 1,
    "source2": "",
    "certName": "张三",
    "certId": "110101199001011234",
    "contractPhone": "13800138000",
    "address": "北京市朝阳区某某街道1号",
    "orderRemark": "",
    "essProvinceCode": "",
    "essCityCode": "",
    "selectPhone": "",
    "frontImage": "",
    "backImage": "",
    "headImage": "",
    "customImage1": "",
    "province": "110000",
    "city": "110100",
    "county": "110105",
    "street": "",
    "provinceName": "北京市",
    "cityName": "北京市",
    "countyName": "朝阳区",
    "streetName": "",
    "promoCode": "ABC123",
    "goodsId": 1001,
    "specUuid": "",
    "captcha": "",
    "keyNo": "GM202507061430001",
    "customNo": "",
    "callbackUrl": "",
    "adminId": 10,
    "custom3": "",
    "isCutOrder": false,
    "isShift": false,
    "oldGoodsId": 0,
    "rearrangedSelectNumber": false,
    "orderSessionId": "",
    "numberId": 0,
    "form": [],
    "payNum": 1,
    "subject": "",
    "payType": "",
    "returnUrl": "",
    "openid": "",
    "catchUid": "",
    "deliveryAdminId": 0
  }
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'http://test-cn.your-api-server.com/webhook.php' \
--header 'GMY-HOOK-TOKEN: {{token}}' \
--header 'Content-Type: application/json' \
--data '{
  "event": "order.pre_valid",
  "data": {
    "source": 1,
    "source2": "",
    "certName": "张三",
    "certId": "110101199001011234",
    "contractPhone": "13800138000",
    "address": "北京市朝阳区某某街道1号",
    "orderRemark": "",
    "essProvinceCode": "",
    "essCityCode": "",
    "selectPhone": "",
    "frontImage": "",
    "backImage": "",
    "headImage": "",
    "customImage1": "",
    "province": "110000",
    "city": "110100",
    "county": "110105",
    "street": "",
    "provinceName": "北京市",
    "cityName": "北京市",
    "countyName": "朝阳区",
    "streetName": "",
    "promoCode": "ABC123",
    "goodsId": 1001,
    "specUuid": "",
    "captcha": "",
    "keyNo": "GM202507061430001",
    "customNo": "",
    "callbackUrl": "",
    "adminId": 10,
    "custom3": "",
    "isCutOrder": false,
    "isShift": false,
    "oldGoodsId": 0,
    "rearrangedSelectNumber": false,
    "orderSessionId": "",
    "numberId": 0,
    "form": [],
    "payNum": 1,
    "subject": "",
    "payType": "",
    "returnUrl": "",
    "openid": "",
    "catchUid": "",
    "deliveryAdminId": 0
  }
}'

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
  "code": 0,
  "message": "ok",
  "data": null
}

测试事件

号卡订单预效验

触发条件（需同时满足）#

请求参数

请求示例代码

返回响应

触发条件（需同时满足）