Appearance
3.0 订单接入说明
订单接口域名
3.0.1测试域名：https://testexternalapi.colipu.com/jv-punchoutopenapi
3.0.2 生产域名：https://punchoutopenapi.colipu.com*
3.1 订单确认
接口说明：
| Method | TestURL | ContentType |
|---|---|---|
| Post | /api/order/confirm | application/json |
| 参数 | 类型说明 | 是否必须 | 描述 |
|---|---|---|---|
| fromId | String | 必须 | 来源名称（待科力普提供） |
| token | String | 必须 | 签名 |
| orderId | String | 必须 | 订单号 |
| orderDetails | List | 非必须 | 明细（部分确认，明细必传） |
| extend | List | 非必须 | 扩展信息 |
orderDetails说明：
| 参数 | 类型说明 | 是否必须 | 参数说明 |
|---|---|---|---|
| sku | String | 必须 | 商品编码 |
| qty | Int | 必须 | 数量 |
extend说明：
| 参数 | 类型说明 | 是否必须 | 参数说明 |
|---|---|---|---|
| String | 必须 | 扩展信息名称 |
| columnValue | String | 必须 | 扩展信息值 |
| columnRemark | String | 非必须 | 扩展信息描述 |
返回结果说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| code | Int | 操作结果返回代码 |
| subMessage | String | 错误描述 |
| data | String | 返回结果 |
返回数据示例：
{
"data": “成功”，
"subMesssage": "",
"code": 0
}
3.2 订单取消
接口说明：
| Method | TestURL | ContentType |
|---|---|---|
| Post | /api/order/cancel | application/json |
参数说明：
| 参数 | 类型说明 | 是否必须 | 描述 |
|---|---|---|---|
| fromId | String | 必须 | 来源名称（待科力普提供） |
| token | String | 必须 | 签名 |
| orderId | String | 必须 | 订单号 |
返回结果说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| code | Int | 操作结果返回代码 |
| subMessage | String | 错误描述 |
| data | String | 返回结果 |
返回数据示例：
{
"data": “成功”,
"subMesssage": "",
"code": 0
}
3.3 订单详情
接口说明：
| Method | TestURL | ContentType |
|---|---|---|
| Post | /api/order/orderdetail | application/json |
参数说明：
| 参数 | 类型说明 | 是否必须 | 描述 |
|---|---|---|---|
| fromId | String | 必须 | 来源名称（待科力普提供） |
| token | String | 必须 | 签名 |
| orderId | String | 必须 | 订单号 |
返回结果说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| code | Int | 操作结果返回代码 |
| subMessage | String | 错误描述 |
| data | Object | 返回结果 |
data说明：
| 参数 | 类型说明 | 参数说明 |
|---|---|---|
| soid | String | 订单编号 |
| customerCode | String | 会员编号 |
| purchaser | String | 下单人 |
| orderPrice | Decimal | |
| freightPrice | Decimal | 运费 |
| remark | String | 备注 |
| createTime | String | 下单时间 |
| updateTime | String | 修改时间 |
| userEmail | String | 下单人邮箱 |
| extend | String | 扩展信息 |
| fromId | String | 来源编码 |
| title | String | 开票抬头 |
| contactName | String | 收货人 |
| contactPhone | String | 收货人电话 |
| contactMobile | String | 收货人手机 |
| provinceName | String | 省 |
| cityName | String | 市 |
| districtName | String | 区 |
| address | String | 地址 |
| status | Int | 订单状态 -2：预占 -1：待处理 0：代发货 4：退换货中 6：退换货完成 20：已出库 30：妥投完成 45：已签收 |
| items | List | 订单明细 |
item说明：
| 参数 | 类型说明 | 参数说明 |
|---|---|---|
| itemSkuCode | String | 商品编号 |
| itemSkuFullName | String | 商品名称 |
| price | Decimal | 单价 |
| quantity | String | 数量 |
| unitName | String | 单位 |
| priceRate | Decimal | 税率 |
返回数据示例：
{
"code": 0,
"subMessage": "",
"data": {
"soid": "zhihu_P0000033176",
"customerCode": "20242219",
"orderPrice": 24.78,
"freightPrice": 0,
"remark": "",
"createTime": "2022-09-2216:38:21",
"updateTime": "2022-09-2216:38:21",
"status": -2,
"userEmail": "",
"extend": "",
"purchaser": "Test",
"fromId": "zhihu",
"contactName": "张三",
"contactPhone": "",
"contactMobile": "13100000000",
"provinceName": "上海",
"cityName": "上海市",
"districtName": "黄浦区",
"address": "测试地址",
"title": "知乎有限公司",
"items": [
{
"itemSkuCode": "156018",
"itemSkuFullName": "3M 报事贴 656P 51*76mm (蓝绿色) 100页/本 12本/包",
"unitName": "本",
"quantity": 1,
"price": 24.78,
"priceRate": 0.13
}
]
}
}
3.4 订单批量查询
接口说明：
| Method | TestURL | ContentType |
|---|---|---|
| Post | /api/order/search | application/json |
参数说明：
| 参数 | 类型说明 | 是否必须 | 描述 |
|---|---|---|---|
| fromId | String | 必须 | 来源名称（待科力普提供） |
| token | String | 必须 | 签名 |
| orderId | String | 非必须 | 订单号 |
| purchaser | String | 非必须 | 下单人 |
| status | Int | 非必须 | 订单状态 |
| startTime | String | 非必须 | 下单开始时间（yyyyy-MM-dd） |
| endTime | String | 非必须 | 下单结束时间（yyyyy-MM-dd） |
| pageIndex | Int | 必须 | 页码 |
| pageSize | Int | 必须 | 每页显示条数 |
返回结果说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| code | Int | 操作结果返回代码 |
| subMessage | String | 错误描述 |
| total | Int | 总条数 |
| pageIndex | Int | 页码 |
| pageSize | Int | 每页显示条数 |
| pageCount | Int | 总页数 |
| data | List | 返回结果，json或数组 |
data说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| soMaster | Object | 订单主体 |
| soItems | List | 订单明细 |
soMaster说明：
| 参数 | 类型说明 | 参数说明 |
|---|---|---|
| soid | String | 订单编号 |
| purchaser | String | 下单人 |
| orderPrice | Decimal | |
| freightPrice | Decimal | 运费 |
| remark | String | 备注 |
| createTime | Date | 下单时间 |
| extend | String | 扩展信息 |
| status | Int | 订单状态 -2：预占 -1：待处理 0：代发货 4：退换货中 6：退换货完成 20：已出库 30：妥投完成 45：已签收 |
soItem说明：
| 参数 | 类型说明 | 参数说明 |
|---|---|---|
| itemSkuCode | String | 商品编号 |
| itemSkuFullName | String | 商品名称 |
| price | Decimal | 单价 |
| quantity | Int | 数量 |
| unitName | String | 单位 |
| priceRate | Decimal | 税率 |
返回数据示例：
{
"soMaster": {
" soid ": "1000000001",
" punchaser": "张三",
" orderPrice": 100.00,
" freightPrice ": 0,
" remark ": "备注信息",
" createTime ": "2022-09-29 17:18:22.493",
" extend ": "",
" status ": 20
}，
" soItems ": [
{
“ itemSkuCode”: “ 209044”,
“ itemSkuFullName”: “ 惠普HP 硒鼓双包装 CC388AD(黑色)”,
“ price”: 60.00,
“ quantity”: 1,
“ unitName”: “盒”,
“ priceRate”: 0.13
},
{
“ itemSkuCode”: “ 201003”,
“ itemSkuFullName”: “ Askul超值标准型复印纸优化版 A4 70g 1包”,
“ price”: 40.00,
“ quantity”: 1,
“ unitName”: “包”,
“ priceRate”: 0.13
}
]
"subMesssage": "",
"code": 0，
"total": "1",
"pageIndex": "1",
"pageSize": "30",
"pageCount": "1"
}
3.6 订单确认收货
接口说明：
| Method | TestURL | ContentType |
|---|---|---|
| Post | /api/order/receiveconfirm | application/json |
参数说明：
| 参数 | 类型说明 | 是否必须 | 描述 |
|---|---|---|---|
| fromId | String | 必须 | 来源名称（待科力普提供） |
| token | String | 必须 | 签名 |
| orderId | String | 必须 | 订单号 |
返回结果说明：
| 参数 | 类型说明 | 描述 |
|---|---|---|
| code | Int | 操作结果返回代码 |
| subMessage | String | 错误描述 |
| data | String | 返回结果 |
返回数据示例：
{
"data": “成功”,
"subMesssage": "",
"code": 0
}