订单相关接口--字段描述汇总

主订单

一级字段名称	二级字段名称	三级字段名称	四级字段名称	字段释义	数据类型	必填
external_order_id				外部商家订单号	string	Y
create_time				订单创建时间，unix时间戳字段长度为 10 字节或者长度为 13 字节	string	Y
order_source				订单来源,枚举值: 商家小程序：wxapp 商家app：app 商家H5：mobileweb 商家pcweb：pcweb 线下人工pos：offstore_pos_manual 线下自助收银：offstore_pos_self_help 其他：other	string	Y
order_type				订单类型 1：普通订单 2：充值订单 3：消费订单普通购买商品订单传1即可	integer	Y
brand_id				订单品牌id	string
brand_name				订单品牌名称	string
goods_num_total				订单商品总数量	int	Y
goods_weight				订单商品总重量，默认单位为克	float
goods_amount_total				商品总金额，单位默认为元注：已含单品级别优惠的商品金额，如单品直降	float	Y
freight_amount				订单运费，单位默认为元注：运费为0时，传0.00	float	Y
order_amount				订单金额，单位默认为元注：商品总金额+运费金额=订单金额	float	Y
payable_amount				订单应付金额，单位默认为元注：订单金额-订单级别的优惠金额（如：订单满减）=订单应付金额	float	Y
payment_amount				实付金额，单位默认为元注：订单应付金额-支付优惠金额（如：微信支付优惠、招商银行优惠等）=订单实付金额	float	Y
order_status				主订单状态，[枚举详情] 枚举列表详见后面描述，1110待支付，1120已支付待审核，1220已支付待审核取消，1130未支付取消，1140已支付未发货取消，1150已支付待发货，1160已发货，1170拒收退货，1180销售完成/已收货1280退款中，1290退货完成，9999其他	string	Y
user_info				用户信息，json格式	object	Y
	open_id			下单人open_id，order_source = wxapp时，必填	string
	app_id			小程序或公众号的appid	string
	union_id			下单人union_id	string
	user_phone			下单人手机号	string
	user_id			下单人用户id	string
	member_id			下单人会员号	string
	user_first_order_time			下单人在KA注册后首次下单时间，格式为UNIX时间戳字段长度为 10 字节或者长度为 13 字节	string
goods_info[]				订单商品信息，数组类型，每个sku存一个数组单位	array
	external_sku_id			sku编号	string	Y
	sku_name_chinese			sku名称	string	Y
	goods_amount			单件商品原价	float	Y
	payment_amount			多件商品实付金额（分摊了优惠的金额）	float	Y
	is_gift			是否赠品，0代表非赠品，1代表赠品	int
	external_spu_id			sku所属spu编号，若无spu，传输内容请与external_sku_id保持一致	string	Y
	spu_name_chinese			spu名称，若无spu，传输内容请与 sku_name_chinese保持一致	string	Y
	sale_unit			商品售卖单位	string
	category_id			末级类目ID	string
	category_name			末级类目名称	string
	goods_num			商品数量	int	Y
	goods_weight			商品重量，单位默认为克	float
	store_info			主订单销售门店信息，数组类型	object
		external_store_id		主订单销售门店id	string
		store_name		主订单销售门店名称	string
		store_city		主订单销售门店所属城市	string
	chan_info			主订单来源渠道，数组类型	array
		chan_wxapp		小程序渠道	object
			chan_scene	小程序场景取值	string
		chan_custom		自定义渠道	object
			chan_custom_id	4级自定义渠道的标识符，4级是自定义渠道的最小粒度,例如	string
			chan_custom_id_desc	4级自定义渠道的描述	string
			chan_custom_cat_3	3级自定义渠道的标识符，3级是针对4级的分类，要求4级数据必须存在	string
			chan_custom_cat_3_desc	3级自定义渠道的描述，若chan_custom_cat_3存在则必须存在	string
			chan_custom_cat_2	2级自定义渠道的标识符，2级是针对4级的分类，要求4级数据必须存在	string
			chan_custom_cat_2_desc	2级自定义渠道的描述，若chan_custom_cat_3存在则必须存在	string
			chan_custom_cat_1	1级自定义渠道的标识符，2级是针对4级的分类，要求4级数据必须存在	string
			chan_custom_cat_1_desc	1级自定义渠道的描述，若chan_custom_cat_3存在则必须存在	string
		chan_refer_app_id		来源小程序或公众号appid	string
		chan_id		引流渠道编码	string
	commission_info[]			佣金，json字符串	array
		commission_type		佣金类型，枚举值如下：1：按比例提成；2：按金额提成	int
		commission_fee		佣金金额，单位元	float
