4. 订单

4.1 订单查询

请求类型与路径

GET /api/v1/order/getByOrderCode 订单查询需要配合消息中心使用，首先根据消息中心推送的订单编号，然后利用订单查询接口，进行订单详情信息查询

请求参数

名称	方式	类型	长度	必须	描述
clientCode	requestParam	string	100	是	客户端编码
orderCode	requestParam	string	20	是	业务单据编码（采购单编码）

响应参数

名称	类型	长度	必须	描述
orderCode	string	20	是	业务单据编码（采购单编码）
orderDate	string	20	是	订单日期（yyyy-MM-dd HH:mm:ss）
expectDate	string	20	否	期望收货日期（yyyy-MM-dd HH:mm:ss）
orderStatus	string	2	是	订单状态（0:取消、20:新建、30:已发货、80:部分收货、90:完成）
~~branchId~~	~~int~~	4	是	~~科力普编码（已废弃）~~
vendorId	int	4	是	供应商Id
contractId	int	4	否	合同编号
salesOrderCode	string	100	否	科力普订单单号
deliveryOrderCode	string	100	否	科力普出库单号
platformOrderCode	string	100	否	客户平台单号
customerCode	string	200	否	客户编码
customerName	string	100		客户名称（科力普客户名称）
customerNote	string	200	否	客户留言
departmentName	string	100	否	成本中心（客户部门名称）
cooperationProjecName	string	100	否	合作项目名称
totalAmt	decimal	-	是	实收金额
orderAmt	decimal	-	是	采购金额
grossProfitPoints	decimal	-	是	采购毛利点(百分比)
orderItems	object[]	-	是	订单明细
orderExtend	object[]	-	是	订单拓展信息（键值对）
orderAddress	object	-	是	收货地址信息

订单明细（orderItem）【不能用skuCode直接取商品信息中的信息，那个是实时商品状态，这个是下单时的状态，】

名称	类型	长度	必须	描述
skuCode	string	100	是	商品编码（科力普商品编码）
skuName	string	300	是	商品名称
skuSpec	string	100	是	规格
skuModel	string	100	是	型号
skuUnit	string	10	是	商品单位
quantity	int	4	是	采购数量
price	decimal	19,6	是	采购价格（4位有效数字）
nakedPrice	decimal	19,6	是	采购未税价格
taxRate	decimal	19,6	是	税率（0，6，9，13）
taxCode	string	50	是	税收编码
salePrice	decimal	19,6	否	销售含税价格（科力普售卖给客户的价格，只有属地有）
saleNakedPrice	decimal	19,6	否	销售未税价格（科力普售卖给客户的价格，只有属地有）

订单拓展（orderExtend 键值对，后期针对不同供应商不同的需求需要拓展返回信息）

名称	类型	长度	必须	描述
orderCode	string	20	是	业务单据编码（采购单编码）
extendName	string	200	否	拓展字段名称
extendValue	string	200	否	拓展字段值

收货地址信息【orderAddres】

名称	类型	长度	必须	描述
contactName	string	100	是	联系人
mobilePhone	string	100	是	联系电话
provinceId	int	4	是	省
provinceName	string	50	是	省名称
cityId	int	4	是	市
cityName	string	50	是	市名称
districtId	int	4	是	区
districtName	string	50	是	区名称
address	string	200	是	详细地址

示例：

json

{
	"orderCode": "2001457555W",
	"totalAmt": 12.1252,
	"orderItems": [{
		"skuCode": "13839",
		"skuName": "A4打印纸80g",
		...
	}, {
		"skuCode": "15122",
		"skuName": "晨光签字笔",
		...
	}, ...],
	"orderAddress": {
		"contactName": "张三",
		"address": "上海市徐汇区古美路1528号A2幢11-12层",
		...
	}
}

4.2 订单发货

请求类型与路径

POST /api/v1/order/delivery

请求参数

