API开放平台

TIP

分销或者直营发货单相关数据同步
直营发货单运输信息相关数据推送
直营发货单签收设置数据同步

# 分销或者直营发货单相关数据同步

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
			"id": "7226306356013346628",
			"status": "1",
			"sent_no": "FH201612010001",
			"purchase_no": "CK201612010001",
			"order_no": "FX201612010001",
			"order_id": "7226306356013346628",
			"date": "2016-12-01",
			"order_amount": "10.00",
			"order_discount_amount": "2.00",
			"emp_dept_id": "6173157522867102283",
			"emp_dept_name": "市场部",
			"emp_dept_code": "DP00001",
			"emp_dept_source_code": "000001",
			"emp_id": "6360879952207158181",
			"emp_code": "EMP0001",
			"emp_name": "张明",
			"emp_source_code": "000001",
			"send_time_str": "2016-12-01 00:00:00",
			"send_id": "4786443529856258791",
			"send_name": "张三",
			"send_code": "EMP0001",
			"send_source_code": "EMP0001",
			"cm_id": "4786443529856258791",
			"cm_code": "CUS00001",
			"cm_name": "南京苏果超市",
			"cm_source_code": "0001",
			"cm_dept_id": "5479044577173277483",
			"cm_dept_name": "南京市场部",
			"cm_dept_code": "DP0001",
			"cm_dept_source_code": "00001",
			"sign_status": "CG_DFH",
			"order_status": "CG_DFH",
			"purchase_status": "CG_DFH",
			"consignment_date": "2016-12-01",
			"supply_id": "4786443529856258791",
			"supply_name": "CUS00001",
			"supply_code": "南京苏果超市",
			"supply_source_code": "0001",
			"receive_name": "李四",
			"receive_phone": "18254623212",
			"receive_tel": "02589652314",
			"receive_addr": "江苏省南京建邺区云龙山路66号",
			"remark": "请尽快送货",
			"from_storehouse": "4786443529856258791",
			"from_storehouse_name": "仓库1",
			"from_storehouse_code": "ck001",
			"order_type": "ZY",
			"trade_type": "2",
            "instead_dispatch_cm_code": "CUS010058",
            "sent_receive_code": "CUS000003",
			"prods": 
			[
			      {
			            "detail_id": "4843786111936788462",
			            "order_detail_id": "4843786111936788462",
			            "product_id": "4843786111936788462",
			            "product_name": "商品1",
			            "product_code": "P0001",
			            "product_source_code": "P0001",
			            "order_price": "10.00000000",
			            "order_count": "20.00000000",
			            "order_input_unit": "8215768532653672550",
			            "order_input_unit_name": "箱",
			            "base_unit": "6930792320160995628",
			            "base_unit_name": "瓶",
			            "order_base_unit_count": "120.00000000",
			            "order_amount": "200.00",
			            "order_discount_amount": "10.00",
			            "is_gift": "N",
			            "sent_input_unit": "8215768532653672550",
			            "sent_input_unit_name": "箱",
			            "sent_base_unit_num": "20.0000"
			}
			]
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	单据ID
status	VARCHAR(1)	否	0：已删除，1：正常
sent_no	VARCHAR(100)	否	发货单编号
purchase_no	VARCHAR(100)	否	直营订单号
order_no	VARCHAR(100)	否	分销订单号
order_id	VARCHAR(32)	否	对应的分销或者直营单id
date	TIMESTAMP	否	单据业务日期，yyyy-mm-dd格式
order_amount	NUMERIC(18,2)	否	单据金额
all_sent_actual_amount	NUMERIC(18,2)	否	应支付金额
order_discount_amount	NUMERIC(18,2)	否	单据优惠金额
emp_dept_id	VARCHAR(32)	否	业务员下单时候所在的部门id
emp_dept_name	VARCHAR(100)	否	业务员下单时候所在的部门名称
emp_dept_code	VARCHAR(100)	否	业务员下单时候所在的部门编码
emp_dept_source_code	VARCHAR(100)	否	业务员下单时候所在的部门对应外部数据id
emp_id	VARCHAR(32)	否	单据业务员id
emp_code	VARCHAR(100)	否	员工编码
emp_name	VARCHAR(100)	否	单据业务员名称
emp_source_code	VARCHAR(100)	否	单据业务员对应外部数据id
send_time_str	VARCHAR(32)	否	发货单发货时间，yyyy-mm-dd hh24:mi:ss格式
send_id	VARCHAR(32)	否	发货人id
send_name	VRACHAR(100)	否	发货人名称
send_code	VRACHAR(100)	否	发货人编码
send_source_code	VRACHAR(100)	否	发货人对应外部数据id
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHAR(100)	否	客户编码
cm_name	VARCHAR(100)	否	客户名称
cm_source_code	VARCHAR(100)	否	客户对应外部数据id
cm_dept_id	VARCHAR(32)	否	下单时候客户所在的部门id
cm_dept_name	VARCHAR(100)	否	下单时候客户所在部门的名称
cm_dept_code	VARCHAR(100)	否	下单时候客户所在部门的编码
cm_dept_source_code	VARCHAR(100)	否	下单时候客户所在的部门对应外部数据id
sign_status	varchar(32)	否	发货单状态。FH_DQS：待签收，FH_YQS:已签收
order_status	varchar(32)	否	销售订单状态。XS_DFH、待发货，XS_DQS:待签收，XS_YWC：已完成，XS_DQR：待确认，XS_YQX：已取消，XS_FHZ：发货中
purchase_status	varchar(32)	否	直营订单状态。CG_DFH：待发货，CG_DRK：待入库，CG_YWC:：已完成，CG_DQR：待确认，CG_YQX：已取消，CG_FHZ：发货中
consignment_date	VARCHAR(32)	否	要求送货日期。格式：yyyy-mm-dd
supply_id	VARCHAR(32)	否	供货商id。-1或者空就是没有供货商
supply_name	VARCHAR(100)	否	供货商名称
supply_code	VARCHAR(100)	否	供货商编码
supply_source_code	VARCHAR(100)	否	供货商第三方id
receive_name	varchar(1000)	否	收货人名称。注：此处收货人信息是由业务员在下单时选择或手工输入
receive_phone	varchar(100)	否	收货人手机号码
receive_tel	varchar(100)	否	收货人电话
receive_addr	varchar(4000)	否	收货地址
remark	varchar(4000)	否	备注
from_storehouse	VARCHAR(32)	否	发货仓库id
from_storehouse_name	VARCHAR(100)	否	发货仓库名称
from_storehouse_code	VARCHAR(100)	否	发货仓库编码
order_type	varchar(20)	否	单据类型，ZY:直营，FX:分销
trade_type	VARCHAR(32)	否	客户类型2：经销商，3：终端门店
instead_dispatch_cm_code	varchar(32)	否	配送商编码
sent_receive_code	varchar(32)	否	收货方编码
exts	List	否	发货主数据自定义字段集合
exts.ext_key	VARCHAR(100)	否	发货主数据自定义字段名称
exts.ext_value	TEXT	否	发货主数据自定义字段数据值
exts.ext_column	List	否	发货主数据自定义字段code编码
prods	List
prods.detail_id	VARCHAR(32)	是	货子表id
prods.order_detail_id	VARCHAR(32)	否	分销单或直营单的子表id
prods.product_id	varchar(32)	否	商品id
prods.product_name	varchar(4000)	否	商品名称
prods.product_code	varchar(4000)	否	商品编码
prods.product_source_code	varchar(4000)	否	商品对应外部数据id
prods.standard_price	numeric(28,8)	否	商品标准价
prods.posnr	numeric(10)	否	发货商品的序号
prods.order_price	numeric(28,8)	否	价格
prods.order_count	numeric(28,8)	否	数量
prods.order_input_unit	VARCHAR(32)	否	下单时候录入单位id
prods.order_input_unit_name	VARCHAR(100)	否	下单时候录入单位名称
prods.base_unit	VARCHAR(32)	否	下单时候商品基本单位id
prods.base_unit_name	VARCHAR(100)	否	下单时候商品基本单位名称
prods.order_base_unit_count	numeric(28,8)	否	数量转化成基本单位以后的数量
prods.order_amount	numeric(10,2)	否	金额
prods.order_discount_amount	numeric(10,2)	否	优惠金额
prods.is_gift	varchar(2)	否	是否是赠品Y:是 N：否
prods.sent_num	numeric(28,8)	否	发货数量
prods.sent_input_unit	VARCHAR(32)	否	发货单位
prods.sent_input_unit_name	VARCHAR(100)	否	发货单位名称
prods.sent_base_unit_num	numeric(28,8)	否	发货数量转化成基本单位的数量
prods.exts	List	否	发货详情自定义字段集合
prods.exts.ext_key	VARCHAR(100)	否	发货详情自定义字段名称
prods.exts.ext_value	TEXT	否	发货详情自定义字段数据值
prods.exts.ext_column	VARCHAR(100)	否	发货详情自定义字段code编码
waybilllogs	List	否
waybilllogs.bill_code	VARCHAR(100)	否	运单号
waybilllogs.driver_name	VARCHAR(32)	否	司机姓名
waybilllogs.driver_phone	VARCHAR(32)	否	司机联系电话
waybilllogs.car_no	VARCHAR(32)	否	车牌号码
waybilllogs.delivery_date	TIMESTAMP	否	预计送达时间。格式yyyy-mm-dd hh24:mi:ss
waybilllogs.remark	TEXT	否	备注

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

