cainiaolocker

type AddressDto struct {
	// 城市，长度小于20
	City string `json:"city,omitempty" xml:"city,omitempty"`
	// 详细地址，长度小于256
	Detail string `json:"detail,omitempty" xml:"detail,omitempty"`
	// 区，长度小于20
	District string `json:"district,omitempty" xml:"district,omitempty"`
	// 省，长度小于20
	Province string `json:"province,omitempty" xml:"province,omitempty"`
	// 街道，长度小于30
	Town string `json:"town,omitempty" xml:"town,omitempty"`
}

type CainiaoEndpointLockerTopOrderNoticeAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopOrderNoticeAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopOrderNoticeAPIResponseModel
}

type CainiaoEndpointLockerTopOrderNoticeAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_order_notice_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// result
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoEndpointLockerTopOrderNoticesendQueryAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopOrderNoticesendQueryAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopOrderNoticesendQueryAPIResponseModel
}

type CainiaoEndpointLockerTopOrderNoticesendQueryAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_order_noticesend_query_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 返回结果
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoEndpointLockerTopOrderNoticesendQueryData struct {
	// 用于返回淘系包裹脱密手机号用作数据核对
	GetterPhone string `json:"getter_phone,omitempty" xml:"getter_phone,omitempty"`
	// 快递公司名称
	CpName string `json:"cp_name,omitempty" xml:"cp_name,omitempty"`
	// 快递公司编码
	CpCode string `json:"cp_code,omitempty" xml:"cp_code,omitempty"`
	// 裹裹发送通知消息标识，false-?非裹裹发送，true-裹裹发送
	GuoguoSendNoticeFlag bool `json:"guoguo_send_notice_flag,omitempty" xml:"guoguo_send_notice_flag,omitempty"`
	// 是否需要输入手机号，false-不需要，裹裹可以自己判断手机号，true-需要手动输入手机号
	NeedInputPhone bool `json:"need_input_phone,omitempty" xml:"need_input_phone,omitempty"`
}

type CainiaoEndpointLockerTopOrderTrackingNewAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopOrderTrackingNewAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopOrderTrackingNewAPIResponseModel
}

type CainiaoEndpointLockerTopOrderTrackingNewAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_order_tracking_new_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// result
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoEndpointLockerTopOrderWithholdAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopOrderWithholdAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopOrderWithholdAPIResponseModel
}

type CainiaoEndpointLockerTopOrderWithholdAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_order_withhold_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// result
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoEndpointLockerTopStationAddorupdateAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopStationAddorupdateAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopStationAddorupdateAPIResponseModel
}

type CainiaoEndpointLockerTopStationAddorupdateAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_station_addorupdate_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// result
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoEndpointLockerTopWithholdQueryAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoEndpointLockerTopWithholdQueryAPIResponse struct {
	model.CommonResponse
	CainiaoEndpointLockerTopWithholdQueryAPIResponseModel
}

type CainiaoEndpointLockerTopWithholdQueryAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_endpoint_locker_top_withhold_query_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// response
	Result *SingleResult `json:"result,omitempty" xml:"result,omitempty"`
}

type CainiaoGuoguoWaybillGetAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoGuoguoWaybillGetAPIResponse struct {
	model.CommonResponse
	CainiaoGuoguoWaybillGetAPIResponseModel
}

type CainiaoGuoguoWaybillGetAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_guoguo_waybill_get_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 系统自动生成
	Modules []WaybillCloudPrintNewResponse `json:"modules,omitempty" xml:"modules>waybill_cloud_print_new_response,omitempty"`
}

type CainiaoNbaddAppointdeliverFeedbackcodesAPIRequest struct {
	model.Params
}

type CainiaoNbaddAppointdeliverFeedbackcodesAPIResponse struct {
	model.CommonResponse
	CainiaoNbaddAppointdeliverFeedbackcodesAPIResponseModel
}

type CainiaoNbaddAppointdeliverFeedbackcodesAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_nbadd_appointdeliver_feedbackcodes_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 返回的具体数据
	ResultList []FeedbackCodeDto `json:"result_list,omitempty" xml:"result_list>feedback_code_dto,omitempty"`
	// 错误描述
	ResultDesc string `json:"result_desc,omitempty" xml:"result_desc,omitempty"`
	// 错误编码
	ResultCode string `json:"result_code,omitempty" xml:"result_code,omitempty"`
	// 接口调用是否成功
	IsSuccess bool `json:"is_success,omitempty" xml:"is_success,omitempty"`
}