名称	方式	类型	长度	必须	描述
orderCode	requestBody	string	20	是	业务单据编码（采购单编码）
clientCode	requestBody	string	100	是	客户端编码
deliveryType	requestBody	string	100	是	发货方式（1-自配； 2-3PL(快递)）
storehouseId	requestBody	int	4	否	发货仓库Id(3PL(快递)发货时无需填写)
deliveryInfo	requestBody	object	-	否	自配发货信息（自配必填）
deliveryParcel	requestBody	object[]	-	否	快递包裹列表（3PL(快递)必填）

快递包裹列表【deliveryParcel】

名称	类型	长度	必须	描述
expressId	int	4	是	快递公司编号
expressNum	string	40	是	快递单号
expressName	string	50	否	快递公司名称（如果不在我们提供的列表中，可以自定义输入）
weight	decimal	-	否	重量（千克）
volume	decimal	-	否	体积（立方分米）
driverId	int	20	否	快递司机编号
truckId	int	20	否	快递车辆编号

自配发货信息【deliveryInfo】

名称	类型	长度	必须	描述
truckId	string	20	否	车牌
driverId	int	4	否	司机
contactName	string	50	否	联系人
contactPhone	string	50	否	联系电话
weight	decimal	-	否	重量（千克）
volume	decimal	-	否	体积（立方分米）
note	string	500	否	发货备注

示例：

json

{
    "clientCode": "V0001",
    "deliveryType": "2",
    "orderCode": "2001465458W",
    "deliveryParcel": [
        {
            "expressId": 1,
            "expressNum": "DPH12323321",
            "expressName": "德邦",
            "driverId": 0,
            "truckId": 0
        }
    ]
}

响应参数

名称	类型	长度	必须	描述
-	boolean	-	是	true或false

4.3 上传签收文件

请求类型与路径

POST /api/v1/order/uploadSignFile 上传签收文件并签收

请求参数

名称	类型	长度	必须	描述
orderCode	string	20	是	业务单据编码（采购单编码）
clientCode	string	100	是	客户端编码
base64String	string	-	是	文件流Base64后的字符串
fileName	string	-	是	文件名

示例：

json

{
    "clientCode": "V0001",
    "orderCode": "2001457555W",
    "fileName": "20230111.jpg",
    "base64String": "iVBORw0KGgoAAAANSUhEUgAAA08AAAC...."
}

响应参数

名称	类型	长度	必须	描述
-	boolean	-	是	true或false

4.4 批量上传签收文件

请求类型与路径

POST /api/v1/order/batchUploadSignFile 批量上传签收文件并签收

请求参数

名称	方式	类型	长度	必须	描述
orderCode	requestBody	string	20	是	业务单据编码（采购单编码）
clientCode	requestBody	string	100	是	客户端编码
signFiles	requestBody	object[]	-	是	签收文件集合

签收文件文件【signFiles】

名称	类型	长度	必须	描述
base64String	string	-	是	文件流Base64后的字符串
fileName	string	-	是	文件名

示例：

json

{
	"clientCode": "V0001",
	"orderCode": "2001457555W",
	"signFiles": [{
		"fileName": "20230111.jpg",
		"base64String": "iVBORw0KGgoAAAANSUhEUgAAA08AAAC...."
	}, {
		"fileName": "20240813.jpg",
		"base64String": "iVBORw0KGgoAAAANSUhEUgAAA08AAAC...."
	}, { ......
	}]
}

响应参数

名称	类型	长度	必须	描述
-	boolean	-	是	true或false

4.5 签收确认（已废弃）

请求类型与路径

POST /api/v1/order/signConfirm 需提前调用上传签收文件功能

请求参数

名称	方式	类型	长度	必须	描述
clientCode	requestParam	string	100	是	客户端编码
orderCode	requestParam	string	20	是	业务单据编码（采购单编码）

响应参数

名称	类型	长度	必须	描述
-	boolean	-	是	true或false

4.6 查询退货采购单

请求类型与路径

GET /api/v1/return/getByReturnCode 订单查询需要配合消息中心使用，首先根据消息中心推送的订单编号，然后利用订单查询接口，进行订单详情信息查询

请求参数

名称	方式	类型	长度	必须	描述
clientCode	requestParam	string	100	是	客户端编码
returnCode	requestParam	string	20	是	业务单据编码（退货单编码）

