Appearance
华电项目接口
变更日志
版本 | 变更人 | 变更时间 | 变更内容 |
---|---|---|---|
2 | 蒋伟 | 2021/11/08 | 消息模块新增发票物流状态 |
1 | 蒋伟 | 2021//01 | 初始版本 |
1. 对账信息查询
请求地址
/api/restful/order/query-statement/statement-no/
请求方式
GET
请求参数
参数名 | 类型 | 释义 |
---|---|---|
statementNo | string | 对账单号 |
响应参数
参数名 | 类型 | 释义 |
---|---|---|
statementNo | string | 对账单号 |
totalAmount | string | 对账单总金额 |
taxpayerNo | string | 纳税人识别号 |
invoiceTitle | string | 发票 |
invoiceType | string | 发票类型 |
invoicePhone | string | 发票电话 |
invoiceAddress | string | 发票地址 |
bank | string | 发票银行 |
bankAccount | string | 银行账号 |
receiverAddress | string | 收票人地址 |
receiverPhone | string | 收票人号码 |
receiverName | string | 收票人名称 |
reason | string | 原因 |
statementDetails | arr | 对账明细 |
statementExtends | arr | 扩展字段 |
statementDetails实体
参数名 | 类型 | 释义 |
---|---|---|
orderCode | string | 订单号 |
orderAmount | float | 订单金额 |
returnAmount | float | 售后金额 |
orderCreateTime | string | 订单创建时间 |
orderEndTime | string | 订单结束时间 |
invoicePhone | string | 发票电话 |
statementOrderItems | string | 对账明细 |
sku | string | 商品sku |
skuName | string | 商品名称 |
price | float | 商品单价 |
num | int | 商品数量 |
returnNum | int | 退换货数量 |
totalPrice | float | 总金额 |
statementExtends实体
参数名 | 类型 | 释义 |
---|---|---|
columnName | string | 字段名称 |
columnKey | string | 字段key |
columnValue | string | 字段值 |
请求示例
请求参数
{baseUrl}/api/restful/order/query-statement/statement-no/CG20210220xxxxxx40d9
响应参数
json
{
"success": true,
"requestId": "4cf6e0d8298b433eaa86xxxxxxf0f77e",
"result": [
{
"statementNo": "CG20210220xxxxxx40d9",
"totalAmount": 25.68,
"taxpayerNo": "9136xxxxx66941F",
"invoiceTitle": "xxxxxxxx有限公司",
"invoiceType": 1,
"invoicePhone": "0792-6xxxx53",
"invoiceAddress": "江西省九江市柴桑区赤湖xxxx大道xxx号",
"bank": "中国工商银行九江分行营业部",
"bankAccount": "1507xxxxxxxxxx06662",
"companyName": "xxxxxxxx有限公司",
"receiverAddress": "江西省 九江市 九江县柴桑区赤湖xxxx大道xxx号",
"receiverPhone": "159xxxx4806",
"receiverName": "xx",
"reason": null,
"statementDetails": [
{
"orderCode": "D210xxxxxxxxxx9102",
"orderAmount": 25.68,
"returnAmount": 0,
"orderCreateTime": "2021-02-08 08:47:38",
"orderEndTime": "2021-02-26 18:00:00",
"statementOrderItems": [
{
"sku": "136xx1",
"skuName": "xxxx固体胶 7102 21g/支 12支/盒",
"price": 1.07,
"num": 24,
"returnNum": 0,
"totalPrice": 25.68
}
]
}
],
"statementExtends": [
{
"columnName": "扩展字段测试",
"columnKey": "test1",
"columnValue": "测试字段1"
}
]
}
],
"errorcode": "0",
"errormsg": ""
}
2. 根据订单号查询包裹信息
请求地址
/api/restful/order/order-package/
请求方式
GET
请求参数
参数名 | 类型 | 释义 |
---|---|---|
orderId | string | 订单号 |
响应参数
参数名 | 类型 | 释义 |
---|---|---|
orderId | string | 订单号 |
packageNo | string | 订单包裹号 |
state | string | 状态 0:已发货, 1 拒收, 2: 签收 |
请求示例
请求参数
{baseUrl}/api/restful/order/order-package/5000xxxxxx1001
响应参数
json
{
"success": true,
"requestId": "88e94d0f51ea4765be65647dxxxxe948",
"result": [
{
"orderId": "5000xxxxxx1001",
"packageNo": "5000xxxxxx10xx01",
"state": "0"
}
],
"errorcode": "0",
"errormsg": ""
}
3. 根据包裹号查询包裹信息
请求地址
/api/restful/order/order-package/order-package-no/
请求方式
GET
请求参数
参数名 | 类型 | 释义 |
---|---|---|
orderPackageNo | string | 包裹号 |
响应参数
参数名 | 类型 | 释义 |
---|---|---|
orderId | string | 订单号 |
packageNo | string | 订单包裹号 |
state | string | 状态 0:已发货, 1 拒收, 2: 签收 |
请求示例
请求参数
{baseUrl}/api/restful/order/order-package/order-package-no/5000xxxxxx1001
响应参数
json
{
"success": true,
"requestId": "fba0dd3ff30a479dae1d120d5xxxx430",
"result": {
"orderId": "5000xxxxxx1001",
"packageNo": "5000xxxxxx10xx01",
"state": "0"
},
"errorcode": "0",
"errormsg": ""
}
4. 根据结算单号查询电子发票
请求地址
/api/restful/invoice/{billNo}/
请求方式
GET
请求参数
参数名 | 类型 | 释义 |
---|---|---|
billNo | string | 结算单号 |
billRowNo | string | 结算单行号 |
响应参数
参数名 | 类型 | 释义 |
---|---|---|
invoiceNo | string | 发票号码 |
invoiceCode | string | 发票代码 |
invoiceLink | string | 电子发票链接 |
请求示例
请求参数
{baseUrl}/api/restful/invoice/ZHCPCJS20xxxxxxxx004/ZHCPCJS20xxxxxxxx004004-1
响应参数
json
{
"success": true,
"requestId": "d3c489de88aa41eeb901c3f305b92f12",
"result": {
"invoiceContents": [
{
"invoiceNo": "270xxx21",
"invoiceCode": "310xxxx130",
"invoiceLink": "xxxxxx"
}
]
},
"errorcode": "0",
"errormsg": ""
}
5. 新增退换货申请
请求地址
/api/restful/refund
请求方式
POST
请求参数
参数名 | 类型 | 释义 |
---|---|---|
apply_code | string | 退换货申请编号(默认可不填,返回值会生成返回) |
order_id | string | 退货对应订单编号 |
apply_type | string | 退换货申请类型(4=退货,5=换货) ,不填写默认是退货 |
pickup_way | string | 上门取件、第三方物流(上门=1,第三方=2)默认上门取件 |
remark | string | 备注信息 |
skus | List | [{"sku":商品编号, "num":商品数量, "price”:价格}], skus若为null则表示整单退 |
apply_time | string | 退换货申请时间(2017-12-18 09:22:07) |
apply_reason | string | 退换货原因 |
refund_addresses | List | 退换货地址 |
receiveType | string | 退换货地址类型,2 退货地址,3 换货重发地址 |
apply_name | string | 退换货联系人(默认订单收货人 |
apply_mobile | string | 退换货联系手机(默认订单收货人手机) |
apply_telephone | string | 退换货联系固定电话 |
apply_email | string | 退货人电子邮件 |
province_code | string | 退货人省份编码(默认订单中的编码) |
city_code | string | 退货人城市编码(默认订单中的编码) |
county_code | string | 退货人区县编码(默认订单中的地址) |
town_code | string | 退货人乡镇编码 |
address | string | 地址(默认订单中的地址) |
full_address | string | 退货人详细地址(默认订单中的地址) |
响应参数
参数名 | 类型 | 释义 |
---|---|---|
apply_code | string | 退货申请单编码 |
请求示例
请求参数
{baseUrl}/api/restful/refund
json
{
"apply_reason":"买家退换货测试",
"apply_type":"5",
"order_id":"PO-xxxxxxxx001",
"pickup_way":"1",
"remark": "测试备注信息",
"skus":[
{
"num":1,
"price":0.39,
"sku":"10xxx31"
}
],
"refund_addresses":[
{
"receiveType":3,
"apply_name":"余xx",
"apply_mobile":"189xxxx9682",
"province_code":"320000",
"city_code":"320100",
"county_code":"320000",
"town_code":"string",
"address":"江苏省南京市江宁区江苏省南京市江宁区xxx路1xx9号",
"full_address":"江苏省南京市江宁区江苏省南京市江宁区xxx路1xx9号"
},
{
"receiveType":2,
"apply_name":"李xx",
"apply_mobile":"189xxxx9681",
"province_code":"320000",
"city_code":"320100",
"county_code":"320000",
"town_code":"string",
"address":"江苏省南京市江宁区江苏省南京市江宁区xxx路1xx9号",
"full_address":"江苏省南京市江宁区江苏省南京市江宁区xxx路1xx9号"
}
]
}
响应参数
json
{
"success": true,
"requestId": "f256c6b45ea14cb7a160c29d1c9967c8",
"result": {
"apply_code": "RO__20211108113355488"
},
"errorcode": "0",
"errormsg": ""
}
6. 消息接口修改
退换货审批通知
303 消息类型表示退换货完成,304 表示退换货拒绝
发票消息接口
增加消息类型702类型, 表示发票物流变动
702 消息内容解释
参数名 | 类型 | 释义 |
---|---|---|
billNo | string | 结算单号 |
billRowNo | string | 结算单行号 |
invoiceNo | string | 发票号 |
invoiceCode | string | 发票代码 |
物流类型 | string | 发票物流状态, 1:已派送, 2 已妥投, -1 已拒绝 |
json
{
"billNo":"CESH2111020001",
"billRowNo":"CESH2111020001_01",
"invoiceNo":"01007741",
"invoiceCode":"3100213130",
"status":2
}
7. 对账信息查询接口扩展字段说明
对账信息查询接口根据华电需求增加扩展字段
需要增加字段:
对账单位编码、对账年份、对账月份、账单其实日期、账单截止日期、账期节约金额
扩展字段描述
json
[
{
"columnName":"对账单位编码",
"columnKey":"billCompanyCode",
"columnValue":"1111"
},
{
"columnName":"对账年份",
"columnKey":"billYear",
"columnValue":"2021"
},
{
"columnName":"对账月份",
"columnKey":"billMonth",
"columnValue":"01"
},
{
"columnName":"账单起始日期",
"columnKey":"billStartDate",
"columnValue":"2021-07-08"
},
{
"columnName":"账单截至日期",
"columnKey":"billEndDate",
"columnValue":"2021-08-08"
},
{
"columnName":"账期节约金额",
"columnKey":"billSavePrice",
"columnValue":"100.52"
}
]