type CainiaoNborderfrontUserOutsideQueryoutsideuserAPIRequest struct {
	model.Params
	// contains filtered or unexported fields
}

type CainiaoNborderfrontUserOutsideQueryoutsideuserAPIResponse struct {
	model.CommonResponse
	CainiaoNborderfrontUserOutsideQueryoutsideuserAPIResponseModel
}

type CainiaoNborderfrontUserOutsideQueryoutsideuserAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_nborderfront_user_outside_queryoutsideuser_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 返回错误编码
	RespCode string `json:"resp_code,omitempty" xml:"resp_code,omitempty"`
	// userInfo
	UserInfo *CainiaoNborderfrontUserOutsideQueryoutsideuserStruct `json:"user_info,omitempty" xml:"user_info,omitempty"`
}

type CainiaoNborderfrontUserOutsideQueryoutsideuserStruct struct {
	// cpUserId
	CpUserId string `json:"cp_user_id,omitempty" xml:"cp_user_id,omitempty"`
	// cpCode
	CpCode string `json:"cp_code,omitempty" xml:"cp_code,omitempty"`
	// 站点名称
	WorkStationName string `json:"work_station_name,omitempty" xml:"work_station_name,omitempty"`
	// 站点编码
	WorkStationCode string `json:"work_station_code,omitempty" xml:"work_station_code,omitempty"`
	// 支付宝账号
	AlipayAccount string `json:"alipay_account,omitempty" xml:"alipay_account,omitempty"`
	// 户名
	Name string `json:"name,omitempty" xml:"name,omitempty"`
	// 手机
	Mobile string `json:"mobile,omitempty" xml:"mobile,omitempty"`
	// 杭州
	CityName string `json:"city_name,omitempty" xml:"city_name,omitempty"`
	// 321000
	CityCode string `json:"city_code,omitempty" xml:"city_code,omitempty"`
}

type CollectTrackingInfo struct {
	// 站点id
	StationId string `json:"station_id,omitempty" xml:"station_id,omitempty"`
	// 订单对应的取件人电话
	GetterPhone string `json:"getter_phone,omitempty" xml:"getter_phone,omitempty"`
	// 订单对应的投件人电话
	PostPhone string `json:"post_phone,omitempty" xml:"post_phone,omitempty"`
	// 扩展数据（JSON格式的键值对），如果是取件码取件，请返回取件使用的取件码
	Extra string `json:"extra,omitempty" xml:"extra,omitempty"`
	// 站点编码
	StationNo string `json:"station_no,omitempty" xml:"station_no,omitempty"`
	// 运单号
	MailNo string `json:"mail_no,omitempty" xml:"mail_no,omitempty"`
	// 动作编码
	ActionCode string `json:"action_code,omitempty" xml:"action_code,omitempty"`
	// 站点订单编码
	OrderCode string `json:"order_code,omitempty" xml:"order_code,omitempty"`
	// 快递公司编号
	CpCode string `json:"cp_code,omitempty" xml:"cp_code,omitempty"`
	// 订单类型(0-代收业务)
	OrderType int64 `json:"order_type,omitempty" xml:"order_type,omitempty"`
	// 动作发生时间戳，单位：毫秒
	ActionTime int64 `json:"action_time,omitempty" xml:"action_time,omitempty"`
}

type FeedbackCodeDto struct {
	// 异常反馈编码
	FeedbackCode string `json:"feedback_code,omitempty" xml:"feedback_code,omitempty"`
	// 异常反馈编码描述
	FeedbackDesc string `json:"feedback_desc,omitempty" xml:"feedback_desc,omitempty"`
}

type Item struct {
	// 名称
	Name string `json:"name,omitempty" xml:"name,omitempty"`
	// 数量
	Count int64 `json:"count,omitempty" xml:"count,omitempty"`
}