响应参数

名称	类型	长度	必须	描述
returnCode	string	20	是	业务单据编码（退货单编码）
orderCode	string	20	是	业务单据编码（原采购单编码）
returnDate	string	20	是	退货日期（yyyy-MM-dd HH:mm:ss）
~~orderType~~	~~string~~	1	是	~~单据类型（常规、直送、属地）（已废弃）~~
orderStatus	string	1	是	单据状态（0:取消、20:新建、90:完成）
branchId	int	4	是	分公司Id
vendorId	int	4	是	供应商Id
contractId	int	4	否	合同编号
takeType	int	4	是	取件类型（1上门取件，2快递退回）
returnItems	object[]	-	否	退单明细
senderAddress	object	-	否	寄件人、发货地址【上面取件】

退单明细（SKU明细）【returnItem】

名称	类型	长度	必须	描述
skuCode	string	100	是	商品编码（科力普商品编码）
skuName	string	300	是	商品名称
skuUnit	string	50	是	商品单位
quantity	int	4	是	退货数量
price	decimal	-	是	含税价格（4位有效数字）
nakedPrice	decimal	-	是	未税价格
taxRate	decimal	-	是	税率（0，6，9，13）

发货地址信息、上面取件地址【senderAddres】 参考4.1订单查询的《收货地址信息【orderAddres】》

4.7 获取交货单

请求类型与路径

POST /api/v1/order/getReceiptByCode

请求参数

名称	方式	类型	长度	必须	描述
clientCode	requestParam	string	100	是	客户端编码
orderCode	requestParam	string	20	是	业务单据编码（采购单编码）

响应参数

名称	类型	长度	必须	描述
orderCode	string	20	是	业务单据编码
fileName	string	200	是	文件名称
fileCategory	string	50	是	交货单分类（RECEIPT:交货单、MARK:唛头）
fileType	string	50	是	说明：无需关注交货单类型，开发者按照接口返回的数据展示单据名称和链接即可。【国网定制交货单】 DeliveryAcceptanceForm:有盖章 DeliveryAcceptanceFormNostamped:无盖章 DeliveryHandoverForm:福建定制 SpecialFile:山东定制 HandleUpload：其他 OutboundForm：交货单&到货验收单（有盖章） OutboundFormNostamped：交货单&到货验收单(无盖章) OutboundFormSignWithStamped：交货单&到货验收单(盖章&签名) 【标准交货单】 PackingListForm:平台交货单 MarkPrintForm:唛头打印单 ColipuReceipt:科力普交货单
validityPeriod	string	20	是	访问有效期（yyyy-MM-dd HH:mm:ss）
remark	string	500	否	说明
createTime	string	20	是	创建时间（yyyy-MM-dd HH:mm:ss）
fileUrl	string	500	是	文件地址
示例：

json

`[
  {
	"orderCode": "2001457555W",
	"fileName": "国网商城 交货单和到货验收单(无盖章)PR7.pdf",
	"fileCategory": "RECEIPT",
	"fileType": "OutboundFormSignWithStamped",
	"fileUrl": "https://clpres.oss-cn-shanghai.aliyuncs.com/smb/vendor-app/temp/f03a44d8-3a1f-4789-bbd3-ddacf342385c.png"
 },
 { ......},
 { ......}
]

4. 订单 ​

4.1 订单查询 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.2 订单发货 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.3 上传签收文件 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.4 批量上传签收文件 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.5 签收确认（已废弃） ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.6 查询退货采购单 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4.7 获取交货单 ​

请求类型与路径 ​

请求参数 ​

响应参数 ​

4. 订单

4.1 订单查询

请求类型与路径

请求参数

响应参数

4.2 订单发货

请求类型与路径

请求参数

响应参数

4.3 上传签收文件

请求类型与路径

请求参数

响应参数

4.4 批量上传签收文件

请求类型与路径

请求参数

响应参数

4.5 签收确认（已废弃）

请求类型与路径

请求参数

响应参数

4.6 查询退货采购单

请求类型与路径

请求参数

响应参数

4.7 获取交货单

请求类型与路径

请求参数

响应参数