参数说明：

参数	说明
return_code	响应编码
return_msg	响应消息内容
msg_id	消息ID

# 直营发货单运输信息相关数据推送

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
			"id": "7226306356013346628",
			"status": "1",
			"creator_id": "5479044577173277483",
			"create_time": "2016-12-01 00:00:00",
			"modifyier_id": "5479044577173277483",
			"modify_time": "2016-12-01 00:00:00",
			"bill_code": "5479044577173277483",
			"driver_name": "李四",
			"driver_phone": "18395573679",
			"car_no": "5479044577173277483",
			"delivery_date": "2016-12-01 00:00:00",
			"remark": "测试！",
			"orderSents": 
			[
			      {
			            "id": "4843786111936788462",
			            "status": "1",
			            "creator_id": "4843786111936788462",
			            "create_time": "2016-12-01 00:00:00",
			            "modifyier_id": "4843786111936788462",
                        "modify_time": "2016-12-01 00:00:00",
			            "sent_id": "8215768532653672550",
			            "sent_no": "TC1234556789",
			            "waybill_id": "7226306356013346628",
			            "sent_date": "2016-12-01 00:00:00"
                }
			],
            "exts":[
                {
                    "ext_key": "自定义字段1",
                    "ext_value": "自定义值1"
                },
                {
                    "ext_key": "自定义字段2",
                    "ext_value": "自定义值2"
                }
            ]
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	运输信息ID
status	VARCHAR(1)	否	0：已删除，1：正常
creator_id	VARCHAR(32)	否	运输信息创建人id
create_time	VARCHAR(100)	否	运输信息创建时间,"2016-12-01 00:00:00"
modifyier_id	VARCHAR(32)	否	运输信息修改人id
modify_time	VARCHAR(100)	否	运输信息修改时间,"2016-12-01 00:00:00"
bill_code	VARCHAR(100)	否	运单号
driver_name	VARCHAR(100)	否	司机名称
driver_phone	VARCHAR(100)	否	司机手机号
car_no	VARCHAR(100)	否	车牌号
delivery_date	VARCHAR(100)	否	送达日期,"2016-12-01 00:00:00"
remark	VARCHAR(100)	否	备注
orderSents	List
orderSents.id	VARCHAR(32)	是	关联表id
orderSents.status	varchar(1)	否	0：已删除，1：正常
orderSents.creator_id	varchar(32)	否	关联表创建人id
orderSents.create_time	varchar(100)	否	创建时间,"2016-12-01 00:00:00"
orderSents.modifyier_id	varchar(32)	否	关联表修改人id
orderSents.modify_time	varchar(100)	否	关联表修改时间,"2016-12-01 00:00:00"
orderSents.sent_id	varchar(32)	否	发货单id
orderSents.sent_no	VARCHAR(100)	否	发货单号
orderSents.waybill_id	VARCHAR(32)	否	运输信息id
orderSents.sent_date	VARCHAR(100)	否	发送时间
orderSents.freight_amount	VARCHAR(100)	否	发货单分摊运费
exts	List	否	运单主信息扩展字段列表
exts.ext_key	varchar(4000)	否	运单主信息扩展字段key值扩展字段需先在我方系统中创建
exts.ext_value	varchar(4000)	否	扩展字段value值对多个选项值，以“,”分隔拼接

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