type OrderInfoDto struct {
	// 外部电商平台交易子单号集合，非必填，数量限制100
	OutTradeSubOrderList []string `json:"out_trade_sub_order_list,omitempty" xml:"out_trade_sub_order_list>string,omitempty"`
	// 外部电商平台交易单号集合，非必填，数量限制100
	OutTradeOrderList []string `json:"out_trade_order_list,omitempty" xml:"out_trade_order_list>string,omitempty"`
	// 订单号,数量限制100，订单号（只限传入数字、字母、下划线和中划线，为避免出现冲突，请按电商平台真实订单号传入，请避免使用同个订单号重复取号）
	TradeOrderList []string `json:"trade_order_list,omitempty" xml:"trade_order_list>string,omitempty"`
	// <a href="http://open.taobao.com/doc2/detail.htm?spm=a219a.7629140.0.0.8cf9Nj&treeId=17&articleId=105085&docType=1#2">订单渠道平台编码</a>
	OrderChannelsType string `json:"order_channels_type,omitempty" xml:"order_channels_type,omitempty"`
}

type PackageInfoDto struct {
	// 商品信息,数量限制为100
	Items []Item `json:"items,omitempty" xml:"items>item,omitempty"`
	// 大件快运中的包装方式描述
	PackagingDescription string `json:"packaging_description,omitempty" xml:"packaging_description,omitempty"`
	// 包裹id，用于拆合单场景（只能传入数字、字母和下划线；批量请求时值不得重复，大小写敏感，即123A,123a 不可当做不同ID，否则存在一定可能取号失败）
	Id string `json:"id,omitempty" xml:"id,omitempty"`
	// 大件快运中的货品描述，比如服装，家具。 顺丰取号必须传此参数
	GoodsDescription string `json:"goods_description,omitempty" xml:"goods_description,omitempty"`
	// 物品价值，单位元
	GoodValue string `json:"good_value,omitempty" xml:"good_value,omitempty"`
	// 包裹长，单位厘米
	Length int64 `json:"length,omitempty" xml:"length,omitempty"`
	// 重量,单位 g
	Weight int64 `json:"weight,omitempty" xml:"weight,omitempty"`
	// 子母件模式中的总包裹数/总件数，用于打印当前包裹处于总件数的位置比如5-2，可以表示总包裹数为5，当前为第2个包裹，只有快运公司需要传入，其他的可以不用传入
	TotalPackagesCount int64 `json:"total_packages_count,omitempty" xml:"total_packages_count,omitempty"`
	// 体积, 单位 ml
	Volume int64 `json:"volume,omitempty" xml:"volume,omitempty"`
	// 包裹宽，单位厘米
	Width int64 `json:"width,omitempty" xml:"width,omitempty"`
	// 包裹高，单位厘米
	Height int64 `json:"height,omitempty" xml:"height,omitempty"`
}

type SingleResult struct {
	// 错误描述
	ErrorDesc string `json:"error_desc,omitempty" xml:"error_desc,omitempty"`
	// 参照返回码定义列表
	ErrorCode string `json:"error_code,omitempty" xml:"error_code,omitempty"`
	// data
	Data *CainiaoEndpointLockerTopOrderNoticesendQueryData `json:"data,omitempty" xml:"data,omitempty"`
	// 是否成功
	Success bool `json:"success,omitempty" xml:"success,omitempty"`
}

type StationInfo struct {
	// 邮编
	Zip string `json:"zip,omitempty" xml:"zip,omitempty"`
	// 站点经度
	StationLng string `json:"station_lng,omitempty" xml:"station_lng,omitempty"`
	// 站点详细地址
	StationAddr string `json:"station_addr,omitempty" xml:"station_addr,omitempty"`
	// 站点id
	StationId string `json:"station_id,omitempty" xml:"station_id,omitempty"`
	// 站点名字
	StationName string `json:"station_name,omitempty" xml:"station_name,omitempty"`
	// 小区
	HousingEstate string `json:"housing_estate,omitempty" xml:"housing_estate,omitempty"`
	// 站点编码
	StationNo string `json:"station_no,omitempty" xml:"station_no,omitempty"`
	// 城市
	City string `json:"city,omitempty" xml:"city,omitempty"`
	// 站点照片url
	ImgUrl string `json:"img_url,omitempty" xml:"img_url,omitempty"`
	// 站点纬度
	StationLat string `json:"station_lat,omitempty" xml:"station_lat,omitempty"`
	// 省份
	Province string `json:"province,omitempty" xml:"province,omitempty"`
	// 坐标类型，MARS-火星坐标（高德坐标），BAIDU-百度坐标,GPS-GPS坐标
	CoordType string `json:"coord_type,omitempty" xml:"coord_type,omitempty"`
	// 街道
	Town string `json:"town,omitempty" xml:"town,omitempty"`
	// 区县
	District string `json:"district,omitempty" xml:"district,omitempty"`
	// 站点服务能力描述
	Extra string `json:"extra,omitempty" xml:"extra,omitempty"`
	// 站点联系方式
	Contact string `json:"contact,omitempty" xml:"contact,omitempty"`
	// 0-上线，1-下线
	Status int64 `json:"status,omitempty" xml:"status,omitempty"`
	// 站点类型：100-代收点
	StationType int64 `json:"station_type,omitempty" xml:"station_type,omitempty"`
}

