{ "openapi": "3.1.0", "info": { "title": "易数链动开放平台", "version": "1.0.0" }, "paths": { "/api/v1/open/invoke": { "post": { "operationId": "invokeExternal", "summary": "商户统一对外调用", "description": "仅接受应用 HMAC；仍需有效 API 授权。返回的 mock 标志及订单状态须分别判断。", "security": [ { "X-App-Id": [], "X-Access-Key": [], "X-Key-Id": [], "X-Timestamp": [], "X-Nonce": [], "X-Content-SHA256": [], "X-Signature": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" }, "example": { "version": "1.0", "operation": "hotel.prices", "params": { "hotelId": "66783", "checkInDate": "2026-11-10", "checkOutDate": "2026-11-11" } } } } }, "responses": { "200": { "description": "调用成功；订单最终状态仍以 data.state 为准", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "201": { "description": "调用成功；订单最终状态仍以 data.state 为准", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "202": { "description": "结果尚未确认；保留原订单号/幂等键查询", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "400": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "401": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "403": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "404": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "405": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "409": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "413": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "415": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "422": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "429": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "500": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "502": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "503": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "504": { "description": "统一错误响应", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } } } } } }, "components": { "securitySchemes": { "X-App-Id": { "type": "apiKey", "in": "header", "name": "X-App-Id" }, "X-Access-Key": { "type": "apiKey", "in": "header", "name": "X-Access-Key" }, "X-Key-Id": { "type": "apiKey", "in": "header", "name": "X-Key-Id" }, "X-Timestamp": { "type": "apiKey", "in": "header", "name": "X-Timestamp" }, "X-Nonce": { "type": "apiKey", "in": "header", "name": "X-Nonce" }, "X-Content-SHA256": { "type": "apiKey", "in": "header", "name": "X-Content-SHA256" }, "X-Signature": { "type": "apiKey", "in": "header", "name": "X-Signature" } }, "schemas": { "Request": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "beidou.orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "mobile", "price", "payType", "clientIp", "wapUrl" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "mobile": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "price": { "description": "面值字符串，需先查询可售商品", "type": [ "string", "number" ] }, "payType": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "clientIp": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "wapUrl": { "description": "已报备的 HTTPS 商户回跳地址", "type": [ "string", "number" ] }, "outUserId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productName": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "beidou.orders.page" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": { "pageNumber": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "pageSize": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "mobile": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "payType": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "payStatus": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "beidou.orders.status" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "number" ], "properties": { "number": { "description": "本应用原商户订单号；使用字符串", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "beidou.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.capabilities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.cities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.city-code" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "longitude", "latitude" ], "properties": { "longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.estimate" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "from_longitude", "from_latitude", "to_longitude", "to_latitude", "car_type", "city_code", "order_type" ], "properties": { "from_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "from_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "car_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_tags": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carpool_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "count_person": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "waypointList": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "route_strategy": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.complaintOrder" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "content", "merchantOrderId", "idempotencyKey" ], "properties": { "content": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.confirmReceiveOrder" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "confirm_receive_time", "merchantOrderId", "idempotencyKey" ], "properties": { "confirm_receive_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "caller_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_hide_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.evaluateOrder" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "score", "merchantOrderId", "idempotencyKey" ], "properties": { "score": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "content": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.getDriverVirtualPhone" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.midChooseRoute" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "a_map_route_id", "merchantOrderId", "idempotencyKey" ], "properties": { "a_map_route_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.modifyBookingOrder" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "modify_reason", "merchantOrderId", "idempotencyKey" ], "properties": { "modify_reason": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "new_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "new_use_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.modifyEndLocation" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "end_location", "merchantOrderId", "idempotencyKey" ], "properties": { "end_location": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lg": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lt": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "waypointList": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.modifyEndLocationV2" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "modify", "end_location", "lg", "lt", "merchantOrderId", "idempotencyKey" ], "properties": { "modify": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_location": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lg": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lt": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "waypointList": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.modifyStartLocation" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "lg", "lt", "merchantOrderId", "idempotencyKey" ], "properties": { "lg": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lt": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "uid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_location": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_district": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_district_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_poiId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryAlternativeRoute" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryCalculateBill" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryCancelFeeRule" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryDriverPolyline" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "navigation_polyline_type", "merchantOrderId" ], "properties": { "navigation_polyline_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryDriverPolylineV2" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryEstimateRoute" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryJourneyShareInfo" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryMeterRule" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "car_type", "city_code", "order_type" ], "properties": { "car_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryMeterRuleV2" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "car_type", "city_code", "order_type" ], "properties": { "car_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "company_no": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryMidPoints" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryNearByDriver" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "city_code", "radius", "order_longitude", "order_latitude" ], "properties": { "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "radius": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.extended.queryPickupSpots" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "required": [ "longitude", "latitude", "city_code" ], "properties": { "longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.bill" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "cancel_code", "cancel_reason" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "cancel_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cancel_reason": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "who_cancel": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.cancel-fee" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.confirm-fee" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "allowance_amount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cao_allowance_amount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "from_longitude", "from_latitude", "car_type", "caller_phone", "estimate_price", "estimate_price_key", "city_code", "order_type", "start_name", "start_address", "end_name", "end_address", "merchantOrderId" ], "properties": { "from_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "from_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "car_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "caller_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_price": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_price_key": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cost_center": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_hide_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ext_uid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "dynamic_rule_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "flight_no": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "flt_takeoff_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "sms_policy": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "extra_info": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "callback_info": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_tags": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "line_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "accept_cp_driver": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "accept_relay_order": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carpool_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "count_person": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "waypointList": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.driver-position" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.h5" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 此为专用订单模式，需按所开通模式补充业务字段；不能将查询示例用于创建订单。", "required": [ "ext_uid", "owner", "from_longitude", "from_latitude", "to_longitude", "to_latitude", "caller_phone", "city_code", "order_type", "start_name", "end_name", "is_simultaneously_call", "service_type_price", "merchantOrderId" ], "properties": { "ext_uid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "owner": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "from_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "from_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "caller_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "is_simultaneously_call": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "service_type_price": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "accept_relay_order": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carpool_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "sms_policy": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ruleId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.multi" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 此为专用订单模式，需按所开通模式补充业务字段；不能将查询示例用于创建订单。", "required": [ "from_longitude", "from_latitude", "to_longitude", "to_latitude", "caller_phone", "city_code", "order_type", "start_name", "start_address", "end_name", "end_address", "is_simultaneously_call", "merchantOrderId" ], "properties": { "from_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "from_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "to_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "caller_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_address": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "is_simultaneously_call": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cost_center": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "car_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_hide_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ext_uid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_price": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_price_key": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "dynamic_rule_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "flight_no": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "flt_takeoff_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_longitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_latitude": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "sms_policy": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "extra_info": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "callback_info": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "order_tags": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "line_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "accept_cp_driver": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "accept_relay_order": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_poi_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carpool_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "count_person": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "service_type_price": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "waypointList": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "caocao.orders.recover" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "supplierOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "supplierOrderId": { "description": "仅用于原订单身份恢复，须先核对来源", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "fliggy-ticket.products.by-ids" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "productIds" ], "properties": { "productIds": { "description": "商品 ID 字符串数组，1—100 项，不重复；ID 来自商品分页查询，不传逗号拼接字符串。", "type": "array", "minItems": 1, "maxItems": 100, "uniqueItems": true, "items": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$", "description": "商品分页返回的原始商品 ID，保持字符串精度。" } } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "fliggy-ticket.products.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "productId" ], "properties": { "productId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "fliggy-ticket.products.page" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "pageNo", "pageSize" ], "properties": { "pageNo": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "pageSize": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "fliggy-ticket.products.price-stock" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "productId" ], "properties": { "productId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "beginTime": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "endTime": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "haiyawan.orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 DIRECT 商品必须传 account，不能传 totalNum；CARD 商品不能传 account，totalNum 默认 1；需要验证的商品必须带 phone 和 verifyCode。", "required": [ "merchantOrderId", "itemCode" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "itemCode": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "account": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "totalNum": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "verifyCode": { "description": "不传时发送验证码，传入时校验；属于写操作", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "haiyawan.orders.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "haiyawan.verification" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "itemCode", "phone" ], "properties": { "itemCode": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "verifyCode": { "description": "不传时发送验证码，传入时校验；属于写操作", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.catalog.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "enduserId", "city", "checkIn", "checkOut", "rooms", "hotelRef" ], "properties": { "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "city": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkIn": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkOut": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rooms": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "hotelRef": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.catalog.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "enduserId", "city", "checkIn", "checkOut", "rooms" ], "properties": { "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "city": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkIn": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkOut": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rooms": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.check" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "hotelId", "roomId", "rateTypeId", "checkInDate", "checkOutDate", "roomCount", "totalPrice" ], "properties": { "hotelId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "roomId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rateTypeId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkInDate": { "description": "入住日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "checkOutDate": { "description": "离店日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "roomCount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "totalPrice": { "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.cities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.guests" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "enduserId", "commandId", "contactName", "contactTel", "guests" ], "properties": { "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "commandId": { "description": "当前请求的稳定命令号，用于原命令恢复", "type": [ "string", "number" ] }, "contactName": { "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。", "type": [ "string", "number" ] }, "contactTel": { "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。", "type": [ "string", "number" ] }, "guests": { "description": "入住人对象数组，1—20 人；每人必填 lastName 和 firstName，仅支持下表列出的字段。姓名不能包含 /、逗号或控制字符，不得有首尾空白；所有姓/名以逗号连接后的总长不超过 1024 个 UTF-16 单元。登记返回 businessDataRef，后续报价使用该引用。", "type": "array", "minItems": 1, "maxItems": 20, "items": { "type": "object", "additionalProperties": false, "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[^/,\\u0000-\\u001f\\u007f]+$", "description": "姓，必填；最多 64 个 UTF-16 单元，不含 /、逗号、控制字符及首尾空白。" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[^/,\\u0000-\\u001f\\u007f]+$", "description": "名，必填；最多 64 个 UTF-16 单元，不含 /、逗号、控制字符及首尾空白。" }, "fullName": { "type": "string", "description": "可选原协议全名；不能代替 lastName、firstName。仅在实际业务要求时填写。" }, "idCardNumber": { "type": "string", "description": "可选原协议证件号；仅在实际业务要求时填写，不写入终端或日志。" } } } }, "remark": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.hotelIds" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "cityId" ], "properties": { "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.info" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "hotelId" ], "properties": { "hotelId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.mock-orders.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.mock-orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "hotelId", "roomId", "rateTypeId", "checkInDate", "checkOutDate", "roomCount", "totalPrice", "contactName", "contactTel", "orderGuests" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "hotelId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "roomId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rateTypeId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkInDate": { "description": "入住日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "checkOutDate": { "description": "离店日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "roomCount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "totalPrice": { "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分", "type": [ "string", "number" ] }, "contactName": { "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。", "type": [ "string", "number" ] }, "contactTel": { "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。", "type": [ "string", "number" ] }, "orderGuests": { "description": "原酒店订单协议的入住人字符串：姓/名，多人用英文逗号分隔，总长最多 1024 个 UTF-16 单元；不要与 hotel.guests 的 guests 对象数组混用。", "type": [ "string", "number" ] }, "remark": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "mockScenario": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.mock-orders.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.orders.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "hotelId", "roomId", "rateTypeId", "checkInDate", "checkOutDate", "roomCount", "totalPrice", "contactName", "contactTel", "orderGuests" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "hotelId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "roomId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rateTypeId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkInDate": { "description": "入住日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "checkOutDate": { "description": "离店日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "roomCount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "totalPrice": { "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分", "type": [ "string", "number" ] }, "contactName": { "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。", "type": [ "string", "number" ] }, "contactTel": { "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。", "type": [ "string", "number" ] }, "orderGuests": { "description": "原酒店订单协议的入住人字符串：姓/名，多人用英文逗号分隔，总长最多 1024 个 UTF-16 单元；不要与 hotel.guests 的 guests 对象数组混用。", "type": [ "string", "number" ] }, "remark": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.orders.draft" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "merchantOrderId", "enduserId", "quoteId", "commandId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "quoteId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "commandId": { "description": "当前请求的稳定命令号，用于原命令恢复", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.orders.pay" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "merchantOrderId", "enduserId", "commandId", "fundingSource", "expectedAmountCents" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "commandId": { "description": "当前请求的稳定命令号，用于原命令恢复", "type": [ "string", "number" ] }, "fundingSource": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "expectedAmountCents": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.orders.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.payments.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "merchantOrderId", "enduserId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "paymentId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.prices" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "hotelId", "checkInDate", "checkOutDate" ], "properties": { "hotelId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkInDate": { "description": "入住日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "checkOutDate": { "description": "离店日期 YYYY-MM-DD", "type": [ "string", "number" ] }, "roomId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rateTypeId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.quotes" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "enduserId", "commandId", "city", "checkIn", "checkOut", "rooms", "hotelRef", "roomRef", "productRef", "businessDataRef" ], "properties": { "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "commandId": { "description": "当前请求的稳定命令号，用于原命令恢复", "type": [ "string", "number" ] }, "city": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkIn": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "checkOut": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "rooms": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "hotelRef": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "roomRef": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productRef": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "businessDataRef": { "description": "由入住人信息登记返回的引用，不能自行拼造", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "hotel.quotes.recovery" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。", "required": [ "enduserId", "commandId" ], "properties": { "enduserId": { "description": "当前应用可信用户标识，由商户服务端核验", "type": [ "string", "number" ] }, "commandId": { "description": "当前请求的稳定命令号，用于原命令恢复", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.apis" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.brand-cake.brands" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "cityId" ], "properties": { "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.brand-cake.categories" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.brand-cake.cities" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.brand-cake.products" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "cityId", "pageNum", "pageSize" ], "properties": { "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "pageNum": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "pageSize": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "brandId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "groupId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "keyword": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.cake-delivery.products" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": { "productName": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productSpu": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productClassifyName": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.flowers.categories" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.flowers.products" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "productClassifyName" ], "properties": { "productClassifyName": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productName": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "productSpu": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.food.cities" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.food.menu" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "brand" ], "properties": { "brand": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "storeCode": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "storeId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "shopId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "delivery": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "orderType": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.food.stores" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "brand", "cityId" ], "properties": { "brand": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.movie.cinemas" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "version", "cityId" ], "properties": { "version": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "districtId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "brandId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.movie.cities" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "version" ], "properties": { "version": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "laiyipiao.movie.movies" }, "params": { "type": "object", "description": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。", "required": [ "version", "cityId" ], "properties": { "version": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "cityId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "qianhang.orders.confirm" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "productId", "phone", "carrier", "face", "smsCode" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "productId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carrier": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "face": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "smsCode": { "description": "短信验证码；仅发送至接口，不记录到日志", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "qianhang.orders.identity" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "number" ], "properties": { "number": { "description": "本应用原商户订单号；使用字符串", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "qianhang.orders.sms" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "merchantOrderId", "productId", "phone", "carrier", "face" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "productId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "carrier": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "face": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "qianhang.orders.status" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "number" ], "properties": { "number": { "description": "本应用原商户订单号；使用字符串", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "qianhang.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "phone" ], "properties": { "phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "category": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.account.balance" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.account.withdraw" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "draw_amount", "merchantRequestId" ], "properties": { "draw_amount": { "description": "单位：元，小数位保留到分", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.apis" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.bills.account" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "required": [ "bill_date", "bill_type" ], "properties": { "bill_date": { "description": "日期格式：2025-03-25", "type": [ "string", "number" ] }, "bill_type": { "description": "账单类型 TRANSFER-转账账单 WITHDRAW-提现账单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.bills.fund" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "required": [ "bill_date" ], "properties": { "bill_date": { "description": "日期格式：2025-03-25", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.bills.settlement" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "required": [ "bill_date" ], "properties": { "bill_date": { "description": "日期格式：2025-03-25", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.bills.trade" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "required": [ "bill_date" ], "properties": { "bill_date": { "description": "日期格式：2025-03-25", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.bill" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "order_id", "money", "terminal_sn", "terminal_type", "merchantRequestId" ], "properties": { "order_id": { "description": "商户订单号", "type": [ "string", "number" ] }, "money": { "description": "订单的资金总额，单位：分", "type": [ "string", "number" ] }, "valid_date": { "description": "超过此时间后，订单不能再进行支付 格式：2022-12-31 23:59:59", "type": [ "string", "number" ] }, "terminal_sn": { "description": "终端编号", "type": [ "string", "number" ] }, "terminal_type": { "description": "终端类型（目前只支持SPOS） SPOS-智能POS", "type": [ "string", "number" ] }, "order_desc": { "description": "订单描述，展示到收银终端订单信息界面", "type": [ "string", "number" ] }, "order_link": { "description": "支持浏览器的设备，可以点击链接查看订单详情", "type": [ "string", "number" ] }, "extra_data": { "description": "附加信息，订单同步时会原样带回", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.close" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "order_id", "merchantRequestId" ], "properties": { "time": { "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填", "type": [ "string", "number" ] }, "order_id": { "description": "商户系统订单号", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "pay_type", "money", "order_id", "addip", "merchantRequestId" ], "properties": { "shop_no": { "description": "如果区分门店订单，上送支付后台给门店分配的编号，如：100101", "type": [ "string", "number" ] }, "pay_type": { "description": "微信扫码：wxqrcode； 微信公众号/小程序：wxwap； 微信被扫：wxbeiqrcode； 支付宝扫码：aliqrcode； 支付宝JS：aliwap； 支付宝被扫：alibeiqrcode； 银联JS支付：ylwap； 银联被扫：yltakeout； 银联扫码：yltakein； [代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式支持下列支付方式： 微信H5：wxhtml； 支付宝H5：alihtml； 微信APP：wxapp； 支付宝APP：aliapp； ", "type": [ "string", "number" ] }, "money": { "description": "订单的资金总额，单位：分", "type": [ "string", "number" ] }, "is_mp": { "description": "如果是小程序支付，赋值为1 不是小程序支付，不传或者赋值为0 小程序[代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式，赋值为2", "type": [ "string", "number" ] }, "order_id": { "description": "确保唯一,长度不超过32，尽量随机生成，例如：MD5(随机字符串+时间戳+随机字符串)", "type": [ "string", "number" ] }, "valid_time": { "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）", "type": [ "string", "number" ] }, "commodity_name": { "description": "商品名称", "type": [ "string", "number" ] }, "sub_appid": { "description": "微信公众号 支付宝服务窗 微信小程序 支付宝小程序 上述支付场景需要上送对应的AppID(应用ID)", "type": [ "string", "number" ] }, "authcode": { "description": "用户出示付款码支付场景下使用，值为用户的付款码解析后的数字串", "type": [ "string", "number" ] }, "sub_openid": { "description": "微信上传用户openid； 支付宝上传用户buyer_id； 获取方式详见微信或支付宝文档；", "type": [ "string", "number" ] }, "addip": { "description": "获取消费者当前ip", "type": [ "string", "number" ] }, "terminal_id": { "description": "自定义终端编号，如：100101", "type": [ "string", "number" ] }, "order_notes": { "description": "订单备注", "type": [ "string", "number" ] }, "extra": { "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22", "type": [ "string", "number" ] }, "share_order_type": { "description": "0-不需要分账 1-需要分账 默认为0", "type": [ "string", "number" ] }, "return_url": { "description": "[代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式使用 H5模式，上送值为微信H5支付方式页面回跳地址 支付宝APP模式，上送值为返回商户APP的Schema", "type": [ "string", "number" ] }, "extend_params": { "description": "可选原生通道参数对象编码一次后的 JSON 字符串，不直接传对象。具体字段由已开通的微信、支付宝或银联通道协议决定；不要自行猜测。未要求原生参数时省略该字段。", "type": "string", "contentMediaType": "application/json", "contentSchema": { "type": "object" } }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.face-auth" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "required": [ "raw_data", "device_id" ], "properties": { "raw_data": { "description": "由微信人脸SDK的getWxpayfaceRawdata接口返回", "type": [ "string", "number" ] }, "device_id": { "description": "由商户定义，与终端一一对应", "type": [ "string", "number" ] }, "store_id": { "description": "由商户定义， 各门店唯一", "type": [ "string", "number" ] }, "store_name": { "description": "由商户定义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.qrcode" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "money", "order_id", "merchantRequestId" ], "properties": { "money": { "description": "订单的资金总额，单位：分", "type": [ "string", "number" ] }, "order_id": { "description": "确保唯一,长度不超过32，尽量随机生成，例如：MD5(随机字符串+时间戳+随机字符串)", "type": [ "string", "number" ] }, "valid_time": { "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）", "type": [ "string", "number" ] }, "terminal_id": { "description": "自定义终端编号，如：100101", "type": [ "string", "number" ] }, "commodity_name": { "description": "商品名称", "type": [ "string", "number" ] }, "extra": { "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22", "type": [ "string", "number" ] }, "share_order_type": { "description": "0-不需要分账 1-需要分账 默认为0", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。", "required": [ "order_id" ], "properties": { "time": { "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填", "type": [ "string", "number" ] }, "order_id": { "description": "商户系统订单号", "type": [ "string", "number" ] }, "order_type": { "description": "0-普通订单 1-[账单支付](https://www.showdoc.com.cn/tengfullpay/9813315721070582)订单 不传默认为普通订单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.refund" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。 refund_no 为强制稳定退款单号；查询响应中的金额为元，文档样例存在矛盾，禁止猜测换算入账。", "required": [ "order_id", "refund_no", "refund_money", "merchantRequestId" ], "properties": { "order_id": { "description": "商户交易单号", "type": [ "string", "number" ] }, "refund_no": { "description": "商户平台生成的退款单号", "type": [ "string", "number" ] }, "time": { "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填", "type": [ "string", "number" ] }, "refund_money": { "description": "退款金额，不能大于订单金额 单位：分", "type": [ "string", "number" ] }, "divide_refund_details": { "description": "可选 JSON 数组编码一次后的字符串；仅通道确认支持指定分账退款时使用。1—100 项，各项字段见下表；amount 单位为分，不得套用分账的元单位。", "type": "string", "contentMediaType": "application/json", "contentSchema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "additionalProperties": false, "required": [ "refund_mch" ], "properties": { "refund_mch": { "type": [ "string", "integer" ], "pattern": "^[0-9]{1,32}$", "minimum": 0, "description": "实际退款商户号，1—32 位数字，建议字符串。" }, "amount": { "type": [ "string", "integer" ], "pattern": "^[1-9][0-9]{0,11}$", "minimum": 1, "maximum": 999999999999, "description": "可选指定退款金额，单位分，1—12 位正整数；不是元。" }, "receiver_order_no": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,32}$", "description": "可选原接收方订单号，来源必须核对原业务。" }, "refund_account": { "type": "string", "enum": [ "DIVIDE_ACCOUNT" ], "description": "可选指定分账账户；当前仅支持 DIVIDE_ACCOUNT。" } } } } }, "username": { "description": "退款操作人员", "type": [ "string", "number" ] }, "remark": { "description": "退款操作者备注", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.payments.wechat-redirect" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。 仅准备公众号跳转链接，不在服务端发起付款。返回 PREPARED，须由用户在微信内打开；支付结果仍需查原单。", "required": [ "money", "order_id", "merchantRequestId" ], "properties": { "money": { "description": "订单的资金总额，单位：分", "type": [ "string", "number" ] }, "order_id": { "description": "确保唯一,长度不超过32", "type": [ "string", "number" ] }, "valid_time": { "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）", "type": [ "string", "number" ] }, "extra": { "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22", "type": [ "string", "number" ] }, "share_order_type": { "description": "0-不需要分账 1-需要分账 默认为0", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.refunds.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "required": [], "properties": { "refund_no": { "description": "商户平台退款单号 refund_no,order_id二选一，不能同时为空", "type": [ "string", "number" ] }, "order_id": { "description": "退款接口返回的out_refund_no refund_no,order_id二选一，不能同时为空", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.requests" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "id" ], "properties": { "id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.requests.recover" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "id" ], "properties": { "id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.shares.back" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "merch_share_back_sn", "details", "merchantRequestId" ], "properties": { "share_sn": { "description": "share_sn，merch_share_sn二选一必填", "type": [ "string", "number" ] }, "merch_share_sn": { "description": "share_sn，merch_share_sn二选一必填", "type": [ "string", "number" ] }, "merch_share_back_sn": { "description": "", "type": [ "string", "number" ] }, "details": { "description": "JSON 数组编码一次后的字符串，不是直接传数组；1—100 项、总字符串最多 500 个字符。share_detail_no 不得重复；back_amount 单位元，大于 0、最多两位小数。先查原分账明细，再按原单退回。", "type": "string", "maxLength": 500, "contentMediaType": "application/json", "contentSchema": { "type": "array", "minItems": 1, "maxItems": 100, "x-uniqueBy": "share_detail_no", "items": { "type": "object", "additionalProperties": false, "required": [ "share_detail_no", "back_amount" ], "properties": { "share_detail_no": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,32}$", "description": "原分账查询返回的明细号，1—32 个字母、数字、下划线或短横线；不能自行生成。" }, "back_amount": { "anyOf": [ { "type": "string", "pattern": "^(?!0(?:\\.0{1,2})?$)(0|[1-9][0-9]{0,9})(\\.[0-9]{1,2})?$" }, { "type": "number", "exclusiveMinimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 } ], "description": "本明细退回金额，单位元；大于 0、最多两位小数，建议十进制字符串。" }, "back_desc": { "type": "string", "maxLength": 50, "description": "可选退回说明，最多 50 个 Unicode 字符，不含换行或 NUL。" } } } } }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.shares.back-query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "required": [], "properties": { "share_back_sn": { "description": "share_back_sn，merch_share_back_sn 二选一必填", "type": [ "string", "number" ] }, "merch_share_back_sn": { "description": "share_back_sn，merch_share_back_sn 二选一必填", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.shares.complete" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "order_id", "merch_share_sn", "order_date", "merchantRequestId" ], "properties": { "order_id": { "description": "交易订单平台单号 下单成功时返回", "type": [ "string", "number" ] }, "merch_share_sn": { "description": "商户分账完成单订单号", "type": [ "string", "number" ] }, "order_date": { "description": "格式：20250212", "type": [ "string", "number" ] }, "share_complete_desc": { "description": "", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.shares.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "required": [ "order_id", "order_date", "merch_share_sn", "receivers", "merchantRequestId" ], "properties": { "order_id": { "description": "小腾支付订单号", "type": [ "string", "number" ] }, "order_date": { "description": "格式：20220212", "type": [ "string", "number" ] }, "merch_share_sn": { "description": "", "type": [ "string", "number" ] }, "receivers": { "description": "1—100 个分账接收方对象，接收商户号不得重复；每项仅包含 receiver_merch_no、receive_amount。金额单位为元，最多两位小数且必须大于 0，建议使用十进制字符串。", "type": "array", "minItems": 1, "maxItems": 100, "x-uniqueBy": "receiver_merch_no", "items": { "type": "object", "additionalProperties": false, "required": [ "receiver_merch_no", "receive_amount" ], "properties": { "receiver_merch_no": { "type": [ "string", "integer" ], "pattern": "^[0-9]{1,32}$", "minimum": 0, "description": "已确认的接收商户号，1—32 位数字；建议以字符串传递，保留前导零和精度。" }, "receive_amount": { "anyOf": [ { "type": "string", "pattern": "^(?!0(?:\\.0{1,2})?$)(0|[1-9][0-9]{0,9})(\\.[0-9]{1,2})?$" }, { "type": "number", "exclusiveMinimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 } ], "description": "分账金额，单位元；大于 0，整数部分最多 10 位，小数最多两位。推荐字符串，如 0.01；示例金额仅用于展示，执行前核对实际业务金额。" } } } }, "merchantRequestId": { "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "tengfullpay.shares.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "required": [ "order_id" ], "properties": { "order_id": { "description": "支付平台分账申请单号 请求分账时返回", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.activity.list" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "page" ], "properties": { "page": { "description": "页数", "type": [ "string", "number" ] }, "page_size": { "description": "每页个数，默认10", "type": [ "string", "number" ] }, "cate_id": { "description": "可不传，默认1 ，CPS类", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.activity.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "userTag", "activityId", "positionId" ], "properties": { "userTag": { "description": "自定义参数，用户唯一标识，长度30以内", "type": [ "string", "number" ] }, "activityId": { "description": "活动素材ID ， 活动ID和推广位ID获取方式 ", "type": [ "string", "number" ] }, "positionId": { "description": "推广位ID ， 活动ID和推广位ID获取方式 ", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.apis" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [], "properties": {}, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-ele.activities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "longitude", "latitude" ], "properties": { "longitude": { "description": "经度", "type": [ "string", "number" ] }, "latitude": { "description": "纬度", "type": [ "string", "number" ] }, "session_id": { "description": "会话ID（分页场景首次请求结果返回，后续请求必须携带，服务根据同一个session_id的请求次数自动叠加翻页返回数据，直至分页结束，返回空）", "type": [ "string", "number" ] }, "sort_type": { "description": "排序类型，默认normal，排序规则包括:{\"normal\":\"佣金倒序\",\"distance_asc\":\"距离由近到远\",\"commission_desc\":\"佣金倒序\",\"month_sales_desc\":\"月销量从高到低\",\"commission_rate_desc\":\"佣金比例倒序\", \"activity_reward_desc\":\"返现金额倒序\"}", "type": [ "string", "number" ] }, "search_content": { "description": "搜索内容（店铺名）", "type": [ "string", "number" ] }, "city_id": { "description": "标准城市ID（经纬度范围覆盖多个城市时，精准召回）", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-ele.apply" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "shop_id", "activity_id", "order_no", "mobile", "merchantRequestId" ], "properties": { "shop_id": { "description": "门店ID", "type": [ "string", "number" ] }, "activity_id": { "description": "活动ID", "type": [ "string", "number" ] }, "order_no": { "description": "唯一单号，跟单使用，也就是user_tag", "type": [ "string", "number" ] }, "mobile": { "description": "用户手机号", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-ele.attribution" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "order_no" ], "properties": { "order_no": { "description": "外卖单号", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-ele.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "lock_id", "merchantRequestId" ], "properties": { "lock_id": { "description": "报名接口返回的锁定ID", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-ele.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "shop_id", "activity_id" ], "properties": { "shop_id": { "description": "活动列表门店ID", "type": [ "string", "number" ] }, "activity_id": { "description": "活动列表 活动ID", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-meituan.activities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "mobile", "lat", "lng" ], "properties": { "mobile": { "description": "手机号，请使用用户真实手机号，不能固定一个，否则会风控。", "type": [ "string", "number" ] }, "lat": { "description": "用户位置坐标纬度", "type": [ "string", "number" ] }, "lng": { "description": "用户位置坐标经度", "type": [ "string", "number" ] }, "page_pvid": { "description": "首次传空字符串，后续回传接口返回的 pagePvId", "type": [ "string", "number" ] }, "sort": { "description": "0 默认 1距离最近 2佣金降序", "type": [ "string", "number" ] }, "name": { "description": "搜索词", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-meituan.apply" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "mobile", "poiEventId", "meituanPvId", "pid", "lat", "lng", "merchantRequestId" ], "properties": { "mobile": { "description": "列表获取的手机号", "type": [ "string", "number" ] }, "poiEventId": { "description": "商家活动 ID 从商家活动列表接⼝中获取", "type": [ "string", "number" ] }, "meituanPvId": { "description": "商家检索 meituanPvId 从商家活动列表接⼝中获取", "type": [ "string", "number" ] }, "pid": { "description": "推广位 ， 活动ID和推广位ID获取方式 ", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义参数，用于跟踪", "type": [ "string", "number" ] }, "lat": { "description": "用户位置坐标纬度", "type": [ "string", "number" ] }, "lng": { "description": "用户位置坐标经度", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-meituan.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "mobile", "userEventId", "merchantRequestId" ], "properties": { "mobile": { "description": "参与的手机号", "type": [ "string", "number" ] }, "userEventId": { "description": "用户参与的ID", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang-meituan.status" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "mobile", "userEventId" ], "properties": { "mobile": { "description": "手机号", "type": [ "string", "number" ] }, "userEventId": { "description": "用户参与的Id", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.bawang.blacklist" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "mobile" ], "properties": { "mobile": { "description": "查询手机号", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.cards.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。 先查询权益和规格；直充必须填写 account，卡券通常不填。client_type 只能使用供应商文档中的 mini 或 public。ACCEPTED 仅表示订单已受理，不证明付款、到账或发券；下单能力由运营按应用授权启用，资金确认不通过本接口伪造。", "required": [ "id", "spec_id", "client_type", "merchantRequestId" ], "properties": { "id": { "description": "权益id", "type": [ "string", "number" ] }, "spec_id": { "description": "规格id", "type": [ "string", "number" ] }, "account": { "description": "需要充值的账号，直充特有字段", "type": [ "string", "number" ] }, "client_type": { "description": "付款客户端，mini=小程序，public=公众号", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.cards.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "required": [ "id" ], "properties": { "id": { "description": "权益id", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.cards.order" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。 order_no 与 cms_order_num 至少传一个。平台创建的订单优先通过 wikeyun.requests.recover 按原 merchantRequestId 恢复。", "required": [], "properties": { "order_no": { "description": "官方订单号 (和外部对接方订单号选择传一个)", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.cards.orders" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "required": [ "page", "page_size" ], "properties": { "page": { "description": "第几页", "type": [ "string", "number" ] }, "page_size": { "description": "一页显示多少条数据", "type": [ "string", "number" ] }, "status": { "description": "订单状态：传空=全部，-1=支付超时，0=未付款 ，1=已付款，2=购买充值中，3=已使用，4=失败（未退款），5=失败（已退款）", "type": [ "string", "number" ] }, "keyword": { "description": "订单号或商品名模糊搜索", "type": [ "string", "number" ] }, "order_type": { "description": "订单类型：传空=全部，0=充值订单，1=卡券订单", "type": [ "string", "number" ] }, "g_id": { "description": "商品id：传空=全部，传其他id则查该商品下的订单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.cards.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "required": [], "properties": { "id": { "description": "权益id，不传或传空字符串=全部", "type": [ "string", "number" ] }, "pro_type": { "description": "产品类型，不传或传空字符串=全部，0=直充，1=卡券", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.categories" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [], "properties": { "parent_id": { "description": "上级id，0表示顶级栏目，默认为0", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "product_ids" ], "properties": { "product_ids": { "description": "商品ID，最多20个。注意：如商品推广在抖店后台下架，接口会返回为空。", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.life-activity" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "activity_id" ], "properties": { "activity_id": { "description": "活动ID, 活动列表 ，1:抖音生活服务新人专区，2:抖音生活服务商品集合页", "type": [ "string", "number" ] }, "userTag": { "description": "自定义参数，用于订单跟踪", "type": [ "string", "number" ] }, "need_qr_code": { "description": "是否需要二维码，默认false", "type": [ "string", "number" ] }, "need_share_link": { "description": "是否返回站外H5链接 默认false", "type": [ "string", "number" ] }, "need_zlink": { "description": "是否返回zlink，默认false", "type": [ "string", "number" ] }, "need_share_command": { "description": "是否需要口令，默认false", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.life-detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "id" ], "properties": { "id": { "description": "商品ID", "type": [ "string", "number" ] }, "longitude": { "description": "", "type": [ "string", "number" ] }, "latitude": { "description": "", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.life-parse" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "command" ], "properties": { "command": { "description": "短链/口令", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.life-products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "cursor", "count", "longitude", "latitude" ], "properties": { "cursor": { "description": "游标。注意：首次查询时传空，第二次查询传第一次查询返回值中的cursor", "type": [ "string", "number" ] }, "count": { "description": "数量。默认为20，最大值为20 注意：response可能因为过滤等原因,返回数量小于count", "type": [ "string", "number" ] }, "sort_by": { "description": "排序字段。默认：1: 距离 2: 销量 3: 价格 4: 佣金比率 注意：销量升序，会出现较多后置过滤，导致列表为空的情况。请不要支持该功能", "type": [ "string", "number" ] }, "order_by": { "description": "排序方式。默认： 1: 升序 2: 降序", "type": [ "string", "number" ] }, "longitude": { "description": "纬度。WGS84坐标，参见https://tool.lu/coordinate。默认为北京市王府井 重要：一定需要WGS84坐标，且线上场景必需传递该参数", "type": [ "string", "number" ] }, "latitude": { "description": "纬度。WGS84坐标，参见https://tool.lu/coordinate。默认为北京市王府井 重要：一定需要WGS84坐标，且线上场景必需传递该参数", "type": [ "string", "number" ] }, "distance_max": { "description": "距离限制。示例：3000，表示经纬度为中心3000米内商品", "type": [ "string", "number" ] }, "category_id": { "description": "类别信息。参见： 商品类目20230727 ", "type": [ "string", "number" ] }, "keyword": { "description": "商品名称关键字。", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.life-transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "command" ], "properties": { "command": { "description": "商品ID/短链/口令", "type": [ "string", "number" ] }, "userTag": { "description": "自定义参数，用于订单跟踪", "type": [ "string", "number" ] }, "need_qr_code": { "description": "是否需要二维码，默认false", "type": [ "string", "number" ] }, "need_share_link": { "description": "是否返回站外H5链接 默认false", "type": [ "string", "number" ] }, "need_zlink": { "description": "是否返回zlink，默认false", "type": [ "string", "number" ] }, "need_share_command": { "description": "是否需要口令，默认false", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.orders" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "cursor", "start_time", "end_time" ], "properties": { "cursor": { "description": "下一页索引（第一页传“0”）", "type": [ "string", "number" ] }, "start_time": { "description": "支付时间开始，最早支持2021年10月01日", "type": [ "string", "number" ] }, "end_time": { "description": "支付时间结束，该时间不能超过start_time+90", "type": [ "string", "number" ] }, "page_size": { "description": "每页订单数目，取值区间： [1, 20]", "type": [ "string", "number" ] }, "order_type": { "description": "只能是1或2或3，如果access_type选择2-SDK接入，则此时只能支持查询直播间分销的订单，order_type务必传2；", "type": [ "string", "number" ] }, "time_type": { "description": "查询时间类型。pay: 支付时间（默认）; update：联盟侧更新时间，非订单状态更新时间", "type": [ "string", "number" ] }, "order_ids": { "description": "最多支持10个订单号，如果这个字段填了，start_time/end_time/cursor/size不会使用", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.parse" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "share_command", "convert" ], "properties": { "share_command": { "description": "抖音商品口令", "type": [ "string", "number" ] }, "convert": { "description": "是否二次转链接 1是，0否", "type": [ "string", "number" ] }, "external_info": { "description": "转链接时，自定义参数", "type": [ "string", "number" ] }, "need_qr_code": { "description": "转链接时，是否需要获取抖音二维码", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [], "properties": { "title": { "description": "搜索的商品名称", "type": [ "string", "number" ] }, "cid": { "description": "类目id", "type": [ "string", "number" ] }, "page": { "description": "页码，默认1", "type": [ "string", "number" ] }, "size": { "description": "每页个数，默认10", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "keyword", "page", "page_size", "search_type", "sort_type" ], "properties": { "keyword": { "description": "返回标题中包含某个关键词的商品", "type": [ "string", "number" ] }, "page": { "description": "页数", "type": [ "string", "number" ] }, "page_size": { "description": "每页大小", "type": [ "string", "number" ] }, "search_type": { "description": "召回结果排序条件，0默认排序1历史销量排序2价格排序3佣金金额排序4佣金比例排序；", "type": [ "string", "number" ] }, "sort_type": { "description": "排序顺序（0升序1降序）", "type": [ "string", "number" ] }, "ext": { "description": "此项为自定义，需要根据https://op.jinritemai.com/docs/api-docs/61/924这边请求参数进行自定义，如你想筛选价格，则ext需要传{\"price_min\":10,\"price_max\":20}", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.douyin.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "product_url" ], "properties": { "product_url": { "description": "商品ID/商品URL/口令/短链接", "type": [ "string", "number" ] }, "external_info": { "description": "自定义字段，只允许 数字 ，限制长度为10", "type": [ "string", "number" ] }, "need_qr_code": { "description": "是否需要二维码，需要会导致响应耗时增加", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "required": [ "order_no", "merchantRequestId" ], "properties": { "order_no": { "description": "微客云订单号", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 先查运费，使用返回的 type 作为 deliveryType、channelId 原值；vloumLong/vloumWidth/vloumHeight 必须成组。notify_url、cms_order_num 由网关注入。受理不等于支付或发货。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "required": [ "deliveryType", "channelId", "senderProvince", "senderCity", "senderDistrict", "senderAddress", "senderName", "senderPhone", "receiveProvince", "receiveCity", "receiveDistrict", "receiveAddress", "receiveName", "receivePhone", "packageCount", "weight", "goodsName", "merchantRequestId" ], "properties": { "deliveryType": { "description": "快递 类型", "type": [ "string", "number" ] }, "channelId": { "description": "渠道ID", "type": [ "string", "number" ] }, "senderProvince": { "description": "寄件人省", "type": [ "string", "number" ] }, "senderCity": { "description": "寄件人市", "type": [ "string", "number" ] }, "senderDistrict": { "description": "寄件人区", "type": [ "string", "number" ] }, "senderAddress": { "description": "寄件人详细地址", "type": [ "string", "number" ] }, "senderName": { "description": "寄件人姓名", "type": [ "string", "number" ] }, "senderPhone": { "description": "寄件人电话号", "type": [ "string", "number" ] }, "receiveProvince": { "description": "收件人省", "type": [ "string", "number" ] }, "receiveCity": { "description": "收件人市", "type": [ "string", "number" ] }, "receiveDistrict": { "description": "收件人区", "type": [ "string", "number" ] }, "receiveAddress": { "description": "收件人详细地址", "type": [ "string", "number" ] }, "receiveName": { "description": "收件人姓名", "type": [ "string", "number" ] }, "receivePhone": { "description": "受家人电话号", "type": [ "string", "number" ] }, "packageCount": { "description": "包裹数量", "type": [ "string", "number" ] }, "weight": { "description": "重量", "type": [ "string", "number" ] }, "goodsName": { "description": "物品名称", "type": [ "string", "number" ] }, "vloumLong": { "description": "长/CM，长宽高如传值则都必须传", "type": [ "string", "number" ] }, "vloumWidth": { "description": "宽/CM，长宽高如传值则都必须传", "type": [ "string", "number" ] }, "vloumHeight": { "description": "高/CM，长宽高如传值则都必须传", "type": [ "string", "number" ] }, "insuranceValue": { "description": "保价金额，最大20000元", "type": [ "string", "number" ] }, "pickUpStartTime": { "description": "预约上门取件开始时间，格式：YYYY-MM-DD HH:mm:ss", "type": [ "string", "number" ] }, "pickUpEndTime": { "description": "预约上门取件结束时间，格式：YYYY-MM-DD HH:mm:ss", "type": [ "string", "number" ] }, "remark": { "description": "", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.insured-price" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 保费与是否支持保价取决于具体快递渠道；业务拒绝保留供应商原码。", "required": [ "senderProvince", "senderCity", "senderDistrict", "receiveProvince", "receiveCity", "receiveDistrict", "weight", "price", "type" ], "properties": { "senderProvince": { "description": "寄件省", "type": [ "string", "number" ] }, "senderCity": { "description": "寄件市", "type": [ "string", "number" ] }, "senderDistrict": { "description": "寄件区", "type": [ "string", "number" ] }, "senderName": { "description": "寄件人姓名", "type": [ "string", "number" ] }, "senderAddress": { "description": "寄件人详细地址", "type": [ "string", "number" ] }, "senderPhone": { "description": "寄件人手机号", "type": [ "string", "number" ] }, "receiveProvince": { "description": "收件省", "type": [ "string", "number" ] }, "receiveCity": { "description": "收件市", "type": [ "string", "number" ] }, "receiveDistrict": { "description": "收件区", "type": [ "string", "number" ] }, "receiveName": { "description": "收件人姓名", "type": [ "string", "number" ] }, "receiveAddress": { "description": "收件人地址", "type": [ "string", "number" ] }, "receivePhone": { "description": "收件人电话号", "type": [ "string", "number" ] }, "weight": { "description": "商品重量（kg）", "type": [ "string", "number" ] }, "long": { "description": "", "type": [ "string", "number" ] }, "width": { "description": "", "type": [ "string", "number" ] }, "height": { "description": "", "type": [ "string", "number" ] }, "price": { "description": "面值字符串，需先查询可售商品", "type": [ "string", "number" ] }, "type": { "description": "快递类型", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.pay" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 可能发生真实余额扣款；要求独立支付开关及稳定 merchantRequestId，不自动重试。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "required": [ "order_no", "merchantRequestId" ], "properties": { "order_no": { "description": "微客云订单编号", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.price" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。", "required": [ "senderProvince", "senderCity", "senderDistrict", "receiveProvince", "receiveCity", "receiveDistrict", "weight" ], "properties": { "senderProvince": { "description": "寄件人省", "type": [ "string", "number" ] }, "senderCity": { "description": "寄件人市", "type": [ "string", "number" ] }, "senderDistrict": { "description": "寄件人区", "type": [ "string", "number" ] }, "senderPhone": { "description": "寄件人电话号", "type": [ "string", "number" ] }, "senderAddress": { "description": "寄件人详细地址", "type": [ "string", "number" ] }, "receiveProvince": { "description": "收件人省", "type": [ "string", "number" ] }, "receiveCity": { "description": "收件人市", "type": [ "string", "number" ] }, "receiveDistrict": { "description": "收件人区", "type": [ "string", "number" ] }, "receiveName": { "description": "收件人电话号", "type": [ "string", "number" ] }, "receiveAddress": { "description": "收件人地址", "type": [ "string", "number" ] }, "receivePhone": { "description": "收件人电话号", "type": [ "string", "number" ] }, "weight": { "description": "商品总量", "type": [ "string", "number" ] }, "long": { "description": "长", "type": [ "string", "number" ] }, "width": { "description": "宽", "type": [ "string", "number" ] }, "height": { "description": "高", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.express.trace" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 order_no 为微客云订单号；轨迹不能作为支付、退款或补差已完成的依据。", "required": [ "order_no" ], "properties": { "order_no": { "description": "微客云订单号", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.jd.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "num_iid", "sceneId" ], "properties": { "num_iid": { "description": "商品ID", "type": [ "string", "number" ] }, "sceneId": { "description": "使用场景 ：1 - 联盟id ，2返利场景", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.jd.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "page", "eliteId" ], "properties": { "page": { "description": "页数", "type": [ "string", "number" ] }, "eliteId": { "description": "1-好券商品,2-精选卖场,10-9.9包邮,15-京东配送,22-实时热销榜,23-为你推荐,24-数码家电,25-超市,26-母婴玩具,27-家具日用,28-美妆穿搭,30-图书文具,31-今日必推,32-京东好物,33-京东秒杀,34-拼购商品,40-高收益榜", "type": [ "string", "number" ] }, "pageSize": { "description": "每页条数", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.jd.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "page", "keyword" ], "properties": { "page": { "description": "页数", "type": [ "string", "number" ] }, "keyword": { "description": "搜索关键词", "type": [ "string", "number" ] }, "extra": { "description": "附加搜索json数据，参考https://union.jd.com/openplatform/api/v2?apiName=jd.union.open.goods.query", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.jd.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [], "properties": { "materialUrl": { "description": "京东链接，支持联盟短链接/联盟长链接/联盟商品链接，主站的请先调用搜索接口获取联盟链接", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义参数，订单列表会返回", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.meituan.coupons" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "platform", "pageNo", "pageSize", "longitude", "latitude" ], "properties": { "platform": { "description": "商品所属业务一级分类类型：1 到家及其他业务类型，2 到店业务类型（包含到店美食、休闲生活、酒店、门票）；", "type": [ "string", "number" ] }, "listTopiId": { "description": "选品池榜单主题ID，到家及其他业务类型支持查询：1 精选，2 今日必推，3 同城热销（其中到家医药业务类型，本项为必填，且只支持传枚举3）；到店业务类型支持查询：2 今日必推，3 同城热销（全部商品），5 实时热销，（其中到店酒店、门票业务类型，本项为必填，且只支持传枚举3）", "type": [ "string", "number" ] }, "bizLine": { "description": "商品所属业务二级分类类型；当字段platform为1，选择到家及其他业务类型时：5 医药 ，不填则默认为null，返回外卖商品券；当字段platform为2，选择到店业务类型时：1 到餐，2 到综 3：酒店 4：门票 不填则默认1", "type": [ "string", "number" ] }, "pageNo": { "description": "页码", "type": [ "string", "number" ] }, "pageSize": { "description": "每页个数", "type": [ "string", "number" ] }, "longitude": { "description": "定位经纬度的经度", "type": [ "string", "number" ] }, "latitude": { "description": "定位经纬度的纬度", "type": [ "string", "number" ] }, "searchText": { "description": "搜索词", "type": [ "string", "number" ] }, "sortField": { "description": "1）未入参榜单listTopiId时：支持1 售价排序、2 销量排序、6离我最近；2）入参榜单listTopiId时：当platform为1，选择到家业务类型：外卖商品券类型，支持1 售价排序、 2 销量降序、 3佣金降序，不填则默认为1；到家医药类型，支持2 销量降序、 3 佣金降序，不填则默认为2； 当platform为2，选择到店业务类型：支持2 销量降序、 3佣金降序、6离我最近，不填则默认为2。其中listTopiId为5时，仅支持默认排序，sortField不生效；注：当listTopiId选择榜单后，排序sortField不生效，榜单只能按照销量排序。3)通过搜索searchText召回时：支持1综合排序、2价格升序、6离我最近，不填默认为1", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.meituan.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "user_tag", "productViewSign", "linkTypeList" ], "properties": { "user_tag": { "description": "自定义跟踪参数", "type": [ "string", "number" ] }, "bizLine": { "description": "商品所属业务二级分类类型；请求的商品推广链接所属的业务类型信息，即只有输入productViewSign时才需要传本字段；当字段platform为1，选择到家及其他业务类型时：5 医药，不填则默认null，表示外卖商品券；当字段platform为2，选择到店业务类型时：1 到餐，2 到综 3：酒店 4：门票 不填则默认1", "type": [ "string", "number" ] }, "platform": { "description": "商品所属业务一级分类类型；请求的商品推广链接所属的业务类型信息，即只有输入productViewSign时才需要传本字段：1 到家及其他业务类型，2 到店业务类型；不填则默认1", "type": [ "string", "number" ] }, "productViewSign": { "description": "queryCoupon接口返回的商品productViewSign", "type": [ "string", "number" ] }, "linkTypeList": { "description": "链接类型列表， 枚举值：1 H5长链接；2 H5短链接；3 deeplink(唤起)链接；4 微信小程序唤起路径；5 团口令；6 小程序码;注：团口令、h5短链、小程序二维码有效期60天 ，其余无限制。多个逗号分割", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.orders.commission" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "orderid" ], "properties": { "orderid": { "description": "单号", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.orders.promotions" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "query_type", "p", "start_time", "end_time" ], "properties": { "order_type": { "description": "订单类型，0=淘宝，1=天猫，2=拼多多，3=京东,4=ele,5=美团，6=电影票 7话费 8油卡 9=肯德基 10=美团生活，11=会员卡 12=滴滴 13=电费，14=生活团购 15=唯品会", "type": [ "string", "number" ] }, "status": { "description": "订单状态 0=订单付款，1=订单结算，2=订单失效", "type": [ "string", "number" ] }, "query_type": { "description": "查询时间类型 1创建时间 2更新时间 3结算时间", "type": [ "string", "number" ] }, "page_size": { "description": "每页大小,默认20 ，最大500", "type": [ "string", "number" ] }, "p": { "description": "页数，1", "type": [ "string", "number" ] }, "start_time": { "description": "开始时间，linux时间戳10位", "type": [ "string", "number" ] }, "end_time": { "description": "结束时间，linux时间戳10位，跟开始时间相差不能超过2小时", "type": [ "string", "number" ] }, "order_ids": { "description": "订单号集合，Json格式", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "num_iid" ], "properties": { "num_iid": { "description": "商品ID", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.position-create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "merchantRequestId" ], "properties": { "number": { "description": "本应用原商户订单号；使用字符串", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.registration" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "user_tag", "pid", "merchantRequestId" ], "properties": { "user_tag": { "description": "自定义备案参数，同转链接时候的user_tag", "type": [ "string", "number" ] }, "pid": { "description": "拼多多推广位pid，需要调用创建接口生成", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.registration-status" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "pid", "user_tag" ], "properties": { "pid": { "description": "拼多多推广位pid，需要调用创建接口生成", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义备案参数，同转链接时候的user_tag", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "keyword", "page", "pid", "user_tag" ], "properties": { "keyword": { "description": "搜索关键词", "type": [ "string", "number" ] }, "page": { "description": "分页", "type": [ "string", "number" ] }, "page_size": { "description": "默认100，每页商品数量", "type": [ "string", "number" ] }, "sort_type": { "description": "排序方式:0-综合排序;1-按佣金比率升序;2-按佣金比例降序;3-按价格升序;4-按价格降序;5-按销量升序;6-按销量降序;7-优惠券金额排序升序;8-优惠券金额排序降序;9-券后价升序排序;10-券后价降序排序;11-按照加入多多进宝时间升序;12-按照加入多多进宝时间降序;13-按佣金金额升序排序;14-按佣金金额降序排序;15-店铺描述评分升序;16-店铺描述评分降序;17-店铺物流评分升序;18-店铺物流评分降序;19-店铺服务评分升序;20-店铺服务评分降序;27-描述评分击败同类店铺百分比升序，28-描述评分击败同类店铺百分比降序，29-物流评分击败同类店铺百分比升序，30-物流评分击败同类店铺百分比降序，31-服务评分击败同类店铺百分比升序，32-服务评分击败同类店铺百分比降序", "type": [ "string", "number" ] }, "with_coupon": { "description": "是否只返回优惠券的商品，1只返回有优惠券的商品", "type": [ "string", "number" ] }, "pid": { "description": "推广位，先调用创建接口创建", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义参数，同步所有接口内的user_tag，不能随便写", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.pdd.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "goods_sign", "user_tag", "pid" ], "properties": { "goods_sign": { "description": "多多进宝商品ID", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义跟踪参数，也是备案时候的user_tag，每个用户备案不能一样", "type": [ "string", "number" ] }, "zs_duo_id": { "description": "招商多多客ID", "type": [ "string", "number" ] }, "pid": { "description": "拼多多推广位，每个用户一个，需要调用拼多多备案接口进行备案", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.requests" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "id" ], "properties": { "id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.requests.recover" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。", "required": [ "id" ], "properties": { "id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.activity" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "activityId" ], "properties": { "activityId": { "description": "淘宝活动ID，如双十一会场，ID：20150318020007201", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-activity" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "activityId", "adzoneId", "siteId" ], "properties": { "activityId": { "description": "官方活动会场ID，从淘宝客后台“我要推广-活动推广”中获取", "type": [ "string", "number" ] }, "adzoneId": { "description": "mm_xxx_xxx_xxx的第3段数字", "type": [ "string", "number" ] }, "siteId": { "description": "mm_xxx_xxx_xxx的第2段数字", "type": [ "string", "number" ] }, "r_id": { "description": "渠道关系id", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-member-mark" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "external_id", "external_type", "op_type", "redirect_url", "merchantRequestId" ], "properties": { "external_id": { "description": "淘宝客自有私域用户自定义标记，如自有私域系统账号标记等", "type": [ "string", "number" ] }, "external_type": { "description": "淘宝客其他平台私域用户自定义标记，1-微信、2-微博、3-抖音、4-快手、5-QQ，0-其他", "type": [ "string", "number" ] }, "op_type": { "description": "授权类型，选2时可用于更新外部用户标记，默认1：1-新绑，2-更新", "type": [ "string", "number" ] }, "redirect_url": { "description": "会员备案授权后，跳转的目标页地址", "type": [ "string", "number" ] }, "ucrowd_id": { "description": "人群标签ID，用户备案授权后会自动添加到该人群", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-orders" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "query_type", "end_time", "start_time", "page_no", "order_scene" ], "properties": { "query_type": { "description": "查询时间类型，1：按照订单淘客创建时间查询，2:按照订单淘客付款时间查询，3:按照订单淘客结算时间查询，4:按照订单更新时间；", "type": [ "string", "number" ] }, "position_index": { "description": "位点，除第一页之外，都需要传递；前端原样返回。", "type": [ "string", "number" ] }, "page_size": { "description": "页大小，默认20，1~100", "type": [ "string", "number" ] }, "member_type": { "description": "推广者角色类型,2:二方，3:三方，不传，表示所有角色", "type": [ "string", "number" ] }, "tk_status": { "description": "淘客订单状态，12-付款，13-关闭，14-确认收货，3-结算成功;不传，表示所有状态", "type": [ "string", "number" ] }, "end_time": { "description": "订单查询结束时间，订单开始时间至订单结束时间，中间时间段日常要求不超过3个小时，但如618、双11、年货节等大促期间预估时间段不可超过20分钟，超过会提示错误，调用时请务必注意时间段的选择，以保证亲能正常调用！", "type": [ "string", "number" ] }, "start_time": { "description": "订单查询开始时间", "type": [ "string", "number" ] }, "jump_type": { "description": "跳转类型，当向前或者向后翻页必须提供,-1: 向前翻页,1：向后翻页", "type": [ "string", "number" ] }, "page_no": { "description": "第几页，默认1，1~100", "type": [ "string", "number" ] }, "order_scene": { "description": "场景订单场景类型，1:常规订单，2:渠道订单，3:会员运营订单，默认为1", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-parse" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "content", "pid" ], "properties": { "content": { "description": "查找的内容 ，如 点击复制按钮打开 →手?掏APP←即可领优惠券 ---------蝮?制----- ☑hl8k2EikPT8￥:/", "type": [ "string", "number" ] }, "pid": { "description": "推广位", "type": [ "string", "number" ] }, "r_id": { "description": "渠道ID", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-registration" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "inviter_code", "info_type", "merchantRequestId" ], "properties": { "inviter_code": { "description": "淘宝客邀请渠道或会员的邀请码", "type": [ "string", "number" ] }, "info_type": { "description": "类型，必选 默认为1:", "type": [ "string", "number" ] }, "offline_scene": { "description": "渠道备案 - 线下场景信息，1 - 门店，2- 学校，3 - 工厂，4 - 其他", "type": [ "string", "number" ] }, "online_scene": { "description": "渠道备案 - 线上场景信息，1 - 微信群，2- QQ群，3 - 其他", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-registration-info" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "relation_id", "page_no", "page_size", "info_type", "relation_app" ], "properties": { "relation_id": { "description": "渠道ID", "type": [ "string", "number" ] }, "page_no": { "description": "页数", "type": [ "string", "number" ] }, "page_size": { "description": "每页大小", "type": [ "string", "number" ] }, "info_type": { "description": "类型，必选 1:渠道信息；2:会员信息", "type": [ "string", "number" ] }, "relation_app": { "description": "备案的场景：common（通用备案），etao（一淘备案），minietao（一淘小程序备案），offlineShop（线下门店备案），offlinePerson（线下个人备案）。如不填默认common。查询会员信息只需填写common即可", "type": [ "string", "number" ] }, "special_id": { "description": "会员独占 - 会员运营ID", "type": [ "string", "number" ] }, "external_id": { "description": "淘宝客外部用户标记，如自身系统账户ID；微信ID等", "type": [ "string", "number" ] }, "external_type": { "description": "1-微信、2-微博、3-抖音、4-快手、5-QQ，0-其他；默认为0", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.authorized-transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "pid", "r_id", "material_list", "biz_scene_id" ], "properties": { "pid": { "description": "推广位ID", "type": [ "string", "number" ] }, "r_id": { "description": "渠道管理ID（如是主站选品推广场景，必须入参该字段，且bizSceneId字段需入参2-消费者比价场景，否则二次转链失败）", "type": [ "string", "number" ] }, "material_list": { "description": "物料列表，可以为url或淘口令,多个时使用英文逗号拼接传入", "type": [ "string", "number" ] }, "biz_scene_id": { "description": "1-动态ID转链场景，2-消费者比价场景", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "num_iid" ], "properties": { "num_iid": { "description": "淘宝联盟商品ID", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.position-create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "r_id", "merchantRequestId" ], "properties": { "name": { "description": "渠道名称", "type": [ "string", "number" ] }, "channel_id": { "description": "微客云渠道ID，获取方式：https://open.wikeyun.cn/#/document/1/article/309", "type": [ "string", "number" ] }, "r_id": { "description": "淘宝渠道ID，checkRelationReg接口返回", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.rank" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "page", "pageSize" ], "properties": { "page": { "description": "页数", "type": [ "string", "number" ] }, "pageSize": { "description": "每页条数", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.registration" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "rtag", "merchantRequestId" ], "properties": { "rtag": { "description": "自定义参数。", "type": [ "string", "number" ] }, "merchantRequestId": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.registration-status" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "info_type", "page_no", "page_size" ], "properties": { "info_type": { "description": "类型，必选 1:渠道信息；2:会员信息", "type": [ "string", "number" ] }, "page_no": { "description": "第几页，下标从0开始", "type": [ "string", "number" ] }, "page_size": { "description": "每页大小", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "keyword" ], "properties": { "pid": { "description": "推广位，授权版传递自己联盟的PID", "type": [ "string", "number" ] }, "page": { "description": "页数", "type": [ "string", "number" ] }, "pageSize": { "description": "每页个数", "type": [ "string", "number" ] }, "keyword": { "description": "搜索词", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.taobao.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "material_list", "r_id" ], "properties": { "material_list": { "description": "物料列表，可以为url或淘口令,多个时使用英文逗号拼接传入", "type": [ "string", "number" ] }, "r_id": { "description": "渠道ID，备案获得", "type": [ "string", "number" ] }, "biz_scene_id": { "description": "1-动态ID转链场景，2-消费者比价场景", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.waimai.categories" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "business_line", "act_id" ], "properties": { "business_line": { "description": "联盟业务线ID", "type": [ "string", "number" ] }, "act_id": { "description": "联盟活动ID", "type": [ "string", "number" ] }, "p": { "description": "分页参数，页码，默认为1", "type": [ "string", "number" ] }, "page_size": { "description": "分页参数，页长，默认为20，最大为100", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.waimai.cities" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "business_line" ], "properties": { "business_line": { "description": "联盟业务线类型", "type": [ "string", "number" ] }, "p": { "description": "分页参数，页码，默认为1", "type": [ "string", "number" ] }, "page_size": { "description": "分页参数，页长，默认为20，最大为100", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.waimai.products" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "business_line", "act_id" ], "properties": { "business_line": { "description": "联盟业务线ID", "type": [ "string", "number" ] }, "act_id": { "description": "联盟活动ID", "type": [ "string", "number" ] }, "category_id": { "description": "商品类目ID", "type": [ "string", "number" ] }, "city_id": { "description": "城市ID", "type": [ "string", "number" ] }, "p": { "description": "分页参数，页码，默认为1", "type": [ "string", "number" ] }, "page_size": { "description": "分页参数，页长，默认为20，最大为100", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.waimai.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "linkType", "activityId", "user_tag" ], "properties": { "linkType": { "description": "链接类型 1 h5链接 2 deeplink(唤起)链接 3 中间页唤起链接 4 微信小程序唤起路径 5 团口令", "type": [ "string", "number" ] }, "shortLink": { "description": "是否缩短 0 否 1是", "type": [ "string", "number" ] }, "activityId": { "description": "活动列表activity_id", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义标示", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.wph.detail" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "num_iid" ], "properties": { "num_iid": { "description": "唯品会商品id", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.wph.search" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "page", "keyword", "order" ], "properties": { "page": { "description": "页数", "type": [ "string", "number" ] }, "keyword": { "description": "搜索关键词", "type": [ "string", "number" ] }, "order": { "description": "排序顺序：0-正序，1-逆序，默认正序", "type": [ "string", "number" ] }, "priceStart": { "description": "价格区间", "type": [ "string", "number" ] }, "priceEnd": { "description": "价格区间", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "wikeyun.wph.transform" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "required": [ "item_urls" ], "properties": { "item_urls": { "description": "商品url，多个逗号分隔。", "type": [ "string", "number" ] }, "user_tag": { "description": "自定义参数", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.estimate" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "city_code", "start_lng", "start_lat", "start_addr", "end_lng", "end_lat", "end_addr", "service_type", "departure_time" ], "properties": { "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_addr": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_addr": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "service_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ride_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "approach_point_list": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.nearby" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "lng", "lat", "radius" ], "properties": { "lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "radius": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ride_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.bill" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.cancel" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId", "idempotencyKey" ], "properties": { "cancel_reason": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.cancel-fee" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.create" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "start_lng", "start_lat", "start_name", "end_lng", "end_lat", "end_name", "estimate_id", "passenger_mobile", "service_type", "ride_type", "city_code", "merchantOrderId" ], "properties": { "start_lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_lng": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_lat": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_mobile": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "service_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ride_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_addr": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_addr": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "start_poiid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "end_poiid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "user_mobile": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_virtual_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_country_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_uid": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "driver_message": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "support_link_order": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "support_im": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "fixed_price": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "change_cabin": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "approach_point_list": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.decision" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "strive_status", "merchantOrderId", "idempotencyKey" ], "properties": { "strive_status": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "passenger_phone": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "strive_fail_reason": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.driver-position" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.evaluate" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "score", "merchantOrderId", "idempotencyKey" ], "properties": { "score": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "content": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "label_name": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "label_ids": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.events" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.notify-payment" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "pay_status", "pay_amount", "merchantOrderId", "idempotencyKey" ], "properties": { "pay_status": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "pay_amount": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "derate_fee": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "premium_fee": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "idempotencyKey": { "description": "本次业务操作的幂等键；结果未知时不得更换键重试", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.plan-track" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "track_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.query" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.recover" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId", "supplierOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] }, "supplierOrderId": { "description": "仅用于原订单身份恢复，须先核对来源", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.orders.track" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yangguang.price-rule" }, "params": { "type": "object", "description": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。", "required": [ "service_type" ], "properties": { "service_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "ride_type": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "city_code": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "estimate_id": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] }, "departure_time": { "description": "业务字段，保持原接口含义", "type": [ "string", "number" ] } }, "additionalProperties": true } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.catalogs" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [], "properties": {}, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.orders.create" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [ "merchantOrderId", "commodityId", "buyCount", "template" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": "string" }, "commodityId": { "description": "运营确认的商品规格 ID；禁止自行改用主商品 ID", "type": "integer" }, "buyCount": { "description": "购买数量，1—9999 的整数", "type": "integer" }, "template": { "description": "按运营为该商品确认的模板顺序填写字符串数组，最多 16 项；每项非空、UTF-8 最多 4096 字节且不含 NUL/换行。数组长度必须等于该商品已配置的 templateCount，顺序及业务含义由该商品模板决定。仅 templateCount=0 时使用空数组；不要自行 URL 编码，服务端逐项编码。", "type": "array", "maxItems": 16, "items": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[^\\u0000\\r\\n]+$", "description": "第 N 个已确认模板字段的原始值；位置、类型含义和长度须按当前商品模板核对。" } } }, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.orders.funds" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": "string" } }, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.orders.logistics" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [ "merchantOrderId" ], "properties": { "merchantOrderId": { "description": "本应用的商户原订单号；必须保持同一业务键重试或查单", "type": "string" } }, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.orders.query" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [ "number" ], "properties": { "number": { "description": "本应用原商户订单号；使用字符串", "type": "string" } }, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.products" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [], "properties": { "page": { "description": "页码，默认 1，1—1000000", "type": "integer" }, "size": { "description": "每页数量，默认 60，1—200", "type": "integer" }, "catalogId": { "description": "分组 ID，默认 0；0 表示未指定分组", "type": "integer" }, "name": { "description": "可选商品名筛选，最多 256 字节", "type": "string" } }, "additionalProperties": false } } }, { "type": "object", "additionalProperties": false, "required": [ "version", "operation", "params" ], "properties": { "version": { "const": "1.0" }, "operation": { "const": "yiqida.products.detail" }, "params": { "type": "object", "description": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。", "required": [ "id" ], "properties": { "id": { "description": "供应商商品详情 ID；正整数，最大 9007199254740991", "type": "integer" } }, "additionalProperties": false } } } ] }, "Response": { "type": "object", "additionalProperties": false, "required": [ "version", "requestId", "operation", "provider", "success", "code", "message", "data", "mock" ], "properties": { "version": { "type": "string", "enum": [ "1.0" ] }, "requestId": { "type": "string" }, "operation": { "type": "string" }, "provider": { "type": "string" }, "success": { "type": "boolean" }, "code": { "type": "string", "enum": [ "OK", "INVALID_REQUEST", "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND", "METHOD_NOT_ALLOWED", "CONFLICT", "PAYLOAD_TOO_LARGE", "UNSUPPORTED_MEDIA_TYPE", "RATE_LIMITED", "INTERNAL_ERROR", "UNAVAILABLE", "UPSTREAM_ERROR", "UPSTREAM_TIMEOUT", "UPSTREAM_REJECTED", "OUTCOME_UNKNOWN", "API_OPERATION_NOT_GRANTED", "API_AUTHORIZATION_DISABLED", "API_AUTHORIZATION_EXPIRED", "API_CONCURRENCY_LIMIT" ] }, "message": { "type": "string" }, "data": {}, "mock": { "type": [ "boolean", "null" ] }, "upstream": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string" } }, "additionalProperties": false } } } } }, "servers": [ { "url": "https://www.yishuld.com", "description": "当前对接地址；不是全模拟沙箱，具体环境由运营分配" } ], "x-public-operations": [ { "operation": "beidou.orders.create", "provider": "beidou", "providerLabel": "北斗充值", "category": "话费充值", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "mobile", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "price", "type": "string", "required": true, "description": "面值字符串，需先查询可售商品" }, { "name": "payType", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "clientIp", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "wapUrl", "type": "string", "required": true, "description": "已报备的 HTTPS 商户回跳地址" }, { "name": "outUserId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "productName", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "mobile": "REPLACE_mobile", "price": "REPLACE_price", "payType": "REPLACE_payType", "clientIp": "REPLACE_clientIp", "wapUrl": "REPLACE_wapUrl" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "beidou.orders.page", "provider": "beidou", "providerLabel": "北斗充值", "category": "话费充值", "title": "订单 · 分页查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "pageNumber", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "pageSize", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "mobile", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "payType", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "payStatus", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "beidou.orders.status", "provider": "beidou", "providerLabel": "北斗充值", "category": "话费充值", "title": "订单 · 状态查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "number", "type": "string", "required": true, "description": "本应用原商户订单号；使用字符串" } ], "example": { "number": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "beidou.products", "provider": "beidou", "providerLabel": "北斗充值", "category": "话费充值", "title": "商品查询", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.capabilities", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "叫车能力状态", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.cities", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "城市列表", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.city-code", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "城市编码", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "longitude": "REPLACE_longitude", "latitude": "REPLACE_latitude" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.estimate", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "费用预估", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "from_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "from_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "car_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "passenger_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_tags", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "carpool_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "count_person", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "waypointList", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "route_strategy", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "from_longitude": "REPLACE_from_longitude", "from_latitude": "REPLACE_from_latitude", "to_longitude": "REPLACE_to_longitude", "to_latitude": "REPLACE_to_latitude", "car_type": "REPLACE_car_type", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.extended.complaintOrder", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · complaintOrder", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "content", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "content": "REPLACE_content", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.11complain.html" }, { "operation": "caocao.extended.confirmReceiveOrder", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · confirmReceiveOrder", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "confirm_receive_time", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "caller_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_name", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_hide_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "confirm_receive_time": "REPLACE_confirm_receive_time", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.16confirmReceiveOrder.html" }, { "operation": "caocao.extended.evaluateOrder", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · evaluateOrder", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "score", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "content", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "score": "REPLACE_score", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.10customerEvaluate.html" }, { "operation": "caocao.extended.getDriverVirtualPhone", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · getDriverVirtualPhone", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.19getDriverVirtualPhone.html" }, { "operation": "caocao.extended.midChooseRoute", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · midChooseRoute", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "a_map_route_id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "a_map_route_id": "REPLACE_a_map_route_id", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.32midChooseRoute.html" }, { "operation": "caocao.extended.modifyBookingOrder", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · modifyBookingOrder", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "modify_reason", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "new_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "new_use_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "modify_reason": "REPLACE_modify_reason", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.25modifyBookingOrder.html" }, { "operation": "caocao.extended.modifyEndLocation", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · modifyEndLocation", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "end_location", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "lg", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "lt", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "waypointList", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "end_location": "REPLACE_end_location", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.18modifyEndLocation.html" }, { "operation": "caocao.extended.modifyEndLocationV2", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · modifyEndLocationV2", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "modify", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_location", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "lg", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "lt", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "waypointList", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "modify": "REPLACE_modify", "end_location": "REPLACE_end_location", "lg": "REPLACE_lg", "lt": "REPLACE_lt", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.18modifyEndLocation.html" }, { "operation": "caocao.extended.modifyStartLocation", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · modifyStartLocation", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "lg", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "lt", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "uid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_location", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_city_code", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_district", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_district_code", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_poiId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "lg": "REPLACE_lg", "lt": "REPLACE_lt", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.29modifyStartLocation.html" }, { "operation": "caocao.extended.queryAlternativeRoute", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryAlternativeRoute", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.31queryAlternativeRoute.html" }, { "operation": "caocao.extended.queryCalculateBill", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryCalculateBill", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.26queryCalculateBill.html" }, { "operation": "caocao.extended.queryCancelFeeRule", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryCancelFeeRule", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.30queryCancelRule.html" }, { "operation": "caocao.extended.queryDriverPolyline", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryDriverPolyline", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "navigation_polyline_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "navigation_polyline_type": "REPLACE_navigation_polyline_type", "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.27queryDriverPolyline.html" }, { "operation": "caocao.extended.queryDriverPolylineV2", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryDriverPolylineV2", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.27queryDriverPolylineV2.html" }, { "operation": "caocao.extended.queryEstimateRoute", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryEstimateRoute", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.22queryEstimateRoute.html" }, { "operation": "caocao.extended.queryJourneyShareInfo", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryJourneyShareInfo", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/8.2queryJourneyShareInfo.html" }, { "operation": "caocao.extended.queryMeterRule", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryMeterRule", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "car_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "longitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "latitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "car_type": "REPLACE_car_type", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.3queryPriceRule.html" }, { "operation": "caocao.extended.queryMeterRuleV2", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryMeterRuleV2", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "car_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "company_no", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "longitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "latitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "car_type": "REPLACE_car_type", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.17queryPriceRuleV2.html" }, { "operation": "caocao.extended.queryMidPoints", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryMidPoints", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.14queryOrderTrace.html" }, { "operation": "caocao.extended.queryNearByDriver", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryNearByDriver", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "radius", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "city_code": "REPLACE_city_code", "radius": "REPLACE_radius", "order_longitude": "REPLACE_order_longitude", "order_latitude": "REPLACE_order_latitude" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.4queryNearbyDriver.html" }, { "operation": "caocao.extended.queryPickupSpots", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "extended · queryPickupSpots", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "longitude": "REPLACE_longitude", "latitude": "REPLACE_latitude", "city_code": "REPLACE_city_code" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 商户只传 merchantOrderId（若列出），上游订单号由平台关联；扩展数值字段允许原接口的数字或字符串表示。", "reference": "https://open.caocaokeji.cn/zh-cn/docs/caocao_open/travel/2.28queryPickupSpots.html" }, { "operation": "caocao.orders.bill", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 账单查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.cancel", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 取消", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "cancel_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "cancel_reason", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "who_cancel", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "cancel_code": "REPLACE_cancel_code", "cancel_reason": "REPLACE_cancel_reason" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.cancel-fee", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 取消费查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.confirm-fee", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 确认费用", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "allowance_amount", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "cao_allowance_amount", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.create", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "from_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "from_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "car_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "caller_phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "estimate_price", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "estimate_price_key", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_address", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_address", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_longitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "to_latitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "cost_center", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_hide_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_name", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "ext_uid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "dynamic_rule_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "flight_no", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "flt_takeoff_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_longitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_latitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "sms_policy", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "extra_info", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "callback_info", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_tags", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "line_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "accept_cp_driver", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "accept_relay_order", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "carpool_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "count_person", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "waypointList", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "from_longitude": "REPLACE_from_longitude", "from_latitude": "REPLACE_from_latitude", "car_type": "REPLACE_car_type", "caller_phone": "REPLACE_caller_phone", "estimate_price": "REPLACE_estimate_price", "estimate_price_key": "REPLACE_estimate_price_key", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type", "start_name": "REPLACE_start_name", "start_address": "REPLACE_start_address", "end_name": "REPLACE_end_name", "end_address": "REPLACE_end_address", "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.driver-position", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 司机位置", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.h5", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · H5订单", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "ext_uid", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "owner", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "from_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "from_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "caller_phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "is_simultaneously_call", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "service_type_price", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_address", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_address", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "accept_relay_order", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "carpool_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "sms_policy", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "ruleId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "ext_uid": "REPLACE_ext_uid", "owner": "REPLACE_owner", "from_longitude": "REPLACE_from_longitude", "from_latitude": "REPLACE_from_latitude", "to_longitude": "REPLACE_to_longitude", "to_latitude": "REPLACE_to_latitude", "caller_phone": "REPLACE_caller_phone", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type", "start_name": "REPLACE_start_name", "end_name": "REPLACE_end_name", "is_simultaneously_call": "REPLACE_is_simultaneously_call", "service_type_price": "REPLACE_service_type_price", "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 此为专用订单模式，需按所开通模式补充业务字段；不能将查询示例用于创建订单。" }, { "operation": "caocao.orders.multi", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 多运力订单", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "from_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "from_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_longitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "to_latitude", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "caller_phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "order_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_address", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_address", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "is_simultaneously_call", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "cost_center", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "car_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_hide_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_name", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "ext_uid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "estimate_price", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "estimate_price_key", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "dynamic_rule_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "flight_no", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "flt_takeoff_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_longitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_latitude", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "sms_policy", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "extra_info", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "callback_info", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "order_tags", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "line_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "accept_cp_driver", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "accept_relay_order", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_poi_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "carpool_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "count_person", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "service_type_price", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "waypointList", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "from_longitude": "REPLACE_from_longitude", "from_latitude": "REPLACE_from_latitude", "to_longitude": "REPLACE_to_longitude", "to_latitude": "REPLACE_to_latitude", "caller_phone": "REPLACE_caller_phone", "city_code": "REPLACE_city_code", "order_type": "REPLACE_order_type", "start_name": "REPLACE_start_name", "start_address": "REPLACE_start_address", "end_name": "REPLACE_end_name", "end_address": "REPLACE_end_address", "is_simultaneously_call": "REPLACE_is_simultaneously_call", "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 此为专用订单模式，需按所开通模式补充业务字段；不能将查询示例用于创建订单。" }, { "operation": "caocao.orders.query", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "caocao.orders.recover", "provider": "caocao", "providerLabel": "曹操出行", "category": "出行服务", "title": "订单 · 原单恢复", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "supplierOrderId", "type": "string", "required": true, "description": "仅用于原订单身份恢复，须先核对来源" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "supplierOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "fliggy-ticket.products.by-ids", "provider": "fliggy-ticket", "providerLabel": "飞猪门票", "category": "景区门票", "title": "商品查询 · 按编号查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "productIds", "type": "array", "required": true, "description": "商品 ID 字符串数组，1—100 项，不重复；ID 来自商品分页查询，不传逗号拼接字符串。", "schema": { "type": "array", "minItems": 1, "maxItems": 100, "uniqueItems": true, "items": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,128}$", "description": "商品分页返回的原始商品 ID，保持字符串精度。" } } } ], "example": { "productIds": [ "REPLACE_PRODUCT_ID" ] }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "fliggy-ticket.products.detail", "provider": "fliggy-ticket", "providerLabel": "飞猪门票", "category": "景区门票", "title": "商品查询 · 详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "productId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "productId": "REPLACE_productId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "fliggy-ticket.products.page", "provider": "fliggy-ticket", "providerLabel": "飞猪门票", "category": "景区门票", "title": "商品查询 · 分页查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "pageNo", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "pageSize", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "pageNo": "1", "pageSize": "1" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "fliggy-ticket.products.price-stock", "provider": "fliggy-ticket", "providerLabel": "飞猪门票", "category": "景区门票", "title": "商品查询 · 价格库存", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "productId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "beginTime", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "endTime", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "productId": "REPLACE_productId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "haiyawan.orders.create", "provider": "haiyawan", "providerLabel": "海牙湾权益", "category": "会员权益", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "itemCode", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "account", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "totalNum", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "verifyCode", "type": "string", "required": false, "description": "不传时发送验证码，传入时校验；属于写操作" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "itemCode": "REPLACE_itemCode" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 DIRECT 商品必须传 account，不能传 totalNum；CARD 商品不能传 account，totalNum 默认 1；需要验证的商品必须带 phone 和 verifyCode。" }, { "operation": "haiyawan.orders.query", "provider": "haiyawan", "providerLabel": "海牙湾权益", "category": "会员权益", "title": "订单 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "haiyawan.verification", "provider": "haiyawan", "providerLabel": "海牙湾权益", "category": "会员权益", "title": "发送或校验验证码", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "itemCode", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "verifyCode", "type": "string", "required": false, "description": "不传时发送验证码，传入时校验；属于写操作" } ], "example": { "itemCode": "REPLACE_itemCode", "phone": "REPLACE_phone" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.catalog.detail", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "目录 · 详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "city", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkIn", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkOut", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rooms", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "hotelRef", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "enduserId": "demo-user-001", "city": "REPLACE_city", "checkIn": "2026-12-10", "checkOut": "2026-12-11", "rooms": "1", "hotelRef": "REPLACE_hotelRef" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.catalog.search", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "目录 · 搜索", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "city", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkIn", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkOut", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rooms", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "enduserId": "demo-user-001", "city": "REPLACE_city", "checkIn": "2026-12-10", "checkOut": "2026-12-11", "rooms": "1" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.check", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "验价", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "hotelId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "roomId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rateTypeId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkInDate", "type": "string", "required": true, "description": "入住日期 YYYY-MM-DD" }, { "name": "checkOutDate", "type": "string", "required": true, "description": "离店日期 YYYY-MM-DD" }, { "name": "roomCount", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "totalPrice", "type": "string", "required": true, "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分" } ], "example": { "hotelId": "REPLACE_hotelId", "roomId": "REPLACE_roomId", "rateTypeId": "REPLACE_rateTypeId", "checkInDate": "2026-12-10", "checkOutDate": "2026-12-11", "roomCount": "1", "totalPrice": "100.00" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.cities", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "城市列表", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.guests", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "入住人信息", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "commandId", "type": "string", "required": true, "description": "当前请求的稳定命令号，用于原命令恢复" }, { "name": "contactName", "type": "string", "required": true, "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。" }, { "name": "contactTel", "type": "string", "required": true, "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。" }, { "name": "guests", "type": "array", "required": true, "description": "入住人对象数组，1—20 人；每人必填 lastName 和 firstName，仅支持下表列出的字段。姓名不能包含 /、逗号或控制字符，不得有首尾空白；所有姓/名以逗号连接后的总长不超过 1024 个 UTF-16 单元。登记返回 businessDataRef，后续报价使用该引用。", "schema": { "type": "array", "minItems": 1, "maxItems": 20, "items": { "type": "object", "additionalProperties": false, "required": [ "lastName", "firstName" ], "properties": { "lastName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[^/,\\u0000-\\u001f\\u007f]+$", "description": "姓，必填；最多 64 个 UTF-16 单元，不含 /、逗号、控制字符及首尾空白。" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[^/,\\u0000-\\u001f\\u007f]+$", "description": "名，必填；最多 64 个 UTF-16 单元，不含 /、逗号、控制字符及首尾空白。" }, "fullName": { "type": "string", "description": "可选原协议全名；不能代替 lastName、firstName。仅在实际业务要求时填写。" }, "idCardNumber": { "type": "string", "description": "可选原协议证件号；仅在实际业务要求时填写，不写入终端或日志。" } } } } }, { "name": "remark", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "enduserId": "demo-user-001", "commandId": "demo-command-001", "contactName": "REPLACE_contactName", "contactTel": "REPLACE_contactTel", "guests": [ { "lastName": "REPLACE_LAST_NAME", "firstName": "REPLACE_FIRST_NAME" } ] }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.hotelIds", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "酒店编号", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "cityId": "310100" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.info", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "酒店详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "hotelId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "hotelId": "REPLACE_hotelId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.mock-orders.cancel", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "模拟订单 · 取消", "mutation": true, "sandboxOnly": true, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.mock-orders.create", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "模拟订单 · 创建", "mutation": true, "sandboxOnly": true, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "hotelId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "roomId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rateTypeId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkInDate", "type": "string", "required": true, "description": "入住日期 YYYY-MM-DD" }, { "name": "checkOutDate", "type": "string", "required": true, "description": "离店日期 YYYY-MM-DD" }, { "name": "roomCount", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "totalPrice", "type": "string", "required": true, "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分" }, { "name": "contactName", "type": "string", "required": true, "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。" }, { "name": "contactTel", "type": "string", "required": true, "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。" }, { "name": "orderGuests", "type": "string", "required": true, "description": "原酒店订单协议的入住人字符串：姓/名，多人用英文逗号分隔，总长最多 1024 个 UTF-16 单元；不要与 hotel.guests 的 guests 对象数组混用。" }, { "name": "remark", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "mockScenario", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "hotelId": "REPLACE_hotelId", "roomId": "REPLACE_roomId", "rateTypeId": "REPLACE_rateTypeId", "checkInDate": "2026-12-10", "checkOutDate": "2026-12-11", "roomCount": "1", "totalPrice": "100.00", "contactName": "REPLACE_contactName", "contactTel": "REPLACE_contactTel", "orderGuests": "REPLACE_LAST_NAME/REPLACE_FIRST_NAME" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.mock-orders.query", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "模拟订单 · 查询", "mutation": false, "sandboxOnly": true, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.orders.cancel", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "订单 · 取消", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.orders.create", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "hotelId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "roomId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rateTypeId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkInDate", "type": "string", "required": true, "description": "入住日期 YYYY-MM-DD" }, { "name": "checkOutDate", "type": "string", "required": true, "description": "离店日期 YYYY-MM-DD" }, { "name": "roomCount", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "totalPrice", "type": "string", "required": true, "description": "原接口金额格式，使用十进制字符串；不能擅自把元改成分" }, { "name": "contactName", "type": "string", "required": true, "description": "联系人姓名，非空，最多 128 个 UTF-16 单元。" }, { "name": "contactTel", "type": "string", "required": true, "description": "联系人电话字符串，6—32 个字符，首位为 + 或数字，后续仅数字、空格或短横线。" }, { "name": "orderGuests", "type": "string", "required": true, "description": "原酒店订单协议的入住人字符串：姓/名，多人用英文逗号分隔，总长最多 1024 个 UTF-16 单元；不要与 hotel.guests 的 guests 对象数组混用。" }, { "name": "remark", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "hotelId": "REPLACE_hotelId", "roomId": "REPLACE_roomId", "rateTypeId": "REPLACE_rateTypeId", "checkInDate": "2026-12-10", "checkOutDate": "2026-12-11", "roomCount": "1", "totalPrice": "100.00", "contactName": "REPLACE_contactName", "contactTel": "REPLACE_contactTel", "orderGuests": "REPLACE_LAST_NAME/REPLACE_FIRST_NAME" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.orders.draft", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "订单 · 创建草稿", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "quoteId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "commandId", "type": "string", "required": true, "description": "当前请求的稳定命令号，用于原命令恢复" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "enduserId": "demo-user-001", "quoteId": "REPLACE_quoteId", "commandId": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.orders.pay", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "订单 · 支付处理", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "commandId", "type": "string", "required": true, "description": "当前请求的稳定命令号，用于原命令恢复" }, { "name": "fundingSource", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "expectedAmountCents", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "enduserId": "demo-user-001", "commandId": "demo-command-001", "fundingSource": "REPLACE_fundingSource", "expectedAmountCents": "REPLACE_expectedAmountCents" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.orders.query", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "订单 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.payments.query", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "支付 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "paymentId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "enduserId": "demo-user-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.prices", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "报价查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "hotelId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkInDate", "type": "string", "required": true, "description": "入住日期 YYYY-MM-DD" }, { "name": "checkOutDate", "type": "string", "required": true, "description": "离店日期 YYYY-MM-DD" }, { "name": "roomId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "rateTypeId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "hotelId": "REPLACE_hotelId", "checkInDate": "2026-12-10", "checkOutDate": "2026-12-11" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "hotel.quotes", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "取得报价", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "commandId", "type": "string", "required": true, "description": "当前请求的稳定命令号，用于原命令恢复" }, { "name": "city", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkIn", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "checkOut", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "rooms", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "hotelRef", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "roomRef", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "productRef", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "businessDataRef", "type": "string", "required": true, "description": "由入住人信息登记返回的引用，不能自行拼造" } ], "example": { "enduserId": "demo-user-001", "commandId": "demo-command-001", "city": "REPLACE_city", "checkIn": "2026-12-10", "checkOut": "2026-12-11", "rooms": "1", "hotelRef": "REPLACE_hotelRef", "roomRef": "REPLACE_roomRef", "productRef": "REPLACE_productRef", "businessDataRef": "REPLACE_businessDataRef" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "hotel.quotes.recovery", "provider": "hotel", "providerLabel": "酒店", "category": "酒店住宿", "title": "取得报价 · 原命令恢复", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "enduserId", "type": "string", "required": true, "description": "当前应用可信用户标识，由商户服务端核验" }, { "name": "commandId", "type": "string", "required": true, "description": "当前请求的稳定命令号，用于原命令恢复" } ], "example": { "enduserId": "demo-user-001", "commandId": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 该流程还需运营绑定酒店交易接入配置；业务引用须由上一步接口返回，禁止自行构造。" }, { "operation": "laiyipiao.apis", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "apis", "title": "apis", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.brand-cake.brands", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "brand-cake", "title": "brand-cake · brands", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "cityId": "310100" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.brand-cake.categories", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "brand-cake", "title": "brand-cake · categories", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.brand-cake.cities", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "brand-cake", "title": "brand-cake · 城市列表", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.brand-cake.products", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "brand-cake", "title": "brand-cake · 商品查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "pageNum", "type": "integer", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "pageSize", "type": "integer", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "brandId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "groupId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "keyword", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "cityId": "310100", "pageNum": "REPLACE_pageNum", "pageSize": "1" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.cake-delivery.products", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "cake-delivery", "title": "cake-delivery · 商品查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "productName", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "productSpu", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "productClassifyName", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.flowers.categories", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "flowers", "title": "flowers · categories", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.flowers.products", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "flowers", "title": "flowers · 商品查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "productClassifyName", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "productName", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "productSpu", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "productClassifyName": "REPLACE_productClassifyName" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.food.cities", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "food", "title": "food · 城市列表", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.food.menu", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "food", "title": "food · menu", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "brand", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "storeCode", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "storeId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "shopId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "cityId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "delivery", "type": "boolean", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "orderType", "type": "integer", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "brand": "REPLACE_brand" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.food.stores", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "food", "title": "food · stores", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "brand", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "brand": "REPLACE_brand", "cityId": "310100" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.movie.cinemas", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "movie", "title": "movie · cinemas", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "version", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "districtId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "brandId", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "lat", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "lng", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "version": "REPLACE_version", "cityId": "310100" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.movie.cities", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "movie", "title": "movie · 城市列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "version", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "version": "REPLACE_version" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "laiyipiao.movie.movies", "provider": "laiyipiao", "providerLabel": "商联百通", "category": "movie", "title": "movie · movies", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "version", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "cityId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "version": "REPLACE_version", "cityId": "310100" }, "notes": "仅查询目录；供应方签名和生产凭据由网关注入。城市、门店和商品编号须来自同一业务的实际查询结果。点餐菜单按品牌校验字段，delivery 为布尔值，orderType 为整数；没有下单、支付或退款操作。" }, { "operation": "qianhang.orders.confirm", "provider": "qianhang", "providerLabel": "千行充值", "category": "话费充值", "title": "订单 · 确认提交", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "productId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "carrier", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "face", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "smsCode", "type": "string", "required": true, "description": "短信验证码；仅发送至接口，不记录到日志" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "productId": "REPLACE_productId", "phone": "REPLACE_phone", "carrier": "REPLACE_carrier", "face": "REPLACE_face", "smsCode": "REPLACE_smsCode" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "qianhang.orders.identity", "provider": "qianhang", "providerLabel": "千行充值", "category": "话费充值", "title": "订单 · 原单身份", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "number", "type": "string", "required": true, "description": "本应用原商户订单号；使用字符串" } ], "example": { "number": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "qianhang.orders.sms", "provider": "qianhang", "providerLabel": "千行充值", "category": "话费充值", "title": "订单 · 发送验证码", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "productId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "carrier", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "face", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "productId": "REPLACE_productId", "phone": "REPLACE_phone", "carrier": "REPLACE_carrier", "face": "REPLACE_face" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "qianhang.orders.status", "provider": "qianhang", "providerLabel": "千行充值", "category": "话费充值", "title": "订单 · 状态查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "number", "type": "string", "required": true, "description": "本应用原商户订单号；使用字符串" } ], "example": { "number": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "qianhang.products", "provider": "qianhang", "providerLabel": "千行充值", "category": "话费充值", "title": "商品查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "phone", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "category", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "phone": "REPLACE_phone" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "tengfullpay.account.balance", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "查询可提现余额", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "reference": "https://www.showdoc.cc/tengfullpay/9801684530072349" }, { "operation": "tengfullpay.account.withdraw", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "D0提现", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "draw_amount", "type": "string", "required": true, "description": "单位：元，小数位保留到分" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "draw_amount": "REPLACE_draw_amount", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/9801686894066550" }, { "operation": "tengfullpay.apis", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "apis", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "tengfullpay.bills.account", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "账户对账单下单", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "bill_date", "type": "string", "required": true, "description": "日期格式：2025-03-25" }, { "name": "bill_type", "type": "string", "required": true, "description": "账单类型 TRANSFER-转账账单 WITHDRAW-提现账单" } ], "example": { "bill_date": "REPLACE_bill_date", "bill_type": "REPLACE_bill_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "reference": "https://www.showdoc.cc/tengfullpay/11558698793320933" }, { "operation": "tengfullpay.bills.fund", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "资金账单下载", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "bill_date", "type": "string", "required": true, "description": "日期格式：2025-03-25" } ], "example": { "bill_date": "REPLACE_bill_date" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "reference": "https://www.showdoc.cc/tengfullpay/11558689956886144" }, { "operation": "tengfullpay.bills.settlement", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "结算对账单下载", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "bill_date", "type": "string", "required": true, "description": "日期格式：2025-03-25" } ], "example": { "bill_date": "REPLACE_bill_date" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "reference": "https://www.showdoc.cc/tengfullpay/11558747237587575" }, { "operation": "tengfullpay.bills.trade", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "对账单下载", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "bill_date", "type": "string", "required": true, "description": "日期格式：2025-03-25" } ], "example": { "bill_date": "REPLACE_bill_date" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 data 返回 contentBase64、原始字节数和 sha256；按原编码保存 CSV。读取限 2 MiB，超限需供应商/运营处理。", "reference": "https://www.showdoc.cc/tengfullpay/11558676888540625" }, { "operation": "tengfullpay.payments.bill", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "账单支付", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_id", "type": "string", "required": true, "description": "商户订单号" }, { "name": "money", "type": "string", "required": true, "description": "订单的资金总额，单位：分" }, { "name": "valid_date", "type": "string", "required": false, "description": "超过此时间后，订单不能再进行支付 格式：2022-12-31 23:59:59" }, { "name": "terminal_sn", "type": "string", "required": true, "description": "终端编号" }, { "name": "terminal_type", "type": "string", "required": true, "description": "终端类型（目前只支持SPOS） SPOS-智能POS" }, { "name": "order_desc", "type": "string", "required": false, "description": "订单描述，展示到收银终端订单信息界面" }, { "name": "order_link", "type": "string", "required": false, "description": "支持浏览器的设备，可以点击链接查看订单详情" }, { "name": "extra_data", "type": "string", "required": false, "description": "附加信息，订单同步时会原样带回" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "order_id": "REPLACE_order_id", "money": "REPLACE_money", "terminal_sn": "REPLACE_terminal_sn", "terminal_type": "REPLACE_terminal_type", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/9813315721070582" }, { "operation": "tengfullpay.payments.close", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "订单关闭", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "time", "type": "string", "required": false, "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填" }, { "name": "order_id", "type": "string", "required": true, "description": "商户系统订单号" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "order_id": "REPLACE_order_id", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/11558551337650415" }, { "operation": "tengfullpay.payments.create", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "统一下单支付", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "shop_no", "type": "string", "required": false, "description": "如果区分门店订单，上送支付后台给门店分配的编号，如：100101" }, { "name": "pay_type", "type": "string", "required": true, "description": "微信扫码：wxqrcode； 微信公众号/小程序：wxwap； 微信被扫：wxbeiqrcode； 支付宝扫码：aliqrcode； 支付宝JS：aliwap； 支付宝被扫：alibeiqrcode； 银联JS支付：ylwap； 银联被扫：yltakeout； 银联扫码：yltakein； [代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式支持下列支付方式： 微信H5：wxhtml； 支付宝H5：alihtml； 微信APP：wxapp； 支付宝APP：aliapp； " }, { "name": "money", "type": "string", "required": true, "description": "订单的资金总额，单位：分" }, { "name": "is_mp", "type": "string", "required": false, "description": "如果是小程序支付，赋值为1 不是小程序支付，不传或者赋值为0 小程序[代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式，赋值为2" }, { "name": "order_id", "type": "string", "required": true, "description": "确保唯一,长度不超过32，尽量随机生成，例如：MD5(随机字符串+时间戳+随机字符串)" }, { "name": "valid_time", "type": "string", "required": false, "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）" }, { "name": "commodity_name", "type": "string", "required": false, "description": "商品名称" }, { "name": "sub_appid", "type": "string", "required": false, "description": "微信公众号 支付宝服务窗 微信小程序 支付宝小程序 上述支付场景需要上送对应的AppID(应用ID)" }, { "name": "authcode", "type": "string", "required": false, "description": "用户出示付款码支付场景下使用，值为用户的付款码解析后的数字串" }, { "name": "sub_openid", "type": "string", "required": false, "description": "微信上传用户openid； 支付宝上传用户buyer_id； 获取方式详见微信或支付宝文档；" }, { "name": "addip", "type": "string", "required": true, "description": "获取消费者当前ip" }, { "name": "terminal_id", "type": "string", "required": false, "description": "自定义终端编号，如：100101" }, { "name": "order_notes", "type": "string", "required": false, "description": "订单备注" }, { "name": "extra", "type": "string", "required": false, "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22" }, { "name": "share_order_type", "type": "string", "required": false, "description": "0-不需要分账 1-需要分账 默认为0" }, { "name": "return_url", "type": "string", "required": false, "description": "[代理支付](https://www.showdoc.com.cn/2184913406682025/11558569121592928)模式使用 H5模式，上送值为微信H5支付方式页面回跳地址 支付宝APP模式，上送值为返回商户APP的Schema" }, { "name": "extend_params", "type": "string", "required": false, "description": "可选原生通道参数对象编码一次后的 JSON 字符串，不直接传对象。具体字段由已开通的微信、支付宝或银联通道协议决定；不要自行猜测。未要求原生参数时省略该字段。", "schema": { "type": "string", "contentMediaType": "application/json", "contentSchema": { "type": "object" } } }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "pay_type": "REPLACE_pay_type", "money": "REPLACE_money", "order_id": "REPLACE_order_id", "addip": "REPLACE_addip", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/9801418644787103" }, { "operation": "tengfullpay.payments.face-auth", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "获取刷脸付调用凭证", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "raw_data", "type": "string", "required": true, "description": "由微信人脸SDK的getWxpayfaceRawdata接口返回" }, { "name": "device_id", "type": "string", "required": true, "description": "由商户定义，与终端一一对应" }, { "name": "store_id", "type": "string", "required": false, "description": "由商户定义， 各门店唯一" }, { "name": "store_name", "type": "string", "required": false, "description": "由商户定义" } ], "example": { "raw_data": "REPLACE_raw_data", "device_id": "REPLACE_device_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "reference": "https://www.showdoc.cc/tengfullpay/11558629644241886" }, { "operation": "tengfullpay.payments.qrcode", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "聚合码支付", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "money", "type": "string", "required": true, "description": "订单的资金总额，单位：分" }, { "name": "order_id", "type": "string", "required": true, "description": "确保唯一,长度不超过32，尽量随机生成，例如：MD5(随机字符串+时间戳+随机字符串)" }, { "name": "valid_time", "type": "string", "required": false, "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）" }, { "name": "terminal_id", "type": "string", "required": false, "description": "自定义终端编号，如：100101" }, { "name": "commodity_name", "type": "string", "required": false, "description": "商品名称" }, { "name": "extra", "type": "string", "required": false, "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22" }, { "name": "share_order_type", "type": "string", "required": false, "description": "0-不需要分账 1-需要分账 默认为0" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "money": "REPLACE_money", "order_id": "REPLACE_order_id", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/9801537315481488" }, { "operation": "tengfullpay.payments.query", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "订单查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "time", "type": "string", "required": false, "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填" }, { "name": "order_id", "type": "string", "required": true, "description": "商户系统订单号" }, { "name": "order_type", "type": "string", "required": false, "description": "0-普通订单 1-[账单支付](https://www.showdoc.com.cn/tengfullpay/9813315721070582)订单 不传默认为普通订单" } ], "example": { "order_id": "REPLACE_order_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。", "reference": "https://www.showdoc.cc/tengfullpay/9801548250281568" }, { "operation": "tengfullpay.payments.refund", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "订单退款", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_id", "type": "string", "required": true, "description": "商户交易单号" }, { "name": "refund_no", "type": "string", "required": true, "description": "商户平台生成的退款单号" }, { "name": "time", "type": "string", "required": false, "description": "原支付下单秒级 Unix 时间戳；中台已登记原单时自动取原值，历史订单必填" }, { "name": "refund_money", "type": "string", "required": true, "description": "退款金额，不能大于订单金额 单位：分" }, { "name": "divide_refund_details", "type": "string", "required": false, "description": "可选 JSON 数组编码一次后的字符串；仅通道确认支持指定分账退款时使用。1—100 项，各项字段见下表；amount 单位为分，不得套用分账的元单位。", "schema": { "type": "string", "contentMediaType": "application/json", "contentSchema": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "object", "additionalProperties": false, "required": [ "refund_mch" ], "properties": { "refund_mch": { "type": [ "string", "integer" ], "pattern": "^[0-9]{1,32}$", "minimum": 0, "description": "实际退款商户号，1—32 位数字，建议字符串。" }, "amount": { "type": [ "string", "integer" ], "pattern": "^[1-9][0-9]{0,11}$", "minimum": 1, "maximum": 999999999999, "description": "可选指定退款金额，单位分，1—12 位正整数；不是元。" }, "receiver_order_no": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,32}$", "description": "可选原接收方订单号，来源必须核对原业务。" }, "refund_account": { "type": "string", "enum": [ "DIVIDE_ACCOUNT" ], "description": "可选指定分账账户；当前仅支持 DIVIDE_ACCOUNT。" } } } } } }, { "name": "username", "type": "string", "required": false, "description": "退款操作人员" }, { "name": "remark", "type": "string", "required": false, "description": "退款操作者备注" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "order_id": "REPLACE_order_id", "refund_no": "REPLACE_refund_no", "refund_money": "REPLACE_refund_money", "merchantRequestId": "REPLACE_merchantRequestId", "divide_refund_details": "[{\"refund_mch\":\"REPLACE_REFUND_MCH\",\"amount\":\"1\",\"refund_account\":\"DIVIDE_ACCOUNT\"}]" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 原单已由中台创建时自动取原下单 time；历史订单必须补原下单 Unix 秒时间戳，不做时区偏移。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。 refund_no 为强制稳定退款单号；查询响应中的金额为元，文档样例存在矛盾，禁止猜测换算入账。", "reference": "https://www.showdoc.cc/tengfullpay/9801555053415675" }, { "operation": "tengfullpay.payments.wechat-redirect", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "公众号跳转支付", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "money", "type": "string", "required": true, "description": "订单的资金总额，单位：分" }, { "name": "order_id", "type": "string", "required": true, "description": "确保唯一,长度不超过32" }, { "name": "valid_time", "type": "string", "required": false, "description": "从平台下单开始超过指定秒数的时间后，订单不能再进行支付 单位：秒 默认：600（10分钟）" }, { "name": "extra", "type": "string", "required": false, "description": "商户附加信息，可做扩展参数，只允许数字字母下划线，例如aa_bb.不允许带!@#+等，例如qq+v&c?!22" }, { "name": "share_order_type", "type": "string", "required": false, "description": "0-不需要分账 1-需要分账 默认为0" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "money": "REPLACE_money", "order_id": "REPLACE_order_id", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。 仅准备公众号跳转链接，不在服务端发起付款。返回 PREPARED，须由用户在微信内打开；支付结果仍需查原单。", "reference": "https://www.showdoc.cc/tengfullpay/10442248076511388" }, { "operation": "tengfullpay.refunds.query", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "退款查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "refund_no", "type": "string", "required": false, "description": "商户平台退款单号 refund_no,order_id二选一，不能同时为空" }, { "name": "order_id", "type": "string", "required": false, "description": "退款接口返回的out_refund_no refund_no,order_id二选一，不能同时为空" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "reference": "https://www.showdoc.cc/tengfullpay/11558522985069300" }, { "operation": "tengfullpay.requests", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "requests", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "tengfullpay.requests.recover", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "requests · 原单恢复", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "tengfullpay.shares.back", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "分账退回", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "share_sn", "type": "string", "required": false, "description": "share_sn，merch_share_sn二选一必填" }, { "name": "merch_share_sn", "type": "string", "required": false, "description": "share_sn，merch_share_sn二选一必填" }, { "name": "merch_share_back_sn", "type": "string", "required": true, "description": "" }, { "name": "details", "type": "string", "required": true, "description": "JSON 数组编码一次后的字符串，不是直接传数组；1—100 项、总字符串最多 500 个字符。share_detail_no 不得重复；back_amount 单位元，大于 0、最多两位小数。先查原分账明细，再按原单退回。", "schema": { "type": "string", "maxLength": 500, "contentMediaType": "application/json", "contentSchema": { "type": "array", "minItems": 1, "maxItems": 100, "x-uniqueBy": "share_detail_no", "items": { "type": "object", "additionalProperties": false, "required": [ "share_detail_no", "back_amount" ], "properties": { "share_detail_no": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,32}$", "description": "原分账查询返回的明细号，1—32 个字母、数字、下划线或短横线；不能自行生成。" }, "back_amount": { "anyOf": [ { "type": "string", "pattern": "^(?!0(?:\\.0{1,2})?$)(0|[1-9][0-9]{0,9})(\\.[0-9]{1,2})?$" }, { "type": "number", "exclusiveMinimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 } ], "description": "本明细退回金额，单位元；大于 0、最多两位小数，建议十进制字符串。" }, "back_desc": { "type": "string", "maxLength": 50, "description": "可选退回说明，最多 50 个 Unicode 字符，不含换行或 NUL。" } } } } } }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "merch_share_back_sn": "REPLACE_merch_share_back_sn", "details": "[{\"share_detail_no\":\"REPLACE_SHARE_DETAIL_NO\",\"back_amount\":\"0.01\"}]", "merchantRequestId": "REPLACE_merchantRequestId", "merch_share_sn": "REPLACE_ORIGINAL_MERCH_SHARE_SN" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/11558733406481677" }, { "operation": "tengfullpay.shares.back-query", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "分账退回查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "share_back_sn", "type": "string", "required": false, "description": "share_back_sn，merch_share_back_sn 二选一必填" }, { "name": "merch_share_back_sn", "type": "string", "required": false, "description": "share_back_sn，merch_share_back_sn 二选一必填" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "reference": "https://www.showdoc.cc/tengfullpay/11558733409043803" }, { "operation": "tengfullpay.shares.complete", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "分账完成", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_id", "type": "string", "required": true, "description": "交易订单平台单号 下单成功时返回" }, { "name": "merch_share_sn", "type": "string", "required": true, "description": "商户分账完成单订单号" }, { "name": "order_date", "type": "string", "required": true, "description": "格式：20250212" }, { "name": "share_complete_desc", "type": "string", "required": false, "description": "" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "order_id": "REPLACE_order_id", "merch_share_sn": "REPLACE_merch_share_sn", "order_date": "REPLACE_order_date", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/11558736878831307" }, { "operation": "tengfullpay.shares.create", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "请求分账", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_id", "type": "string", "required": true, "description": "小腾支付订单号" }, { "name": "order_date", "type": "string", "required": true, "description": "格式：20220212" }, { "name": "merch_share_sn", "type": "string", "required": true, "description": "" }, { "name": "receivers", "type": "array", "required": true, "description": "1—100 个分账接收方对象，接收商户号不得重复；每项仅包含 receiver_merch_no、receive_amount。金额单位为元，最多两位小数且必须大于 0，建议使用十进制字符串。", "schema": { "type": "array", "minItems": 1, "maxItems": 100, "x-uniqueBy": "receiver_merch_no", "items": { "type": "object", "additionalProperties": false, "required": [ "receiver_merch_no", "receive_amount" ], "properties": { "receiver_merch_no": { "type": [ "string", "integer" ], "pattern": "^[0-9]{1,32}$", "minimum": 0, "description": "已确认的接收商户号，1—32 位数字；建议以字符串传递，保留前导零和精度。" }, "receive_amount": { "anyOf": [ { "type": "string", "pattern": "^(?!0(?:\\.0{1,2})?$)(0|[1-9][0-9]{0,9})(\\.[0-9]{1,2})?$" }, { "type": "number", "exclusiveMinimum": 0, "maximum": 9999999999.99, "multipleOf": 0.01 } ], "description": "分账金额，单位元；大于 0，整数部分最多 10 位，小数最多两位。推荐字符串，如 0.01；示例金额仅用于展示，执行前核对实际业务金额。" } } } } }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "本指令稳定幂等键；重试必须同号同参，不能换号重下" } ], "example": { "order_id": "REPLACE_order_id", "order_date": "REPLACE_order_date", "merch_share_sn": "REPLACE_merch_share_sn", "receivers": [ { "receiver_merch_no": "REPLACE_RECEIVER_MERCH_NO", "receive_amount": "0.01" } ], "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。 UNKNOWN 时查询 tengfullpay.requests 或按原请求恢复；外呼不自动重试。退款、分账、提现分别需要独立开关和供应商权限。", "reference": "https://www.showdoc.cc/tengfullpay/9801669748794429" }, { "operation": "tengfullpay.shares.query", "provider": "tengfullpay", "providerLabel": "小腾聚合支付", "category": "聚合支付", "title": "分账查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "order_id", "type": "string", "required": true, "description": "支付平台分账申请单号 请求分账时返回" } ], "example": { "order_id": "REPLACE_order_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 金额严格按字段单位：支付/退款请求为分，分账/提现为元；返回原始单位。mch、签名和回调地址由服务端配置。只有绑定此商户账户的应用可调用。受理不证明支付、退款、分账或结算完成。", "reference": "https://www.showdoc.cc/tengfullpay/9801673193245920" }, { "operation": "wikeyun.activity.list", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "活动列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "INT", "required": true, "description": "页数" }, { "name": "page_size", "type": "INT", "required": false, "description": "每页个数，默认10" }, { "name": "cate_id", "type": "INT", "required": false, "description": "可不传，默认1 ，CPS类" } ], "example": { "page": "REPLACE_page" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/12/document/458" }, { "operation": "wikeyun.activity.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "活动转链", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "userTag", "type": "string", "required": true, "description": "自定义参数，用户唯一标识，长度30以内" }, { "name": "activityId", "type": "int", "required": true, "description": "活动素材ID ， 活动ID和推广位ID获取方式 " }, { "name": "positionId", "type": "string", "required": true, "description": "推广位ID ， 活动ID和推广位ID获取方式 " } ], "example": { "userTag": "REPLACE_userTag", "activityId": "REPLACE_activityId", "positionId": "REPLACE_positionId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/12/document/362" }, { "operation": "wikeyun.apis", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "推广业务", "title": "apis", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "wikeyun.bawang-ele.activities", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "饿了么霸王餐活动列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "longitude", "type": "string", "required": true, "description": "经度" }, { "name": "latitude", "type": "string", "required": true, "description": "纬度" }, { "name": "session_id", "type": "string", "required": false, "description": "会话ID（分页场景首次请求结果返回，后续请求必须携带，服务根据同一个session_id的请求次数自动叠加翻页返回数据，直至分页结束，返回空）" }, { "name": "sort_type", "type": "string", "required": false, "description": "排序类型，默认normal，排序规则包括:{\"normal\":\"佣金倒序\",\"distance_asc\":\"距离由近到远\",\"commission_desc\":\"佣金倒序\",\"month_sales_desc\":\"月销量从高到低\",\"commission_rate_desc\":\"佣金比例倒序\", \"activity_reward_desc\":\"返现金额倒序\"}" }, { "name": "search_content", "type": "string", "required": false, "description": "搜索内容（店铺名）" }, { "name": "city_id", "type": "String", "required": false, "description": "标准城市ID（经纬度范围覆盖多个城市时，精准召回）" } ], "example": { "longitude": "REPLACE_longitude", "latitude": "REPLACE_latitude" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/561" }, { "operation": "wikeyun.bawang-ele.apply", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "饿了么霸王餐报名", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "shop_id", "type": "string", "required": true, "description": "门店ID" }, { "name": "activity_id", "type": "string", "required": true, "description": "活动ID" }, { "name": "order_no", "type": "string", "required": true, "description": "唯一单号，跟单使用，也就是user_tag" }, { "name": "mobile", "type": "string", "required": true, "description": "用户手机号" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "shop_id": "REPLACE_shop_id", "activity_id": "REPLACE_activity_id", "order_no": "REPLACE_order_no", "mobile": "REPLACE_mobile", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/563" }, { "operation": "wikeyun.bawang-ele.attribution", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "饿了么霸王餐归因排查接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "order_no", "type": "STring", "required": true, "description": "外卖单号" } ], "example": { "order_no": "REPLACE_order_no" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/569" }, { "operation": "wikeyun.bawang-ele.cancel", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "饿了么霸王餐取消报名", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "lock_id", "type": "INT", "required": true, "description": "报名接口返回的锁定ID" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "lock_id": "REPLACE_lock_id", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/564" }, { "operation": "wikeyun.bawang-ele.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "饿了么活动店铺详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "shop_id", "type": "String", "required": true, "description": "活动列表门店ID" }, { "name": "activity_id", "type": "String", "required": true, "description": "活动列表 活动ID" } ], "example": { "shop_id": "REPLACE_shop_id", "activity_id": "REPLACE_activity_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/562" }, { "operation": "wikeyun.bawang-meituan.activities", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "美团霸王餐活动列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "mobile", "type": "string", "required": true, "description": "手机号，请使用用户真实手机号，不能固定一个，否则会风控。" }, { "name": "lat", "type": "string", "required": true, "description": "用户位置坐标纬度" }, { "name": "lng", "type": "string", "required": true, "description": "用户位置坐标经度" }, { "name": "page_pvid", "type": "string", "required": false, "description": "首次传空字符串，后续回传接口返回的 pagePvId" }, { "name": "sort", "type": "int", "required": false, "description": "0 默认 1距离最近 2佣金降序" }, { "name": "name", "type": "string", "required": false, "description": "搜索词" } ], "example": { "mobile": "REPLACE_mobile", "lat": "REPLACE_lat", "lng": "REPLACE_lng" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/550" }, { "operation": "wikeyun.bawang-meituan.apply", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "报名霸王餐接口", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "mobile", "type": "string", "required": true, "description": "列表获取的手机号" }, { "name": "poiEventId", "type": "string", "required": true, "description": "商家活动 ID 从商家活动列表接⼝中获取" }, { "name": "meituanPvId", "type": "string", "required": true, "description": "商家检索 meituanPvId 从商家活动列表接⼝中获取" }, { "name": "pid", "type": "string", "required": true, "description": "推广位 ， 活动ID和推广位ID获取方式 " }, { "name": "user_tag", "type": "string", "required": false, "description": "自定义参数，用于跟踪" }, { "name": "lat", "type": "string", "required": true, "description": "用户位置坐标纬度" }, { "name": "lng", "type": "string", "required": true, "description": "用户位置坐标经度" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "mobile": "REPLACE_mobile", "poiEventId": "REPLACE_poiEventId", "meituanPvId": "REPLACE_meituanPvId", "pid": "REPLACE_pid", "lat": "REPLACE_lat", "lng": "REPLACE_lng", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/551" }, { "operation": "wikeyun.bawang-meituan.cancel", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "取消报名", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "mobile", "type": "string", "required": true, "description": "参与的手机号" }, { "name": "userEventId", "type": "string", "required": true, "description": "用户参与的ID" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "mobile": "REPLACE_mobile", "userEventId": "REPLACE_userEventId", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/552" }, { "operation": "wikeyun.bawang-meituan.status", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "美团查询状态", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "mobile", "type": "string", "required": true, "description": "手机号" }, { "name": "userEventId", "type": "string", "required": true, "description": "用户参与的Id" } ], "example": { "mobile": "REPLACE_mobile", "userEventId": "REPLACE_userEventId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/553" }, { "operation": "wikeyun.bawang.blacklist", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "霸王餐", "title": "黑名单查询接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "mobile", "type": "string", "required": true, "description": "查询手机号" } ], "example": { "mobile": "REPLACE_mobile" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/32/document/599" }, { "operation": "wikeyun.cards.create", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "卡券与直充", "title": "卡券、直充下单", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "id", "type": "int", "required": true, "description": "权益id" }, { "name": "spec_id", "type": "int", "required": true, "description": "规格id" }, { "name": "account", "type": "string", "required": false, "description": "需要充值的账号，直充特有字段" }, { "name": "client_type", "type": "string", "required": true, "description": "付款客户端，mini=小程序，public=公众号" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "id": "REPLACE_id", "spec_id": "REPLACE_spec_id", "client_type": "REPLACE_client_type", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。 先查询权益和规格；直充必须填写 account，卡券通常不填。client_type 只能使用供应商文档中的 mini 或 public。ACCEPTED 仅表示订单已受理，不证明付款、到账或发券；下单能力由运营按应用授权启用，资金确认不通过本接口伪造。", "reference": "https://open.wikeyun.cn/#/apiDocument/3/document/322" }, { "operation": "wikeyun.cards.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "卡券与直充", "title": "获取卡券、直充初始化信息", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "int", "required": true, "description": "权益id" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "reference": "https://open.wikeyun.cn/#/apiDocument/3/document/321" }, { "operation": "wikeyun.cards.order", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "卡券与直充", "title": "卡券或充值订单详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "order_no", "type": "string", "required": false, "description": "官方订单号 (和外部对接方订单号选择传一个)" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。 order_no 与 cms_order_num 至少传一个。平台创建的订单优先通过 wikeyun.requests.recover 按原 merchantRequestId 恢复。", "reference": "https://open.wikeyun.cn/#/apiDocument/3/document/327" }, { "operation": "wikeyun.cards.orders", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "卡券与直充", "title": "卡券或直充订单列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "int", "required": true, "description": "第几页" }, { "name": "page_size", "type": "int", "required": true, "description": "一页显示多少条数据" }, { "name": "status", "type": "int", "required": false, "description": "订单状态：传空=全部，-1=支付超时，0=未付款 ，1=已付款，2=购买充值中，3=已使用，4=失败（未退款），5=失败（已退款）" }, { "name": "keyword", "type": "string", "required": false, "description": "订单号或商品名模糊搜索" }, { "name": "order_type", "type": "int", "required": false, "description": "订单类型：传空=全部，0=充值订单，1=卡券订单" }, { "name": "g_id", "type": "int", "required": false, "description": "商品id：传空=全部，传其他id则查该商品下的订单" } ], "example": { "page": "REPLACE_page", "page_size": "REPLACE_page_size" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "reference": "https://open.wikeyun.cn/#/apiDocument/3/document/325" }, { "operation": "wikeyun.cards.products", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "卡券与直充", "title": "卡券特权数据（直充、卡券）", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "int", "required": false, "description": "权益id，不传或传空字符串=全部" }, { "name": "pro_type", "type": "int", "required": false, "description": "产品类型，不传或传空字符串=全部，0=直充，1=卡券" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 pro_type=0 为直充，1 为卡券；查询、下单与最终履约状态分别判断。", "reference": "https://open.wikeyun.cn/#/apiDocument/3/document/320" }, { "operation": "wikeyun.douyin.categories", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "商品类目查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "parent_id", "type": "int", "required": false, "description": "上级id，0表示顶级栏目，默认为0" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/406" }, { "operation": "wikeyun.douyin.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "抖音商品详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "product_ids", "type": "List", "required": true, "description": "商品ID，最多20个。注意：如商品推广在抖店后台下架，接口会返回为空。" } ], "example": { "product_ids": "REPLACE_product_ids" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/408" }, { "operation": "wikeyun.douyin.life-activity", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "抖音团购活动转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "activity_id", "type": "string", "required": true, "description": "活动ID, 活动列表 ，1:抖音生活服务新人专区，2:抖音生活服务商品集合页" }, { "name": "userTag", "type": "INT", "required": false, "description": "自定义参数，用于订单跟踪" }, { "name": "need_qr_code", "type": "bool", "required": false, "description": "是否需要二维码，默认false" }, { "name": "need_share_link", "type": "bool", "required": false, "description": "是否返回站外H5链接 默认false" }, { "name": "need_zlink", "type": "bool", "required": false, "description": "是否返回zlink，默认false" }, { "name": "need_share_command", "type": "bool", "required": false, "description": "是否需要口令，默认false" } ], "example": { "activity_id": "REPLACE_activity_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/2/document/573" }, { "operation": "wikeyun.douyin.life-detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "抖音本地团购CPS商品详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "int", "required": true, "description": "商品ID" }, { "name": "longitude", "type": "double", "required": false, "description": "" }, { "name": "latitude", "type": "double", "required": false, "description": "" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/2/document/570" }, { "operation": "wikeyun.douyin.life-parse", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "抖音团购口令解析", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "command", "type": "string", "required": true, "description": "短链/口令" } ], "example": { "command": "REPLACE_command" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/2/document/572" }, { "operation": "wikeyun.douyin.life-products", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "抖音本地团购CPS商品列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "cursor", "type": "INT", "required": true, "description": "游标。注意：首次查询时传空，第二次查询传第一次查询返回值中的cursor" }, { "name": "count", "type": "INT", "required": true, "description": "数量。默认为20，最大值为20 注意：response可能因为过滤等原因,返回数量小于count" }, { "name": "sort_by", "type": "INT", "required": false, "description": "排序字段。默认：1: 距离 2: 销量 3: 价格 4: 佣金比率 注意：销量升序，会出现较多后置过滤，导致列表为空的情况。请不要支持该功能" }, { "name": "order_by", "type": "INT", "required": false, "description": "排序方式。默认： 1: 升序 2: 降序" }, { "name": "longitude", "type": "Double", "required": true, "description": "纬度。WGS84坐标，参见https://tool.lu/coordinate。默认为北京市王府井 重要：一定需要WGS84坐标，且线上场景必需传递该参数" }, { "name": "latitude", "type": "Double", "required": true, "description": "纬度。WGS84坐标，参见https://tool.lu/coordinate。默认为北京市王府井 重要：一定需要WGS84坐标，且线上场景必需传递该参数" }, { "name": "distance_max", "type": "int", "required": false, "description": "距离限制。示例：3000，表示经纬度为中心3000米内商品" }, { "name": "category_id", "type": "int", "required": false, "description": "类别信息。参见： 商品类目20230727 " }, { "name": "keyword", "type": "string", "required": false, "description": "商品名称关键字。" } ], "example": { "cursor": "REPLACE_cursor", "count": "REPLACE_count", "longitude": "REPLACE_longitude", "latitude": "REPLACE_latitude" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/527" }, { "operation": "wikeyun.douyin.life-transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "抖音团购CPS转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "command", "type": "string", "required": true, "description": "商品ID/短链/口令" }, { "name": "userTag", "type": "INT", "required": false, "description": "自定义参数，用于订单跟踪" }, { "name": "need_qr_code", "type": "bool", "required": false, "description": "是否需要二维码，默认false" }, { "name": "need_share_link", "type": "bool", "required": false, "description": "是否返回站外H5链接 默认false" }, { "name": "need_zlink", "type": "bool", "required": false, "description": "是否返回zlink，默认false" }, { "name": "need_share_command", "type": "bool", "required": false, "description": "是否需要口令，默认false" } ], "example": { "command": "REPLACE_command" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/2/document/571" }, { "operation": "wikeyun.douyin.orders", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "抖客订单查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "cursor", "type": "String", "required": true, "description": "下一页索引（第一页传“0”）" }, { "name": "start_time", "type": "String", "required": true, "description": "支付时间开始，最早支持2021年10月01日" }, { "name": "end_time", "type": "String", "required": true, "description": "支付时间结束，该时间不能超过start_time+90" }, { "name": "page_size", "type": "int", "required": false, "description": "每页订单数目，取值区间： [1, 20]" }, { "name": "order_type", "type": "String", "required": false, "description": "只能是1或2或3，如果access_type选择2-SDK接入，则此时只能支持查询直播间分销的订单，order_type务必传2；" }, { "name": "time_type", "type": "String", "required": false, "description": "查询时间类型。pay: 支付时间（默认）; update：联盟侧更新时间，非订单状态更新时间" }, { "name": "order_ids", "type": "String", "required": false, "description": "最多支持10个订单号，如果这个字段填了，start_time/end_time/cursor/size不会使用" } ], "example": { "cursor": "REPLACE_cursor", "start_time": "REPLACE_start_time", "end_time": "REPLACE_end_time" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/414" }, { "operation": "wikeyun.douyin.parse", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "抖音口令解析", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "share_command", "type": "STring", "required": true, "description": "抖音商品口令" }, { "name": "convert", "type": "int", "required": true, "description": "是否二次转链接 1是，0否" }, { "name": "external_info", "type": "", "required": false, "description": "转链接时，自定义参数" }, { "name": "need_qr_code", "type": "int", "required": false, "description": "转链接时，是否需要获取抖音二维码" } ], "example": { "share_command": "REPLACE_share_command", "convert": "REPLACE_convert" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/415" }, { "operation": "wikeyun.douyin.products", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "获取抖音商品列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "title", "type": "string", "required": false, "description": "搜索的商品名称" }, { "name": "cid", "type": "int", "required": false, "description": "类目id" }, { "name": "page", "type": "int", "required": false, "description": "页码，默认1" }, { "name": "size", "type": "int", "required": false, "description": "每页个数，默认10" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/407" }, { "operation": "wikeyun.douyin.search", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "抖音商品搜索", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "keyword", "type": "string", "required": true, "description": "返回标题中包含某个关键词的商品" }, { "name": "page", "type": "int", "required": true, "description": "页数" }, { "name": "page_size", "type": "int", "required": true, "description": "每页大小" }, { "name": "search_type", "type": "int", "required": true, "description": "召回结果排序条件，0默认排序1历史销量排序2价格排序3佣金金额排序4佣金比例排序；" }, { "name": "sort_type", "type": "int", "required": true, "description": "排序顺序（0升序1降序）" }, { "name": "ext", "type": "json", "required": false, "description": "此项为自定义，需要根据https://op.jinritemai.com/docs/api-docs/61/924这边请求参数进行自定义，如你想筛选价格，则ext需要传{\"price_min\":10,\"price_max\":20}" } ], "example": { "keyword": "REPLACE_keyword", "page": "REPLACE_page", "page_size": "REPLACE_page_size", "search_type": "REPLACE_search_type", "sort_type": "REPLACE_sort_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/409" }, { "operation": "wikeyun.douyin.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "精选联盟达人商品分销转链", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "product_url", "type": "String", "required": true, "description": "商品ID/商品URL/口令/短链接" }, { "name": "external_info", "type": "String", "required": false, "description": "自定义字段，只允许 数字 ，限制长度为10" }, { "name": "need_qr_code", "type": "Bool", "required": false, "description": "是否需要二维码，需要会导致响应耗时增加" } ], "example": { "product_url": "REPLACE_product_url" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/17/document/410" }, { "operation": "wikeyun.express.cancel", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "取消订单", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_no", "type": "string", "required": true, "description": "微客云订单号" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "order_no": "REPLACE_order_no", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/453" }, { "operation": "wikeyun.express.create", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "快递创建订单", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "deliveryType", "type": "string", "required": true, "description": "快递 类型" }, { "name": "channelId", "type": "string", "required": true, "description": "渠道ID" }, { "name": "senderProvince", "type": "string", "required": true, "description": "寄件人省" }, { "name": "senderCity", "type": "string", "required": true, "description": "寄件人市" }, { "name": "senderDistrict", "type": "string", "required": true, "description": "寄件人区" }, { "name": "senderAddress", "type": "string", "required": true, "description": "寄件人详细地址" }, { "name": "senderName", "type": "string", "required": true, "description": "寄件人姓名" }, { "name": "senderPhone", "type": "string", "required": true, "description": "寄件人电话号" }, { "name": "receiveProvince", "type": "string", "required": true, "description": "收件人省" }, { "name": "receiveCity", "type": "string", "required": true, "description": "收件人市" }, { "name": "receiveDistrict", "type": "string", "required": true, "description": "收件人区" }, { "name": "receiveAddress", "type": "string", "required": true, "description": "收件人详细地址" }, { "name": "receiveName", "type": "string", "required": true, "description": "收件人姓名" }, { "name": "receivePhone", "type": "string", "required": true, "description": "受家人电话号" }, { "name": "packageCount", "type": "int", "required": true, "description": "包裹数量" }, { "name": "weight", "type": "number", "required": true, "description": "重量" }, { "name": "goodsName", "type": "string", "required": true, "description": "物品名称" }, { "name": "vloumLong", "type": "number", "required": false, "description": "长/CM，长宽高如传值则都必须传" }, { "name": "vloumWidth", "type": "number", "required": false, "description": "宽/CM，长宽高如传值则都必须传" }, { "name": "vloumHeight", "type": "number", "required": false, "description": "高/CM，长宽高如传值则都必须传" }, { "name": "insuranceValue", "type": "string", "required": false, "description": "保价金额，最大20000元" }, { "name": "pickUpStartTime", "type": "string", "required": false, "description": "预约上门取件开始时间，格式：YYYY-MM-DD HH:mm:ss" }, { "name": "pickUpEndTime", "type": "string", "required": false, "description": "预约上门取件结束时间，格式：YYYY-MM-DD HH:mm:ss" }, { "name": "remark", "type": "string", "required": false, "description": "" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "deliveryType": "REPLACE_deliveryType", "channelId": "REPLACE_channelId", "senderProvince": "REPLACE_senderProvince", "senderCity": "REPLACE_senderCity", "senderDistrict": "REPLACE_senderDistrict", "senderAddress": "REPLACE_senderAddress", "senderName": "REPLACE_senderName", "senderPhone": "REPLACE_senderPhone", "receiveProvince": "REPLACE_receiveProvince", "receiveCity": "REPLACE_receiveCity", "receiveDistrict": "REPLACE_receiveDistrict", "receiveAddress": "REPLACE_receiveAddress", "receiveName": "REPLACE_receiveName", "receivePhone": "REPLACE_receivePhone", "packageCount": "1", "weight": "REPLACE_weight", "goodsName": "REPLACE_goodsName", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 先查运费，使用返回的 type 作为 deliveryType、channelId 原值；vloumLong/vloumWidth/vloumHeight 必须成组。notify_url、cms_order_num 由网关注入。受理不等于支付或发货。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/448" }, { "operation": "wikeyun.express.insured-price", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "获取保费", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "senderProvince", "type": "string", "required": true, "description": "寄件省" }, { "name": "senderCity", "type": "string", "required": true, "description": "寄件市" }, { "name": "senderDistrict", "type": "string", "required": true, "description": "寄件区" }, { "name": "senderName", "type": "string", "required": false, "description": "寄件人姓名" }, { "name": "senderAddress", "type": "string", "required": false, "description": "寄件人详细地址" }, { "name": "senderPhone", "type": "string", "required": false, "description": "寄件人手机号" }, { "name": "receiveProvince", "type": "string", "required": true, "description": "收件省" }, { "name": "receiveCity", "type": "string", "required": true, "description": "收件市" }, { "name": "receiveDistrict", "type": "string", "required": true, "description": "收件区" }, { "name": "receiveName", "type": "string", "required": false, "description": "收件人姓名" }, { "name": "receiveAddress", "type": "string", "required": false, "description": "收件人地址" }, { "name": "receivePhone", "type": "string", "required": false, "description": "收件人电话号" }, { "name": "weight", "type": "number", "required": true, "description": "商品重量（kg）" }, { "name": "long", "type": "number", "required": false, "description": "" }, { "name": "width", "type": "number", "required": false, "description": "" }, { "name": "height", "type": "number", "required": false, "description": "" }, { "name": "price", "type": "number", "required": true, "description": "面值字符串，需先查询可售商品" }, { "name": "type", "type": "string", "required": true, "description": "快递类型" } ], "example": { "senderProvince": "REPLACE_senderProvince", "senderCity": "REPLACE_senderCity", "senderDistrict": "REPLACE_senderDistrict", "receiveProvince": "REPLACE_receiveProvince", "receiveCity": "REPLACE_receiveCity", "receiveDistrict": "REPLACE_receiveDistrict", "weight": "REPLACE_weight", "price": "REPLACE_price", "type": "REPLACE_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 保费与是否支持保价取决于具体快递渠道；业务拒绝保留供应商原码。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/451" }, { "operation": "wikeyun.express.pay", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "订单支付", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "order_no", "type": "string", "required": true, "description": "微客云订单编号" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "order_no": "REPLACE_order_no", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 可能发生真实余额扣款；要求独立支付开关及稳定 merchantRequestId，不自动重试。 UNKNOWN 时保留原 merchantRequestId；创建结果没有 order_no 时需供应商核查，不能更换命令号重下。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/449" }, { "operation": "wikeyun.express.price", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "预下单价格查询接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "senderProvince", "type": "string", "required": true, "description": "寄件人省" }, { "name": "senderCity", "type": "string", "required": true, "description": "寄件人市" }, { "name": "senderDistrict", "type": "string", "required": true, "description": "寄件人区" }, { "name": "senderPhone", "type": "string", "required": false, "description": "寄件人电话号" }, { "name": "senderAddress", "type": "string", "required": false, "description": "寄件人详细地址" }, { "name": "receiveProvince", "type": "string", "required": true, "description": "收件人省" }, { "name": "receiveCity", "type": "string", "required": true, "description": "收件人市" }, { "name": "receiveDistrict", "type": "string", "required": true, "description": "收件人区" }, { "name": "receiveName", "type": "string", "required": false, "description": "收件人电话号" }, { "name": "receiveAddress", "type": "string", "required": false, "description": "收件人地址" }, { "name": "receivePhone", "type": "string", "required": false, "description": "收件人电话号" }, { "name": "weight", "type": "number", "required": true, "description": "商品总量" }, { "name": "long", "type": "number", "required": false, "description": "长" }, { "name": "width", "type": "number", "required": false, "description": "宽" }, { "name": "height", "type": "number", "required": false, "description": "高" } ], "example": { "senderProvince": "REPLACE_senderProvince", "senderCity": "REPLACE_senderCity", "senderDistrict": "REPLACE_senderDistrict", "receiveProvince": "REPLACE_receiveProvince", "receiveCity": "REPLACE_receiveCity", "receiveDistrict": "REPLACE_receiveDistrict", "weight": "REPLACE_weight" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/447" }, { "operation": "wikeyun.express.trace", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "快递", "title": "快递轨迹查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "order_no", "type": "string", "required": true, "description": "微客云订单号" } ], "example": { "order_no": "REPLACE_order_no" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。 重量按 kg，尺寸按 cm；报价为预估，以供应商实际计费为准。快递回调按标准签名验签，经核验通知可通过原请求回执的 expressNotification 读取；运输状态、补差与退款金额观察不直接触发扣款、退款或结算。 order_no 为微客云订单号；轨迹不能作为支付、退款或补差已完成的依据。", "reference": "https://open.wikeyun.cn/#/apiDocument/20/document/452" }, { "operation": "wikeyun.jd.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "商品详情接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "num_iid", "type": "string", "required": true, "description": "商品ID" }, { "name": "sceneId", "type": "int", "required": true, "description": "使用场景 ：1 - 联盟id ，2返利场景" } ], "example": { "num_iid": "REPLACE_num_iid", "sceneId": "REPLACE_sceneId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/36/document/588" }, { "operation": "wikeyun.jd.products", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "京东商品列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "int", "required": true, "description": "页数" }, { "name": "eliteId", "type": "int", "required": true, "description": "1-好券商品,2-精选卖场,10-9.9包邮,15-京东配送,22-实时热销榜,23-为你推荐,24-数码家电,25-超市,26-母婴玩具,27-家具日用,28-美妆穿搭,30-图书文具,31-今日必推,32-京东好物,33-京东秒杀,34-拼购商品,40-高收益榜" }, { "name": "pageSize", "type": "int", "required": false, "description": "每页条数" } ], "example": { "page": "REPLACE_page", "eliteId": "REPLACE_eliteId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/36/document/586" }, { "operation": "wikeyun.jd.search", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "京东搜索接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "int", "required": true, "description": "页数" }, { "name": "keyword", "type": "string", "required": true, "description": "搜索关键词" }, { "name": "extra", "type": "string", "required": false, "description": "附加搜索json数据，参考https://union.jd.com/openplatform/api/v2?apiName=jd.union.open.goods.query" } ], "example": { "page": "REPLACE_page", "keyword": "REPLACE_keyword" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/36/document/581" }, { "operation": "wikeyun.jd.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "京东商品转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "materialUrl", "type": "string", "required": false, "description": "京东链接，支持联盟短链接/联盟长链接/联盟商品链接，主站的请先调用搜索接口获取联盟链接" }, { "name": "user_tag", "type": "string", "required": false, "description": "自定义参数，订单列表会返回" } ], "example": {}, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/36/document/580" }, { "operation": "wikeyun.meituan.coupons", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "查询美团券包", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "platform", "type": "int", "required": true, "description": "商品所属业务一级分类类型：1 到家及其他业务类型，2 到店业务类型（包含到店美食、休闲生活、酒店、门票）；" }, { "name": "listTopiId", "type": "int", "required": false, "description": "选品池榜单主题ID，到家及其他业务类型支持查询：1 精选，2 今日必推，3 同城热销（其中到家医药业务类型，本项为必填，且只支持传枚举3）；到店业务类型支持查询：2 今日必推，3 同城热销（全部商品），5 实时热销，（其中到店酒店、门票业务类型，本项为必填，且只支持传枚举3）" }, { "name": "bizLine", "type": "int", "required": false, "description": "商品所属业务二级分类类型；当字段platform为1，选择到家及其他业务类型时：5 医药 ，不填则默认为null，返回外卖商品券；当字段platform为2，选择到店业务类型时：1 到餐，2 到综 3：酒店 4：门票 不填则默认1" }, { "name": "pageNo", "type": "int", "required": true, "description": "页码" }, { "name": "pageSize", "type": "int", "required": true, "description": "每页个数" }, { "name": "longitude", "type": "double", "required": true, "description": "定位经纬度的经度" }, { "name": "latitude", "type": "double", "required": true, "description": "定位经纬度的纬度" }, { "name": "searchText", "type": "string", "required": false, "description": "搜索词" }, { "name": "sortField", "type": "int", "required": false, "description": "1）未入参榜单listTopiId时：支持1 售价排序、2 销量排序、6离我最近；2）入参榜单listTopiId时：当platform为1，选择到家业务类型：外卖商品券类型，支持1 售价排序、 2 销量降序、 3佣金降序，不填则默认为1；到家医药类型，支持2 销量降序、 3 佣金降序，不填则默认为2； 当platform为2，选择到店业务类型：支持2 销量降序、 3佣金降序、6离我最近，不填则默认为2。其中listTopiId为5时，仅支持默认排序，sortField不生效；注：当listTopiId选择榜单后，排序sortField不生效，榜单只能按照销量排序。3)通过搜索searchText召回时：支持1综合排序、2价格升序、6离我最近，不填默认为1" } ], "example": { "platform": "REPLACE_platform", "pageNo": "1", "pageSize": "1", "longitude": "REPLACE_longitude", "latitude": "REPLACE_latitude" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/1/document/608" }, { "operation": "wikeyun.meituan.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "美团券包转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "user_tag", "type": "string", "required": true, "description": "自定义跟踪参数" }, { "name": "bizLine", "type": "int", "required": false, "description": "商品所属业务二级分类类型；请求的商品推广链接所属的业务类型信息，即只有输入productViewSign时才需要传本字段；当字段platform为1，选择到家及其他业务类型时：5 医药，不填则默认null，表示外卖商品券；当字段platform为2，选择到店业务类型时：1 到餐，2 到综 3：酒店 4：门票 不填则默认1" }, { "name": "platform", "type": "int", "required": false, "description": "商品所属业务一级分类类型；请求的商品推广链接所属的业务类型信息，即只有输入productViewSign时才需要传本字段：1 到家及其他业务类型，2 到店业务类型；不填则默认1" }, { "name": "productViewSign", "type": "string", "required": true, "description": "queryCoupon接口返回的商品productViewSign" }, { "name": "linkTypeList", "type": "string", "required": true, "description": "链接类型列表， 枚举值：1 H5长链接；2 H5短链接；3 deeplink(唤起)链接；4 微信小程序唤起路径；5 团口令；6 小程序码;注：团口令、h5短链、小程序二维码有效期60天 ，其余无限制。多个逗号分割" } ], "example": { "user_tag": "REPLACE_user_tag", "productViewSign": "REPLACE_productViewSign", "linkTypeList": "REPLACE_linkTypeList" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/1/document/609" }, { "operation": "wikeyun.orders.commission", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "订单分销明细", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "orderid", "type": "string", "required": true, "description": "单号" } ], "example": { "orderid": "REPLACE_orderid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/13/document/596" }, { "operation": "wikeyun.orders.promotions", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "推广订单列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "order_type", "type": "INT", "required": false, "description": "订单类型，0=淘宝，1=天猫，2=拼多多，3=京东,4=ele,5=美团，6=电影票 7话费 8油卡 9=肯德基 10=美团生活，11=会员卡 12=滴滴 13=电费，14=生活团购 15=唯品会" }, { "name": "status", "type": "INT", "required": false, "description": "订单状态 0=订单付款，1=订单结算，2=订单失效" }, { "name": "query_type", "type": "INT", "required": true, "description": "查询时间类型 1创建时间 2更新时间 3结算时间" }, { "name": "page_size", "type": "INT", "required": false, "description": "每页大小,默认20 ，最大500" }, { "name": "p", "type": "INT", "required": true, "description": "页数，1" }, { "name": "start_time", "type": "INT", "required": true, "description": "开始时间，linux时间戳10位" }, { "name": "end_time", "type": "INT", "required": true, "description": "结束时间，linux时间戳10位，跟开始时间相差不能超过2小时" }, { "name": "order_ids", "type": "Json", "required": false, "description": "订单号集合，Json格式" } ], "example": { "query_type": "REPLACE_query_type", "p": "REPLACE_p", "start_time": "REPLACE_start_time", "end_time": "REPLACE_end_time" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/13/document/544" }, { "operation": "wikeyun.pdd.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "商品详情接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "num_iid", "type": "string", "required": true, "description": "商品ID" } ], "example": { "num_iid": "REPLACE_num_iid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/589" }, { "operation": "wikeyun.pdd.position-create", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "创建拼多多推广位PID", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "number", "type": "int", "required": false, "description": "本应用原商户订单号；使用字符串" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/593" }, { "operation": "wikeyun.pdd.registration", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "备案拼多多的PID", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "user_tag", "type": "string", "required": true, "description": "自定义备案参数，同转链接时候的user_tag" }, { "name": "pid", "type": "string", "required": true, "description": "拼多多推广位pid，需要调用创建接口生成" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "user_tag": "REPLACE_user_tag", "pid": "REPLACE_pid", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/591" }, { "operation": "wikeyun.pdd.registration-status", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "检查拼多多是否备案成功", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "pid", "type": "string", "required": true, "description": "拼多多推广位pid，需要调用创建接口生成" }, { "name": "user_tag", "type": "string", "required": true, "description": "自定义备案参数，同转链接时候的user_tag" } ], "example": { "pid": "REPLACE_pid", "user_tag": "REPLACE_user_tag" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/592" }, { "operation": "wikeyun.pdd.search", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "拼多多搜索接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "keyword", "type": "string", "required": true, "description": "搜索关键词" }, { "name": "page", "type": "int", "required": true, "description": "分页" }, { "name": "page_size", "type": "int", "required": false, "description": "默认100，每页商品数量" }, { "name": "sort_type", "type": "int", "required": false, "description": "排序方式:0-综合排序;1-按佣金比率升序;2-按佣金比例降序;3-按价格升序;4-按价格降序;5-按销量升序;6-按销量降序;7-优惠券金额排序升序;8-优惠券金额排序降序;9-券后价升序排序;10-券后价降序排序;11-按照加入多多进宝时间升序;12-按照加入多多进宝时间降序;13-按佣金金额升序排序;14-按佣金金额降序排序;15-店铺描述评分升序;16-店铺描述评分降序;17-店铺物流评分升序;18-店铺物流评分降序;19-店铺服务评分升序;20-店铺服务评分降序;27-描述评分击败同类店铺百分比升序，28-描述评分击败同类店铺百分比降序，29-物流评分击败同类店铺百分比升序，30-物流评分击败同类店铺百分比降序，31-服务评分击败同类店铺百分比升序，32-服务评分击败同类店铺百分比降序" }, { "name": "with_coupon", "type": "int", "required": false, "description": "是否只返回优惠券的商品，1只返回有优惠券的商品" }, { "name": "pid", "type": "string", "required": true, "description": "推广位，先调用创建接口创建" }, { "name": "user_tag", "type": "string", "required": true, "description": "自定义参数，同步所有接口内的user_tag，不能随便写" } ], "example": { "keyword": "REPLACE_keyword", "page": "REPLACE_page", "pid": "REPLACE_pid", "user_tag": "REPLACE_user_tag" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/579" }, { "operation": "wikeyun.pdd.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "拼多多转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "goods_sign", "type": "string", "required": true, "description": "多多进宝商品ID" }, { "name": "user_tag", "type": "string", "required": true, "description": "自定义跟踪参数，也是备案时候的user_tag，每个用户备案不能一样" }, { "name": "zs_duo_id", "type": "string", "required": false, "description": "招商多多客ID" }, { "name": "pid", "type": "string", "required": true, "description": "拼多多推广位，每个用户一个，需要调用拼多多备案接口进行备案" } ], "example": { "goods_sign": "REPLACE_goods_sign", "user_tag": "REPLACE_user_tag", "pid": "REPLACE_pid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/35/document/578" }, { "operation": "wikeyun.requests", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "推广业务", "title": "requests", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "wikeyun.requests.recover", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "推广业务", "title": "requests · 原单恢复", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "id": "REPLACE_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。" }, { "operation": "wikeyun.taobao.activity", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝活动转连接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "activityId", "type": "string", "required": true, "description": "淘宝活动ID，如双十一会场，ID：20150318020007201" } ], "example": { "activityId": "REPLACE_activityId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/653" }, { "operation": "wikeyun.taobao.authorized-activity", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝活动转链接【授权版】", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "activityId", "type": "String", "required": true, "description": "官方活动会场ID，从淘宝客后台“我要推广-活动推广”中获取" }, { "name": "adzoneId", "type": "Number", "required": true, "description": "mm_xxx_xxx_xxx的第3段数字" }, { "name": "siteId", "type": "Number", "required": true, "description": "mm_xxx_xxx_xxx的第2段数字" }, { "name": "r_id", "type": "Number", "required": false, "description": "渠道关系id" } ], "example": { "activityId": "REPLACE_activityId", "adzoneId": "REPLACE_adzoneId", "siteId": "REPLACE_siteId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/376" }, { "operation": "wikeyun.taobao.authorized-member-mark", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "私域会员标记【授权版】", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "external_id", "type": "String", "required": true, "description": "淘宝客自有私域用户自定义标记，如自有私域系统账号标记等" }, { "name": "external_type", "type": "Number", "required": true, "description": "淘宝客其他平台私域用户自定义标记，1-微信、2-微博、3-抖音、4-快手、5-QQ，0-其他" }, { "name": "op_type", "type": "Number", "required": true, "description": "授权类型，选2时可用于更新外部用户标记，默认1：1-新绑，2-更新" }, { "name": "redirect_url", "type": "String", "required": true, "description": "会员备案授权后，跳转的目标页地址" }, { "name": "ucrowd_id", "type": "Number", "required": false, "description": "人群标签ID，用户备案授权后会自动添加到该人群" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "external_id": "REPLACE_external_id", "external_type": "REPLACE_external_type", "op_type": "REPLACE_op_type", "redirect_url": "REPLACE_redirect_url", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/393" }, { "operation": "wikeyun.taobao.authorized-orders", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝订单接口【授权版】", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "query_type", "type": "INT", "required": true, "description": "查询时间类型，1：按照订单淘客创建时间查询，2:按照订单淘客付款时间查询，3:按照订单淘客结算时间查询，4:按照订单更新时间；" }, { "name": "position_index", "type": "String", "required": false, "description": "位点，除第一页之外，都需要传递；前端原样返回。" }, { "name": "page_size", "type": "INT", "required": false, "description": "页大小，默认20，1~100" }, { "name": "member_type", "type": "INT", "required": false, "description": "推广者角色类型,2:二方，3:三方，不传，表示所有角色" }, { "name": "tk_status", "type": "INT", "required": false, "description": "淘客订单状态，12-付款，13-关闭，14-确认收货，3-结算成功;不传，表示所有状态" }, { "name": "end_time", "type": "String", "required": true, "description": "订单查询结束时间，订单开始时间至订单结束时间，中间时间段日常要求不超过3个小时，但如618、双11、年货节等大促期间预估时间段不可超过20分钟，超过会提示错误，调用时请务必注意时间段的选择，以保证亲能正常调用！" }, { "name": "start_time", "type": "String", "required": true, "description": "订单查询开始时间" }, { "name": "jump_type", "type": "INT", "required": false, "description": "跳转类型，当向前或者向后翻页必须提供,-1: 向前翻页,1：向后翻页" }, { "name": "page_no", "type": "INT", "required": true, "description": "第几页，默认1，1~100" }, { "name": "order_scene", "type": "INT", "required": true, "description": "场景订单场景类型，1:常规订单，2:渠道订单，3:会员运营订单，默认为1" } ], "example": { "query_type": "REPLACE_query_type", "end_time": "REPLACE_end_time", "start_time": "REPLACE_start_time", "page_no": "REPLACE_page_no", "order_scene": "REPLACE_order_scene" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/375" }, { "operation": "wikeyun.taobao.authorized-parse", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "万能搜索解析功能【授权版】", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "content", "type": "String", "required": true, "description": "查找的内容 ，如 点击复制按钮打开 →手?掏APP←即可领优惠券 ---------蝮?制----- ☑hl8k2EikPT8￥:/" }, { "name": "pid", "type": "String", "required": true, "description": "推广位" }, { "name": "r_id", "type": "String", "required": false, "description": "渠道ID" } ], "example": { "content": "REPLACE_content", "pid": "REPLACE_pid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/419" }, { "operation": "wikeyun.taobao.authorized-registration", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝渠道或会员备案【授权版】", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "inviter_code", "type": "string", "required": true, "description": "淘宝客邀请渠道或会员的邀请码" }, { "name": "info_type", "type": "INT", "required": true, "description": "类型，必选 默认为1:" }, { "name": "offline_scene", "type": "String", "required": false, "description": "渠道备案 - 线下场景信息，1 - 门店，2- 学校，3 - 工厂，4 - 其他" }, { "name": "online_scene", "type": "String", "required": false, "description": "渠道备案 - 线上场景信息，1 - 微信群，2- QQ群，3 - 其他" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "inviter_code": "REPLACE_inviter_code", "info_type": "REPLACE_info_type", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/391" }, { "operation": "wikeyun.taobao.authorized-registration-info", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "私域用户备案信息查询【授权版】", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "relation_id", "type": "Number", "required": true, "description": "渠道ID" }, { "name": "page_no", "type": "Number", "required": true, "description": "页数" }, { "name": "page_size", "type": "Number", "required": true, "description": "每页大小" }, { "name": "info_type", "type": "Number", "required": true, "description": "类型，必选 1:渠道信息；2:会员信息" }, { "name": "relation_app", "type": "String", "required": true, "description": "备案的场景：common（通用备案），etao（一淘备案），minietao（一淘小程序备案），offlineShop（线下门店备案），offlinePerson（线下个人备案）。如不填默认common。查询会员信息只需填写common即可" }, { "name": "special_id", "type": "String", "required": false, "description": "会员独占 - 会员运营ID" }, { "name": "external_id", "type": "String", "required": false, "description": "淘宝客外部用户标记，如自身系统账户ID；微信ID等" }, { "name": "external_type", "type": "Number", "required": false, "description": "1-微信、2-微博、3-抖音、4-快手、5-QQ，0-其他；默认为0" } ], "example": { "relation_id": "REPLACE_relation_id", "page_no": "REPLACE_page_no", "page_size": "REPLACE_page_size", "info_type": "REPLACE_info_type", "relation_app": "REPLACE_relation_app" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/392" }, { "operation": "wikeyun.taobao.authorized-transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "万能转链接接口【授权版】", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "pid", "type": "string", "required": true, "description": "推广位ID" }, { "name": "r_id", "type": "string", "required": true, "description": "渠道管理ID（如是主站选品推广场景，必须入参该字段，且bizSceneId字段需入参2-消费者比价场景，否则二次转链失败）" }, { "name": "material_list", "type": "string", "required": true, "description": "物料列表，可以为url或淘口令,多个时使用英文逗号拼接传入" }, { "name": "biz_scene_id", "type": "INT", "required": true, "description": "1-动态ID转链场景，2-消费者比价场景" } ], "example": { "pid": "REPLACE_pid", "r_id": "REPLACE_r_id", "material_list": "REPLACE_material_list", "biz_scene_id": "REPLACE_biz_scene_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/577" }, { "operation": "wikeyun.taobao.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝商品详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "num_iid", "type": "string", "required": true, "description": "淘宝联盟商品ID" } ], "example": { "num_iid": "REPLACE_num_iid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/587" }, { "operation": "wikeyun.taobao.position-create", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "创建渠道推广位", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "name", "type": "", "required": false, "description": "渠道名称" }, { "name": "channel_id", "type": "", "required": false, "description": "微客云渠道ID，获取方式：https://open.wikeyun.cn/#/document/1/article/309" }, { "name": "r_id", "type": "", "required": true, "description": "淘宝渠道ID，checkRelationReg接口返回" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "r_id": "REPLACE_r_id", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/650" }, { "operation": "wikeyun.taobao.rank", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝商品排行榜", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "int", "required": true, "description": "页数" }, { "name": "pageSize", "type": "int", "required": true, "description": "每页条数" } ], "example": { "page": "REPLACE_page", "pageSize": "1" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/585" }, { "operation": "wikeyun.taobao.registration", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "获取渠道备案口令", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "rtag", "type": "String", "required": true, "description": "自定义参数。" }, { "name": "merchantRequestId", "type": "string", "required": true, "description": "业务字段，保持原接口含义" } ], "example": { "rtag": "REPLACE_rtag", "merchantRequestId": "REPLACE_merchantRequestId" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/648" }, { "operation": "wikeyun.taobao.registration-status", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "检测是否渠道备案", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "info_type", "type": "Int", "required": true, "description": "类型，必选 1:渠道信息；2:会员信息" }, { "name": "page_no", "type": "int", "required": true, "description": "第几页，下标从0开始" }, { "name": "page_size", "type": "int", "required": true, "description": "每页大小" } ], "example": { "info_type": "REPLACE_info_type", "page_no": "REPLACE_page_no", "page_size": "REPLACE_page_size" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/649" }, { "operation": "wikeyun.taobao.search", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "淘宝搜索接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "pid", "type": "string", "required": false, "description": "推广位，授权版传递自己联盟的PID" }, { "name": "page", "type": "int", "required": false, "description": "页数" }, { "name": "pageSize", "type": "int", "required": false, "description": "每页个数" }, { "name": "keyword", "type": "string", "required": true, "description": "搜索词" } ], "example": { "keyword": "REPLACE_keyword" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/584" }, { "operation": "wikeyun.taobao.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "商品转连接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "material_list", "type": "String", "required": true, "description": "物料列表，可以为url或淘口令,多个时使用英文逗号拼接传入" }, { "name": "r_id", "type": "String", "required": true, "description": "渠道ID，备案获得" }, { "name": "biz_scene_id", "type": "String", "required": false, "description": "1-动态ID转链场景，2-消费者比价场景" } ], "example": { "material_list": "REPLACE_material_list", "r_id": "REPLACE_r_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/14/document/651" }, { "operation": "wikeyun.waimai.categories", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "商品类目查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "business_line", "type": "int", "required": true, "description": "联盟业务线ID" }, { "name": "act_id", "type": "int", "required": true, "description": "联盟活动ID" }, { "name": "p", "type": "int", "required": false, "description": "分页参数，页码，默认为1" }, { "name": "page_size", "type": "int", "required": false, "description": "分页参数，页长，默认为20，最大为100" } ], "example": { "business_line": "REPLACE_business_line", "act_id": "REPLACE_act_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/11/document/389" }, { "operation": "wikeyun.waimai.cities", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "美团城市列表", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "business_line", "type": "int", "required": true, "description": "联盟业务线类型" }, { "name": "p", "type": "int", "required": false, "description": "分页参数，页码，默认为1" }, { "name": "page_size", "type": "int", "required": false, "description": "分页参数，页长，默认为20，最大为100" } ], "example": { "business_line": "REPLACE_business_line" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/11/document/388" }, { "operation": "wikeyun.waimai.products", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "商品列表查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "business_line", "type": "int", "required": true, "description": "联盟业务线ID" }, { "name": "act_id", "type": "int", "required": true, "description": "联盟活动ID" }, { "name": "category_id", "type": "int", "required": false, "description": "商品类目ID" }, { "name": "city_id", "type": "int", "required": false, "description": "城市ID" }, { "name": "p", "type": "int", "required": false, "description": "分页参数，页码，默认为1" }, { "name": "page_size", "type": "int", "required": false, "description": "分页参数，页长，默认为20，最大为100" } ], "example": { "business_line": "REPLACE_business_line", "act_id": "REPLACE_act_id" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/11/document/390" }, { "operation": "wikeyun.waimai.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "品牌红包CPS", "title": "美团外卖转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "linkType", "type": "int", "required": true, "description": "链接类型 1 h5链接 2 deeplink(唤起)链接 3 中间页唤起链接 4 微信小程序唤起路径 5 团口令" }, { "name": "shortLink", "type": "int", "required": false, "description": "是否缩短 0 否 1是" }, { "name": "activityId", "type": "int", "required": true, "description": "活动列表activity_id" }, { "name": "user_tag", "type": "STRING", "required": true, "description": "自定义标示" } ], "example": { "linkType": "REPLACE_linkType", "activityId": "REPLACE_activityId", "user_tag": "REPLACE_user_tag" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/11/document/355" }, { "operation": "wikeyun.wph.detail", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "商品详情接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "num_iid", "type": "string", "required": true, "description": "唯品会商品id" } ], "example": { "num_iid": "REPLACE_num_iid" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/37/document/590" }, { "operation": "wikeyun.wph.search", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "唯品会搜索接口", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "int", "required": true, "description": "页数" }, { "name": "keyword", "type": "string", "required": true, "description": "搜索关键词" }, { "name": "order", "type": "int", "required": true, "description": "排序顺序：0-正序，1-逆序，默认正序" }, { "name": "priceStart", "type": "String", "required": false, "description": "价格区间" }, { "name": "priceEnd", "type": "String", "required": false, "description": "价格区间" } ], "example": { "page": "REPLACE_page", "keyword": "REPLACE_keyword", "order": "REPLACE_order" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/37/document/583" }, { "operation": "wikeyun.wph.transform", "provider": "wikeyun", "providerLabel": "微客云集（言午）", "category": "电商货盘", "title": "唯品会转链接", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "item_urls", "type": "string", "required": true, "description": "商品url，多个逗号分隔。" }, { "name": "user_tag", "type": "string", "required": false, "description": "自定义参数" } ], "example": { "item_urls": "REPLACE_item_urls" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 结果未知时保留 merchantRequestId 查询原指令，不自动重发。", "reference": "https://open.wikeyun.cn/#/apiDocument/37/document/582" }, { "operation": "yangguang.estimate", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "费用预估", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_lng", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_lat", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_addr", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_lng", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_lat", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_addr", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "service_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "ride_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "approach_point_list", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "city_code": "REPLACE_city_code", "start_lng": "REPLACE_start_lng", "start_lat": "REPLACE_start_lat", "start_addr": "REPLACE_start_addr", "end_lng": "REPLACE_end_lng", "end_lat": "REPLACE_end_lat", "end_addr": "REPLACE_end_addr", "service_type": "REPLACE_service_type", "departure_time": "REPLACE_departure_time" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.nearby", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "附近车辆", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "lng", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "lat", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "radius", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "ride_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "lng": "REPLACE_lng", "lat": "REPLACE_lat", "radius": "REPLACE_radius" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.bill", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 账单查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.cancel", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 取消", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "cancel_reason", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.cancel-fee", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 取消费查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.create", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "start_lng", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_lat", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_lng", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_lat", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "end_name", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "estimate_id", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "passenger_mobile", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "service_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "ride_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "start_addr", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_addr", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "start_poiid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "end_poiid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "user_mobile", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_virtual_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_country_code", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "passenger_uid", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "driver_message", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "support_link_order", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "support_im", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "fixed_price", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "change_cabin", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "approach_point_list", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "start_lng": "REPLACE_start_lng", "start_lat": "REPLACE_start_lat", "start_name": "REPLACE_start_name", "end_lng": "REPLACE_end_lng", "end_lat": "REPLACE_end_lat", "end_name": "REPLACE_end_name", "estimate_id": "REPLACE_estimate_id", "passenger_mobile": "REPLACE_passenger_mobile", "service_type": "REPLACE_service_type", "ride_type": "REPLACE_ride_type", "city_code": "REPLACE_city_code", "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.decision", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 确认接单决策", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "strive_status", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "passenger_phone", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "strive_fail_reason", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "strive_status": "REPLACE_strive_status", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.driver-position", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 司机位置", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.evaluate", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 评价", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "score", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "content", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "label_name", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "label_ids", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "score": "REPLACE_score", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.events", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 事件记录", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.notify-payment", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 通知支付结果", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "pay_status", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "pay_amount", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "derate_fee", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "premium_fee", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "idempotencyKey", "type": "string", "required": true, "description": "本次业务操作的幂等键；结果未知时不得更换键重试" } ], "example": { "pay_status": "REPLACE_pay_status", "pay_amount": "REPLACE_pay_amount", "merchantOrderId": "OPEN_DEMO_001", "idempotencyKey": "demo-command-001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.plan-track", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 预估轨迹", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "track_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.query", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.recover", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 原单恢复", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "supplierOrderId", "type": "string", "required": true, "description": "仅用于原订单身份恢复，须先核对来源" } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "supplierOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.orders.track", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "订单 · 行程轨迹", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yangguang.price-rule", "provider": "yangguang", "providerLabel": "阳光出行", "category": "出行服务", "title": "计价规则", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "service_type", "type": "string", "required": true, "description": "业务字段，保持原接口含义" }, { "name": "ride_type", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "city_code", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "estimate_id", "type": "string", "required": false, "description": "业务字段，保持原接口含义" }, { "name": "departure_time", "type": "string", "required": false, "description": "业务字段，保持原接口含义" } ], "example": { "service_type": "REPLACE_service_type" }, "notes": "业务结果在 data 中，保留原业务字段和单位。授权、渠道配置及写入能力均须由运营确认。 原渠道字段含义保持不变；平台生成渠道订单号。" }, { "operation": "yiqida.catalogs", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "catalogs", "mutation": false, "sandboxOnly": false, "fields": [], "example": {}, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.orders.create", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "订单 · 创建", "mutation": true, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" }, { "name": "commodityId", "type": "integer", "required": true, "description": "运营确认的商品规格 ID；禁止自行改用主商品 ID" }, { "name": "buyCount", "type": "integer", "required": true, "description": "购买数量，1—9999 的整数" }, { "name": "template", "type": "array", "required": true, "description": "按运营为该商品确认的模板顺序填写字符串数组，最多 16 项；每项非空、UTF-8 最多 4096 字节且不含 NUL/换行。数组长度必须等于该商品已配置的 templateCount，顺序及业务含义由该商品模板决定。仅 templateCount=0 时使用空数组；不要自行 URL 编码，服务端逐项编码。", "schema": { "type": "array", "maxItems": 16, "items": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[^\\u0000\\r\\n]+$", "description": "第 N 个已确认模板字段的原始值；位置、类型含义和长度须按当前商品模板核对。" } } } ], "example": { "merchantOrderId": "OPEN_DEMO_001", "commodityId": 1, "buyCount": 1, "template": [ "REPLACE_CONFIRMED_TEMPLATE_VALUE_1" ] }, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.orders.funds", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "订单 · funds", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.orders.logistics", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "订单 · logistics", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "merchantOrderId", "type": "string", "required": true, "description": "本应用的商户原订单号；必须保持同一业务键重试或查单" } ], "example": { "merchantOrderId": "OPEN_DEMO_001" }, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.orders.query", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "订单 · 查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "number", "type": "string", "required": true, "description": "本应用原商户订单号；使用字符串" } ], "example": { "number": "OPEN_DEMO_001" }, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.products", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "商品查询", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "page", "type": "integer", "required": false, "description": "页码，默认 1，1—1000000" }, { "name": "size", "type": "integer", "required": false, "description": "每页数量，默认 60，1—200" }, { "name": "catalogId", "type": "integer", "required": false, "description": "分组 ID，默认 0；0 表示未指定分组" }, { "name": "name", "type": "string", "required": false, "description": "可选商品名筛选，最多 256 字节" } ], "example": {}, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" }, { "operation": "yiqida.products.detail", "provider": "yiqida", "providerLabel": "亿奇达权益", "category": "权益商品", "title": "商品查询 · 详情", "mutation": false, "sandboxOnly": false, "fields": [ { "name": "id", "type": "integer", "required": true, "description": "供应商商品详情 ID；正整数，最大 9007199254740991" } ], "example": { "id": 1 }, "notes": "仅使用本应用已授权操作；账号、密钥、回调地址、上游订单号与价格保护均由服务端注入。商品查询结果仅供核对，真实下单默认关闭。订单受理不代表充值或卡密交付完成；UNKNOWN 只能按原订单号查询，不能换号重发。卡密按原应用归属返回；资金流水和物流为只读查询，不证明平台支付或退款到账。" } ] }