参数说明：

参数	说明
return_code	响应编码
return_msg	响应消息内容
msg_id	消息ID

# 直营发货单签收设置数据同步

请求方式： POST（HTTPS）
请求地址： 第三方服务接口URL
请求示例：

{
			"id": "7226306356013346628",
			"status": "1",
			"customer_range": "2",
			"sign_method": "MESSAGES_SIGNATURE",
			"create_time": "2022-08-15 16:05",
			"modify_time": "",
			"cm_id": "2016-12-01",
			"cm_code": "10.00",
			"cm_name": "2.00",
			"districtList":
			[
			    {
                    "code":"",
                    "name":"",
                    "id":""
                }	
			],
			"deptList":
            [
            	{
                    "code":"lhmfxb",
                    "name":"南京市加菲猫系列有限责任公司",
                    "id":"10"
                }		
            ],
            "typeList":
            [
                {
                    "code":"",
                    "name":"",
                    "id":""
                }	        			
            ],
            "levelList":
            [
                {
                    "name":"",
                    "id":""
                }	                    			
            ]
}

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	主键id
status	VARCHAR(1)	是	0：已删除，1：正常, 如果已删除此字段下的所有字段信息不推送
create_time	VARCHAR(2)	是	创建时间。格式：yyyy-MM-dd HH:mm:ss
modify_time	VARCHAR(2)	否	修改时间。格式：yyyy-MM-dd HH:mm:ss
sign_method	VARCHAR(2)	是	签收方式。ELECTRONIC_SEAL：客户使用电子签章方式签收；MESSAGES_SIGNATURE：客户使用短信+手写签字方式签收；APPOWNER_SIGN：客户点“签收”按钮即视同已签收
customer_range	VARCHAR(2)	是	客户范围。1：指定具体客户；2：按客户属性设置范围
cm_id	VARCHAR(32)	否	客户id。customer_range = 1
cm_code	VARCHAR(100)	否	客户编码。customer_range = 1
cm_name	VARCHAR(100)	否	客户名称。customer_range = 1
districtList	List	否	销售区域列表
districtList.id	VARCHAR(32)	否	销售区域id
districtList.code	VARCHAR(100)	否	销售区域编码
districtList.name	varchar(100)	否	销售区域名称
deptList	List	否	客户部门列表
deptList.id	VARCHAR(32)	否	客户部门id
deptList.code	VARCHAR(100)	否	客户部门编码
deptList.name	varchar(100)	否	客户部门名称
typeList	List	否	客户类型列表
typeList.id	VARCHAR(32)	否	客户类型id
typeList.code	VARCHAR(100)	否	客户类型编码
typeList.name	varchar(100)	否	客户类型名称
levelList	List	否	客户级别列表
levelList.id	VARCHAR(32)	否	客户级别id
levelList.name	VARCHAR(100)	否	客户级别名称

响应示例：

{
    "return_code": 0,
    "return_msg": "",
    "msg_id": "X0001"
}

参数说明：

参数	说明
return_code	响应编码
return_msg	响应消息内容
msg_id	消息ID

← 发货单相关接口签收单接口 →