cntms

Documentation

Overview

菜鸟配送API model

https://open.taobao.com/API.htm?docId=25659&docType=2

Index

• type CainiaoCntmsLogisticsOrderConsignAPIResponse
• type CainiaoCntmsLogisticsOrderConsignRequest
  • func NewCainiaoCntmsLogisticsOrderConsignRequest() *CainiaoCntmsLogisticsOrderConsignRequest
  • func (r CainiaoCntmsLogisticsOrderConsignRequest) GetApiMethodName() string
  • func (r CainiaoCntmsLogisticsOrderConsignRequest) GetApiParams() url.Values
  • func (r CainiaoCntmsLogisticsOrderConsignRequest) GetContent() *CnTmsLogisticsOrderConsignContent
  • func (r *CainiaoCntmsLogisticsOrderConsignRequest) SetContent(content *CnTmsLogisticsOrderConsignContent) error
• type CainiaoCntmsLogisticsOrderConsignResponse
• type CnTmsLogisticsOrderConsignContent
• type CnTmsLogisticsOrderDeliverRequirements
• type CnTmsLogisticsOrderGotService
• type CnTmsLogisticsOrderItem
• type CnTmsLogisticsOrderItemPackageInfo
• type CnTmsLogisticsOrderReceiverInfo
• type CnTmsLogisticsOrderSenderinfo

Types

type CainiaoCntmsLogisticsOrderConsignAPIResponse

type CainiaoCntmsLogisticsOrderConsignAPIResponse struct {
	model.CommonResponse
	CainiaoCntmsLogisticsOrderConsignResponse
}

菜鸟配商家仓库发货 API返回值 cainiao.cntms.logistics.order.consign

商家包装打印面单结束后，通知菜鸟包裹要发货

type CainiaoCntmsLogisticsOrderConsignRequest

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

菜鸟配商家仓库发货 API请求 cainiao.cntms.logistics.order.consign

商家包装打印面单结束后，通知菜鸟包裹要发货

func NewCainiaoCntmsLogisticsOrderConsignRequest

func NewCainiaoCntmsLogisticsOrderConsignRequest() *CainiaoCntmsLogisticsOrderConsignRequest

初始化CainiaoCntmsLogisticsOrderConsignRequest对象

func (CainiaoCntmsLogisticsOrderConsignRequest) GetApiMethodName