promotion_info[]				子订单商品参与的活动信息，数组类型	array
	promotion_type			活动类型，枚举值如下：1：订单满减；2：订单满折；3：订单赠品；4：订单积分；5：单品降价；6：单品打折；7：单品赠品；8：单品积分；9：X件N折；10：X元N件；11：拼团	int
	external_promotion_id			活动ID	string
	promotion_name			活动名称（KA内部的促销活动编码）	string
	promotion_amount			主订单维度的活动优惠金额，单位默认为元	float
coupon_info[]				主订单用到的券信息，数组类型	array
	coupon_type			卡券类型，[枚举详情] 枚举值：1：商家券；2：微信支付券	int	Y
	coupon_amount_total			该类券优惠金额总额，单位默认为元	float	Y
	coupon_detail[]			该类券的detail券信息	array
		external_coupon_id		券ID	string
		coupon_batch_id		卡券批次ID（该字段需要在spa的优惠券接口中添加卡券批次）	string
		coupon_name		券名称	string
		coupon_amount		该张券优惠金额，单位默认为元	float	Y
payment_info[]				订单每种支付方式的支付信息,order_status = 1110,1130时 payment_info非必填，其他状态码必填。	array
	payment_type			支付方式，[枚举详情] 枚举列表详见文章后描述	string	Y
	trans_id			微信支付订单ID/流水号	string	Y
	trans_amount			金额，单位默认为元	float	Y
express_info				快递信息	object
	logistics_status			订单物流状态，[枚举详情] 枚举列表详见文章后描述	string
	goods_total_weight			商品总重量，单位默认为克	float
	receiver_name			收件人姓名	string
	receiver_phone			收件人联系电话	string
	receiver_address			收件人地址	string
	receiver_country_code			国家编码	string
	receiver_province_code			省份编码	string
	receiver_city_code			城市编码	string
	receiver_district_code			区编码	string
	expected_delivery_time			期望送货时间段，格式为“起始时间-结束时间”，如"9:00-12:00"	string
	expected_delivery_date			期望送货日期，格式“YYYYMMDD”	string
	express_package_info[]			包裹信息，struct类型	array
		express_company_code		物流公司编码，枚举类型，枚举值请参见文章后面的“物流商CODE”	string
		express_company_name		物流公司名称	string
		express_code		运单号	string
		ship_time		发货时间，格式为时间戳字段长度为 10 字节或者长度为 13 字节	string
		express_page		运费跳转页面，json字符串	object
			miniprogram_path	快递详情页跳转链接（小程序页面，小程序填此字段）	string
			miniprogram_appid	小程序APPID，填写了miniprogram_path需填此字段	string
			miniprogram_h5	快递详情页跳转链接（h5页面，公众号填此字段）	string
		express_package_info[]			array
			external_sku_id	商品sku ID	string
			number	商品数量	int
invoice[]				发票信息，类型为数组	array
	if_need_invoice			是否需要发票，true代表需要，false代表不需要	boolean
	invoice_type			发票类型，枚举值，取值如下： 1000(增值税专用发票) 1001(普通发票) 1002(机动车专用发票) 1003(机打发票) 1004(定额发票 ) 1005(剪开式发票) 1006（其他）	string
	invoice_title			发票抬头	string
	invoice_content			发票内容	string
	invoice_addition_info			发票附加信息	string
	invoice_company			公司名称	string
	invoice_taxpayer			纳税人识别号	string
	registry_address			注册地址	string
	registry_phone			注册电话	string
	registry_bank_name			开户银行	string
	registry_bank_account			开户账号	string
	invoice_delivery_address			发票收件地址	string
	invoice_delivery_name			发票收件人姓名	string
	invoice_delivery_phone			发票收件人电话	string
	invoice_num			发票号码	string
points_total				订单赠送总积分	float
is_deleted				商家标记订单已删除，0-未删除，1-已删除	int	Y

子订单