type TradeOrderInfoDto struct {
	// 物流服务值（详见https://support-cnkuaidi.taobao.com/doc.htm#?docId=106156&docType=1，如无特殊服务请置空）
	LogisticsServices string `json:"logistics_services,omitempty" xml:"logistics_services,omitempty"`
	// 带面单号模式取号，目前仅顺丰支持
	WaybillCode string `json:"waybill_code,omitempty" xml:"waybill_code,omitempty"`
	// 云打印标准模板URL（组装云打印结果使用，值格式http://cloudprint.cainiao.com/template/standard/${模板ID}）
	TemplateUrl string `json:"template_url,omitempty" xml:"template_url,omitempty"`
	// <a href="http://open.taobao.com/docs/doc.htm?docType=1&articleId=105086&treeId=17&platformId=17#6">请求ID</a>
	ObjectId string `json:"object_id,omitempty" xml:"object_id,omitempty"`
	// 收件人信息
	Recipient *UserInfoDto `json:"recipient,omitempty" xml:"recipient,omitempty"`
	// 订单信息
	OrderInfo *OrderInfoDto `json:"order_info,omitempty" xml:"order_info,omitempty"`
	// 包裹信息
	PackageInfo *PackageInfoDto `json:"package_info,omitempty" xml:"package_info,omitempty"`
	// 使用者ID（使用电子面单账号的实际商家ID，如存在一个电子面单账号多个店铺使用时，请传入店铺的商家ID）
	UserId int64 `json:"user_id,omitempty" xml:"user_id,omitempty"`
}

type UserInfoDto struct {
	// 手机号码（手机号和固定电话不能同时为空），长度小于20
	Mobile string `json:"mobile,omitempty" xml:"mobile,omitempty"`
	// 姓名，长度小于40
	Name string `json:"name,omitempty" xml:"name,omitempty"`
	// 固定电话（手机号和固定电话不能同时为空），长度小于20
	Phone string `json:"phone,omitempty" xml:"phone,omitempty"`
	// 菜鸟解密地址ID，用于电商平台收件人信息加密的场景使用，非订单加密场景请勿使用。
	Caid string `json:"caid,omitempty" xml:"caid,omitempty"`
	// 淘宝订单收件人ID (Open Addressee ID)，长度不超过128个字符，淘宝订单加密情况用于解密。
	Oaid string `json:"oaid,omitempty" xml:"oaid,omitempty"`
	// 电商平台真实交易订单号，针对电商平台订单隐私加密场景使用，非必填，如果填写则必须是电商平台真实的交易订单ID
	Tid string `json:"tid,omitempty" xml:"tid,omitempty"`
	// 发货地址需要通过<a href="http://open.taobao.com/doc2/detail.htm?spm=a219a.7629140.0.0.3OFCPk&treeId=17&articleId=104860&docType=1">search接口</a>
	Address *AddressDto `json:"address,omitempty" xml:"address,omitempty"`
}