func (r CainiaoCntmsLogisticsOrderConsignRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (CainiaoCntmsLogisticsOrderConsignRequest) GetApiParams

func (r CainiaoCntmsLogisticsOrderConsignRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (CainiaoCntmsLogisticsOrderConsignRequest) GetContent

func (r CainiaoCntmsLogisticsOrderConsignRequest) GetContent() *CnTmsLogisticsOrderConsignContent

Content Getter

func (*CainiaoCntmsLogisticsOrderConsignRequest) SetContent

func (r *CainiaoCntmsLogisticsOrderConsignRequest) SetContent(content *CnTmsLogisticsOrderConsignContent) error

Content Setter 配送发货信息

type CainiaoCntmsLogisticsOrderConsignResponse

type CainiaoCntmsLogisticsOrderConsignResponse struct {
	XMLName xml.Name `xml:"cainiao_cntms_logistics_order_consign_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 物流单号
	LogisticsOrderCode string `json:"logistics_order_code,omitempty" xml:"logistics_order_code,omitempty"`
}

菜鸟配商家仓库发货 成功返回结果

type CnTmsLogisticsOrderConsignContent

type CnTmsLogisticsOrderConsignContent struct {
	// ERP订单号
	OrderCode string `json:"order_code,omitempty" xml:"order_code,omitempty"`
	// 交易订单id或者商家订单号； 若阿里系订单，必须与阿里对应
	TradeId string `json:"trade_id,omitempty" xml:"trade_id,omitempty"`
	// 来源渠道（TB 淘宝，JD 京东，TM 天猫，1688 1688（阿里中文站），YHD 1号店，DD 当当，VANCL 凡客，PP 拍拍，YX 易讯，EBAY 易贝ebay，AMAZON 亚马逊，SN 苏宁在线，GM 国美在线，WPH 唯品会，JM 聚美优品，LF 乐蜂网，MGJ 蘑菇街，JS 聚尚网，YG 优购，YT 银泰，YL 邮乐，PX 拍鞋网，POS POS门店，OTHERS 其他）
	OrderSource string `json:"order_source,omitempty" xml:"order_source,omitempty"`
	// 店铺编码
	ShopCode string `json:"shop_code,omitempty" xml:"shop_code,omitempty"`
	// 运单号
	MailNo string `json:"mail_no,omitempty" xml:"mail_no,omitempty"`
	// 物流公司编码
	TmsCode string `json:"tms_code,omitempty" xml:"tms_code,omitempty"`
	// 配送发货单收件人信息
	ReceiverInfo *CnTmsLogisticsOrderReceiverInfo `json:"receiver_info,omitempty" xml:"receiver_info,omitempty"`
	// 配送发货单发件人信息
	SenderInfo *CnTmsLogisticsOrderSenderinfo `json:"sender_info,omitempty" xml:"sender_info,omitempty"`
	// 发货商品信息，最大50条记录
	Items []CnTmsLogisticsOrderItem `json:"items,omitempty" xml:"items>cn_tms_logistics_order_item,omitempty"`
	// 配送要求信息（当前业务暂不支持）
	DeliverRequirements *CnTmsLogisticsOrderDeliverRequirements `json:"deliver_requirements,omitempty" xml:"deliver_requirements,omitempty"`
	// 商家送货方式，1商家送货，2菜鸟揽货
	PickUpType int64 `json:"pick_up_type,omitempty" xml:"pick_up_type,omitempty"`
	// 要求菜鸟上门揽货服务，当pick_up_Type=2且需求指定时做揽收时，此字段需要传值（当前业务暂不支持）
	TmsGotService *CnTmsLogisticsOrderGotService `json:"tms_got_service,omitempty" xml:"tms_got_service,omitempty"`
	// 物流服务解决方案Code，此字段由菜鸟提供
	SolutionsCode string `json:"solutions_code,omitempty" xml:"solutions_code,omitempty"`
	// 此订单的第几个包裹，如订单拆包裹时，传入此参数，配送时会将同一订单的包裹一配送
	PackageNo int64 `json:"package_no,omitempty" xml:"package_no,omitempty"`
	// 包裹重量（克）
	PackageWeight int64 `json:"package_weight,omitempty" xml:"package_weight,omitempty"`
	// 此订单总的包裹数，如订单拆包裹时，传入此参数，配送时会将同一订单的包裹一配送
	PackageCount int64 `json:"package_count,omitempty" xml:"package_count,omitempty"`
	// 包裹长度（厘米）
	PackageLength int64 `json:"package_length,omitempty" xml:"package_length,omitempty"`
	// 扩展字段 K:V;
	ExtendFields string `json:"extend_fields,omitempty" xml:"extend_fields,omitempty"`
	// 包裹高度（厘米）
	PackageHeight int64 `json:"package_height,omitempty" xml:"package_height,omitempty"`
	// 备注
	Remark string `json:"remark,omitempty" xml:"remark,omitempty"`
	// 包裹体积（立方厘米）
	PackageVolume int64 `json:"package_volume,omitempty" xml:"package_volume,omitempty"`
	// 包裹宽度（厘米）
	PackageWidth int64 `json:"package_width,omitempty" xml:"package_width,omitempty"`
	// 关单标示，true表示发货完结
	IsLastBatch bool `json:"is_last_batch,omitempty" xml:"is_last_batch,omitempty"`
	// 包裹列表，支持一单多包裹
	PackageList []CnTmsLogisticsOrderItemPackageInfo `json:"package_list,omitempty" xml:"package_list>cn_tms_logistics_order_item_package_info,omitempty"`
}

CnTmsLogisticsOrderConsignContent

type CnTmsLogisticsOrderDeliverRequirements

type CnTmsLogisticsOrderDeliverRequirements struct {
	// 配送类型： PTPS-普通配送 LLPS-冷链配送
	DeliveryType string `json:"delivery_type,omitempty" xml:"delivery_type,omitempty"`
	// 投递时延要求(1 工作日 2 节假日 104 预约达 )
	ScheduleType string `json:"schedule_type,omitempty" xml:"schedule_type,omitempty"`
	// 送达日期（格式为 yyyy-MM-dd)
	ScheduleDay string `json:"schedule_day,omitempty" xml:"schedule_day,omitempty"`
	// 送达开始时间（格式为 hh:mm）
	ScheduleStart string `json:"schedule_start,omitempty" xml:"schedule_start,omitempty"`
	// 送达结束时间（格式为 hh:mm）
	ScheduleEnd string `json:"schedule_end,omitempty" xml:"schedule_end,omitempty"`
}

CnTmsLogisticsOrderDeliverRequirements

type CnTmsLogisticsOrderGotService

type CnTmsLogisticsOrderGotService struct {
	// 揽收日期yyyyMMdd
	GotDate string `json:"got_date,omitempty" xml:"got_date,omitempty"`
	// 揽收时间段 09:00-10:00
	GotRange string `json:"got_range,omitempty" xml:"got_range,omitempty"`
}

CnTmsLogisticsOrderGotService

type CnTmsLogisticsOrderItem

type CnTmsLogisticsOrderItem struct {
	// ERP订单明细编码
	OrderItemId string `json:"order_item_id,omitempty" xml:"order_item_id,omitempty"`
	// 子交易号
	SubTradeId string `json:"sub_trade_id,omitempty" xml:"sub_trade_id,omitempty"`
	// 发货商品名称
	ItemName string `json:"item_name,omitempty" xml:"item_name,omitempty"`
	// 发货商品商品数量
	Quantity int64 `json:"quantity,omitempty" xml:"quantity,omitempty"`
	// 扩展字段 K:V;
	ExtendFields string `json:"extend_fields,omitempty" xml:"extend_fields,omitempty"`
	// 备注
	Remark string `json:"remark,omitempty" xml:"remark,omitempty"`
	// 商品单价，单位分
	ItemPrice int64 `json:"item_price,omitempty" xml:"item_price,omitempty"`
}

CnTmsLogisticsOrderItem

type CnTmsLogisticsOrderItemPackageInfo

type CnTmsLogisticsOrderItemPackageInfo struct {
	// 发货商品信息，最大50条记录
	Items []CnTmsLogisticsOrderItem `json:"items,omitempty" xml:"items>cn_tms_logistics_order_item,omitempty"`
	// 运单号
	MailNo string `json:"mail_no,omitempty" xml:"mail_no,omitempty"`
	// 包裹重量（克）
	PackageWeight string `json:"package_weight,omitempty" xml:"package_weight,omitempty"`
	// 包裹长度（厘米）
	PackageLength string `json:"package_length,omitempty" xml:"package_length,omitempty"`
	// 包裹宽度（厘米）
	PackageWidth string `json:"package_width,omitempty" xml:"package_width,omitempty"`
	// 包裹高度（厘米）
	PackageHeight string `json:"package_height,omitempty" xml:"package_height,omitempty"`
	// 包裹体积（立方厘米）
	PackageVolume string `json:"package_volume,omitempty" xml:"package_volume,omitempty"`
}

CnTmsLogisticsOrderItemPackageInfo

type CnTmsLogisticsOrderReceiverInfo

type CnTmsLogisticsOrderReceiverInfo struct {
	// 收件人省份
	ReceiverProvince string `json:"receiver_province,omitempty" xml:"receiver_province,omitempty"`
	// 收件人城市
	ReceiverCity string `json:"receiver_city,omitempty" xml:"receiver_city,omitempty"`
	// 收件人区县
	ReceiverArea string `json:"receiver_area,omitempty" xml:"receiver_area,omitempty"`
	// 收件人区县
	ReceiverAddress string `json:"receiver_address,omitempty" xml:"receiver_address,omitempty"`
	// 收件方邮编
	ReceiverZipCode string `json:"receiver_zip_code,omitempty" xml:"receiver_zip_code,omitempty"`
	// 收件人姓名
	ReceiverName string `json:"receiver_name,omitempty" xml:"receiver_name,omitempty"`
	// 收件人昵称
	ReceiverNick string `json:"receiver_nick,omitempty" xml:"receiver_nick,omitempty"`
	// 收件人手机，手机与电话必须有一值不为空
	ReceiverMobile string `json:"receiver_mobile,omitempty" xml:"receiver_mobile,omitempty"`
	// 收件人电话，手机与电话必须有一值不为空
	ReceiverPhone string `json:"receiver_phone,omitempty" xml:"receiver_phone,omitempty"`
}

CnTmsLogisticsOrderReceiverInfo

type CnTmsLogisticsOrderSenderinfo

type CnTmsLogisticsOrderSenderinfo struct {
	// 发件人省份
	SenderProvince string `json:"sender_province,omitempty" xml:"sender_province,omitempty"`
	// 发件人城市
	SenderCity string `json:"sender_city,omitempty" xml:"sender_city,omitempty"`
	// 发件人区县
	SenderArea string `json:"sender_area,omitempty" xml:"sender_area,omitempty"`
	// 发件人地址
	SenderAddress string `json:"sender_address,omitempty" xml:"sender_address,omitempty"`
	// 发件人邮编
	SenderZipCode string `json:"sender_zip_code,omitempty" xml:"sender_zip_code,omitempty"`
	// 发件人姓名
	SenderName string `json:"sender_name,omitempty" xml:"sender_name,omitempty"`
	// 发件人手机，手机与电话必须有一值不为空
	SenderMobile string `json:"sender_mobile,omitempty" xml:"sender_mobile,omitempty"`
	// 发件人电话，手机与电话必须有一值不为空
	SenderPhone string `json:"sender_phone,omitempty" xml:"sender_phone,omitempty"`
}

CnTmsLogisticsOrderSenderinfo