一级字段名称	二级字段名称	三级字段名称	四级字段名称	字段释义	数据类型	必填
external_sub_order_id				外部商家子订单号，默认“主订单号_ka的sku编码”为子订单号	string	Y
external_order_id				外部商家订单号	string	Y
create_time				订单创建时间，unix时间戳字段长度为 10 字节或者长度为 13 字节	string	Y
order_source				订单来源,枚举值: 商家小程序：wxapp 商家app：app 商家H5：mobileweb 商家pcweb：pcweb 线下人工pos：offstore_pos_manual 线下自助收银：offstore_pos_self_help 其他：other	string	Y
order_type				订单类型 1：普通订单 2：充值订单 3：消费订单普通购买商品订单传1即可	int	Y
brand_id				订单品牌id	string
brand_name				订单品牌名称	string
goods_num_total				订单商品总数量	int	Y
goods_weight				订单商品总重量，默认单位为克	float
goods_amount_total				商品总金额，单位默认为元注：已含单品级别优惠的商品金额，如单品直降	float	Y
freight_amount				订单运费，单位默认为元注：运费为0时，传0.00	float	Y
order_amount				订单金额，单位默认为元注：商品总金额+运费金额=订单金额	float	Y
payable_amount				订单应付金额，单位默认为元注：订单金额-订单级别的优惠金额（如：订单满减）=订单应付金额	float	Y
payment_amount				实付金额，单位默认为元注：订单应付金额-支付优惠金额（如：微信支付优惠、招商银行优惠等）=订单实付金额	float	Y
order_status				主订单状态，[枚举详情] 枚举列表详见后面描述，1110待支付，1120已支付待审核，1220已支付待审核取消，1130未支付取消，1140已支付未发货取消，1150已支付待发货，1160已发货，1170拒收退货，1180销售完成/已收货1280退款中，1290退货完成，9999其他	string	Y
user_info				用户信息，json格式	object	Y
	open_id			下单人open_id ，order_source = wxapp时，必填	string
	app_id			小程序或公众号的appid	string
	union_id			下单人union_id	string
	user_phone			下单人手机号	string
	user_id			下单人用户id	string
	member_id			下单人会员号	string
	user_first_order_time			下单人在KA注册后首次下单时间，格式为UNIX时间戳字段长度为 10 字节或者长度为 13 字节	string
goods_info[]				订单商品信息，数组类型，每个sku存一个数组单位	array
	external_sku_id			sku编号	string	Y
	sku_name_chinese			sku名称	string	Y
	goods_amount			单件商品原价	float	Y
	payment_amount			多件商品实付金额（分摊了优惠的金额）	float	Y
	is_gift			是否赠品，0代表非赠品，1代表赠品	int
	external_spu_id			sku所属spu编号，若无spu，传输内容请与external_sku_id保持一致	string	Y
	spu_name_chinese			spu名称，若无spu，传输内容请与 sku_name_chinese保持一致	string	Y
	sale_unit			商品售卖单位	string
	category_id			末级类目ID	string
	category_name			末级类目名称	string
	goods_num			商品数量	int	Y
	goods_weight			商品重量，单位默认为克	float
	store_info			主订单销售门店信息，数组类型	object
		external_store_id		主订单销售门店id	string
		store_name		主订单销售门店名称	string
		store_city		主订单销售门店所属城市	string
	chan_info			主订单来源渠道，数组类型	array
		chan_wxapp		小程序渠道	object
			chan_scene	小程序场景取值	string
		chan_custom		自定义渠道	object
			chan_custom_id	4级自定义渠道的标识符，4级是自定义渠道的最小粒度,例如
			chan_custom_id_desc	4级自定义渠道的描述
			chan_custom_cat_3	3级自定义渠道的标识符，3级是针对4级的分类，要求4级数据必须存在
			chan_custom_cat_3_desc	3级自定义渠道的描述，若chan_custom_cat_3存在则必须存在
			chan_custom_cat_2	2级自定义渠道的标识符，2级是针对4级的分类，要求4级数据必须存在
			chan_custom_cat_2_desc	2级自定义渠道的描述，若chan_custom_cat_3存在则必须存在
			chan_custom_cat_1	1级自定义渠道的标识符，2级是针对4级的分类，要求4级数据必须存在
			chan_custom_cat_1_desc	1级自定义渠道的描述，若chan_custom_cat_3存在则必须存在
		chan_refer_app_id		来源小程序或公众号appid	string
		chan_id		引流渠道编码	string
	commission_info[]			佣金，json字符串	array
		commission_type		佣金类型，枚举值如下：1：按比例提成；2：按金额提成	int
		commission_fee		佣金金额，单位元	float