type WaybillCloudPrintApplyNewRequest struct {
	// 请求面单信息，数量限制为10
	TradeOrderInfoDtos []TradeOrderInfoDto `json:"trade_order_info_dtos,omitempty" xml:"trade_order_info_dtos>trade_order_info_dto,omitempty"`
	// <a href="http://open.taobao.com/doc2/detail.htm?spm=a219a.7629140.0.0.8cf9Nj&treeId=17&articleId=105085&docType=1#1">物流公司Code</a>，长度小于20
	CpCode string `json:"cp_code,omitempty" xml:"cp_code,omitempty"`
	// 预约上门截止时间
	DoorPickUpEndTime string `json:"door_pick_up_end_time,omitempty" xml:"door_pick_up_end_time,omitempty"`
	// 月结卡号
	CustomerCode string `json:"customer_code,omitempty" xml:"customer_code,omitempty"`
	// 寄件网点编码
	ShippingBranchCode string `json:"shipping_branch_code,omitempty" xml:"shipping_branch_code,omitempty"`
	// 目前仅顺丰支持此字段，传入快递产品编码
	ProductCode string `json:"product_code,omitempty" xml:"product_code,omitempty"`
	// 配送资源code， 仓库WMS系统对接落地配业务，其它场景请不要使用
	ResourceCode string `json:"resource_code,omitempty" xml:"resource_code,omitempty"`
	// 预约上门截止时间
	DoorPickUpTime string `json:"door_pick_up_time,omitempty" xml:"door_pick_up_time,omitempty"`
	// 品牌编码
	BrandCode string `json:"brand_code,omitempty" xml:"brand_code,omitempty"`
	// 扩展参数
	ExtraInfo string `json:"extra_info,omitempty" xml:"extra_info,omitempty"`
	// 仓code， 仓库WMS系统对接落地配业务，其它场景请不要使用
	StoreCode string `json:"store_code,omitempty" xml:"store_code,omitempty"`
	// 发货人信息
	Sender *UserInfoDto `json:"sender,omitempty" xml:"sender,omitempty"`
	// 订单上是否带3PLtiming属性, 该属性需要严格与订单上属性保持一致，如果不确定，请使用默认false。
	ThreePlTiming bool `json:"three_pl_timing,omitempty" xml:"three_pl_timing,omitempty"`
	// 设定取号返回的云打印报文是否加密
	NeedEncrypt bool `json:"need_encrypt,omitempty" xml:"need_encrypt,omitempty"`
	// 是否使用智分宝预分拣， 仓库WMS系统对接落地配业务，其它场景请不要使用
	DmsSorting bool `json:"dms_sorting,omitempty" xml:"dms_sorting,omitempty"`
	// 快递公司支持一票多件，快运公司子母件请勿使用该参数
	MultiPackagesShipment bool `json:"multi_packages_shipment,omitempty" xml:"multi_packages_shipment,omitempty"`
	// 是否预约上门
	CallDoorPickUp bool `json:"call_door_pick_up,omitempty" xml:"call_door_pick_up,omitempty"`
}

type WaybillCloudPrintNewResponse struct {
	// 云打印内容（encryptedData表示加密结果，data表示非加密结果）;模板内容,具体解释见<a href="http://open.taobao.com/doc2/detail.htm?spm=a219a.7629140.0.0.8cf9Nj&treeId=17&articleId=105085&docType=1#12">链接</a>
	PrintData string `json:"print_data,omitempty" xml:"print_data,omitempty"`
	// 面单号, 子母件模式下为子面单号
	WaybillCode string `json:"waybill_code,omitempty" xml:"waybill_code,omitempty"`
	// 子母件中的母单号，当为子母件模式时，需要此单号为实际挂载物流详情的单号，需要使用此单号进行发货，查询物流详情，非子母件，此字段为空
	ParentWaybillCode string `json:"parent_waybill_code,omitempty" xml:"parent_waybill_code,omitempty"`
	// 拓展信息，特殊场景下使用
	ExtraInfo string `json:"extra_info,omitempty" xml:"extra_info,omitempty"`
	// cp_code，跟入参传入的cp_code保持一致
	CpCode string `json:"cp_code,omitempty" xml:"cp_code,omitempty"`
	// 真实取号的cp_code，在菜鸟裹裹商家寄件等虚拟cp的场景中real_cp_code和入参中的cp_code不一样，其他场景二者一样
	RealCpCode string `json:"real_cp_code,omitempty" xml:"real_cp_code,omitempty"`
	// 请求id
	ObjectId string `json:"object_id,omitempty" xml:"object_id,omitempty"`
	// 错误码
	ErrorCode string `json:"error_code,omitempty" xml:"error_code,omitempty"`
	// 错误信息
	ErrorMessage string `json:"error_message,omitempty" xml:"error_message,omitempty"`
	// 本单请求是否成功
	IsSuccess bool `json:"is_success,omitempty" xml:"is_success,omitempty"`
}