promotion_info[]				子订单商品参与的活动信息，数组类型	array
	promotion_type			活动类型，枚举值如下：1：订单满减；2：订单满折；3：订单赠品；4：订单积分；5：单品降价；6：单品打折；7：单品赠品；8：单品积分；9：X件N折；10：X元N件；11：拼团	int
	external_promotion_id			活动ID	string
	promotion_name			活动名称（KA内部的促销活动编码）	string
	promotion_amount			主订单维度的活动优惠金额，单位默认为元	float
coupon_info[]				主订单用到的券信息，数组类型	array
	coupon_type			卡券类型，[枚举详情] 枚举值：1：商家券；2：微信支付券	int	Y
	coupon_amount_total			该类券优惠金额总额，单位默认为元	float	Y
	coupon_detail[]			该类券的detail券信息	array
		external_coupon_id		券ID	string
		coupon_batch_id		卡券批次ID（该字段需要在spa的优惠券接口中添加卡券批次）	string
		coupon_name		券名称	string
		coupon_amount		该张券优惠金额，单位默认为元	float	Y
payment_info[]				订单每种支付方式的支付信息,order_status = 1110,1130时 payment_info非必填，其他状态码必填。	array
	payment_type			支付方式，[枚举详情] 枚举列表详见文章后描述	string	Y
	trans_id			微信支付订单ID/流水号	string	Y
	trans_amount			金额，单位默认为元	float	Y
express_info				快递信息	object
	logistics_status			订单物流状态，[枚举详情] 枚举列表详见文章后描述	string
	goods_total_weight			商品总重量，单位默认为克	float
	receiver_name			收件人姓名	string
	receiver_phone			收件人联系电话	string
	receiver_address			收件人地址	string
	receiver_country_code			国家编码	string
	receiver_province_code			省份编码	string
	receiver_city_code			城市编码	string
	receiver_district_code			区编码	string
	expected_delivery_time			期望送货时间段，格式为“起始时间-结束时间”，如"9:00-12:00"	string
	expected_delivery_date			期望送货日期，格式“YYYYMMDD”	string
	express_package_info[]			包裹信息，struct类型	array
		express_company_code		物流公司编码，枚举类型，枚举值请参见文章后面的“物流商CODE”	string
		express_company_name		物流公司名称	string
		express_code		运单号	string
		ship_time		发货时间，格式为时间戳字段长度为 10 字节或者长度为 13 字节	string
		express_page		运费跳转页面，json字符串	object
			miniprogram_path	快递详情页跳转链接（小程序页面，小程序填此字段）	string
			miniprogram_appid	小程序APPID，填写了miniprogram_path需填此字段	string
			miniprogram_h5	快递详情页跳转链接（h5页面，公众号填此字段）	string
		express_package_info[]			array
			external_sku_id	商品sku ID	string
			number	商品数量	int
invoice[]				发票信息，类型为数组	array
	if_need_invoice			是否需要发票，true代表需要，false代表不需要	boolean
	invoice_type			发票类型，枚举值，取值如下： 1000(增值税专用发票) 1001(普通发票) 1002(机动车专用发票) 1003(机打发票) 1004(定额发票 ) 1005(剪开式发票) 1006（其他）	string
	invoice_title			发票抬头	string
	invoice_content			发票内容	string
	invoice_addition_info			发票附加信息	string
	invoice_company			公司名称	string
	invoice_taxpayer			纳税人识别号	string
	registry_address			注册地址	string
	registry_phone			注册电话	string
	registry_bank_name			开户银行	string
	registry_bank_account			开户账号	string
	invoice_delivery_address			发票收件地址	string
	invoice_delivery_name			发票收件人姓名	string
	invoice_delivery_phone			发票收件人电话	string
	invoice_num			发票号码	string
points_total				订单赠送总积分	float
is_deleted				商家标记订单已删除，0-未删除，1-已删除	int	Y