consignplatform

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 20, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package consignplatform 包含菜鸟发货工作台API相关结构体

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddressDtoForTop 

type AddressDtoForTop struct {
	// 国家
	CountryName string `json:"country_name,omitempty" xml:"country_name,omitempty"`
	// 省份
	ProvName string `json:"prov_name,omitempty" xml:"prov_name,omitempty"`
	// 城市
	CityName string `json:"city_name,omitempty" xml:"city_name,omitempty"`
	// 区
	AreaName string `json:"area_name,omitempty" xml:"area_name,omitempty"`
	// 街道
	TownName string `json:"town_name,omitempty" xml:"town_name,omitempty"`
	// 详细地址
	AddressDetail string `json:"address_detail,omitempty" xml:"address_detail,omitempty"`
}

AddressDtoForTop 结构体

type CainiaoconsignplatformordercancelAPIRequest added in v1.3.1 

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

CainiaoconsignplatformordercancelAPIRequest 菜鸟发货工作台取消包裹以及订单 API请求 cainiao.consignplatform.order.cancel

菜鸟发货工作台，商家或者isv通过api取消包裹、回收单号，如果是裹裹运力会取消小件员上门。最后删除订单信息。

func NewCainiaoconsignplatformordercancelRequest added in v1.3.1 

func NewCainiaoconsignplatformordercancelRequest() *CainiaoconsignplatformordercancelAPIRequest

NewCainiaoconsignplatformordercancelRequest 初始化CainiaoconsignplatformordercancelAPIRequest对象

func (CainiaoconsignplatformordercancelAPIRequest) GetApiMethodName added in v1.3.1 

func (r CainiaoconsignplatformordercancelAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (CainiaoconsignplatformordercancelAPIRequest) GetApiParams added in v1.3.1 

func (r CainiaoconsignplatformordercancelAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (CainiaoconsignplatformordercancelAPIRequest) GetCancelRequest added in v1.3.1 

func (r CainiaoconsignplatformordercancelAPIRequest) GetCancelRequest() *OrderCancelRequest

GetCancelRequest CancelRequest Getter

func (CainiaoconsignplatformordercancelAPIRequest) GetRawParams added in v1.3.1 

func (r CainiaoconsignplatformordercancelAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*CainiaoconsignplatformordercancelAPIRequest) SetCancelRequest added in v1.3.1 

func (r *CainiaoconsignplatformordercancelAPIRequest) SetCancelRequest(_cancelRequest *OrderCancelRequest) error

SetCancelRequest is CancelRequest Setter 取消参数

type CainiaoconsignplatformordercancelAPIResponse added in v1.3.1 

type CainiaoconsignplatformordercancelAPIResponse struct {
	model.CommonResponse
	CainiaoconsignplatformordercancelAPIResponseModel
}

CainiaoconsignplatformordercancelAPIResponse 菜鸟发货工作台取消包裹以及订单 API返回值 cainiao.consignplatform.order.cancel

菜鸟发货工作台，商家或者isv通过api取消包裹、回收单号，如果是裹裹运力会取消小件员上门。最后删除订单信息。

type CainiaoconsignplatformordercancelAPIResponseModel added in v1.3.1 

type CainiaoconsignplatformordercancelAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_consignplatform_order_cancel_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 失败信息
	FailCode string `json:"fail_code,omitempty" xml:"fail_code,omitempty"`
	// 失败code
	FailMessage string `json:"fail_message,omitempty" xml:"fail_message,omitempty"`
	// 取消是否成功
	Result bool `json:"result,omitempty" xml:"result,omitempty"`
}

CainiaoconsignplatformordercancelAPIResponseModel is 菜鸟发货工作台取消包裹以及订单 成功返回结果

type CainiaoconsignplatformordercreateAPIRequest added in v1.3.1 

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

CainiaoconsignplatformordercreateAPIRequest 菜鸟发货工作台创建订单 API请求 cainiao.consignplatform.order.create

菜鸟发货工作台，商家或者isv通过api进行订单写入操作

func NewCainiaoconsignplatformordercreateRequest added in v1.3.1 

func NewCainiaoconsignplatformordercreateRequest() *CainiaoconsignplatformordercreateAPIRequest

NewCainiaoconsignplatformordercreateRequest 初始化CainiaoconsignplatformordercreateAPIRequest对象

func (CainiaoconsignplatformordercreateAPIRequest) GetApiMethodName added in v1.3.1 

func (r CainiaoconsignplatformordercreateAPIRequest) GetApiMethodName() string

GetApiMethodName IRequest interface 方法, 获取Api method

func (CainiaoconsignplatformordercreateAPIRequest) GetApiParams added in v1.3.1 

func (r CainiaoconsignplatformordercreateAPIRequest) GetApiParams(params url.Values)

GetApiParams IRequest interface 方法, 获取API参数

func (CainiaoconsignplatformordercreateAPIRequest) GetCreateRequest added in v1.3.1 

func (r CainiaoconsignplatformordercreateAPIRequest) GetCreateRequest() *OrderCreateRequest

GetCreateRequest CreateRequest Getter

func (CainiaoconsignplatformordercreateAPIRequest) GetRawParams added in v1.3.1 

func (r CainiaoconsignplatformordercreateAPIRequest) GetRawParams() model.Params

GetRawParams IRequest interface 方法, 获取API原始参数

func (*CainiaoconsignplatformordercreateAPIRequest) SetCreateRequest added in v1.3.1 

func (r *CainiaoconsignplatformordercreateAPIRequest) SetCreateRequest(_createRequest *OrderCreateRequest) error

SetCreateRequest is CreateRequest Setter 订单创建入参

type CainiaoconsignplatformordercreateAPIResponse added in v1.3.1 

type CainiaoconsignplatformordercreateAPIResponse struct {
	model.CommonResponse
	CainiaoconsignplatformordercreateAPIResponseModel
}

CainiaoconsignplatformordercreateAPIResponse 菜鸟发货工作台创建订单 API返回值 cainiao.consignplatform.order.create

菜鸟发货工作台，商家或者isv通过api进行订单写入操作

type CainiaoconsignplatformordercreateAPIResponseModel added in v1.3.1 

type CainiaoconsignplatformordercreateAPIResponseModel struct {
	XMLName xml.Name `xml:"cainiao_consignplatform_order_create_response"`
	// 平台颁发的每次请求访问的唯一标识
	RequestId string `json:"request_id,omitempty" xml:"request_id,omitempty"`
	// 失败信息
	FailMessage string `json:"fail_message,omitempty" xml:"fail_message,omitempty"`
	// 失败code
	FailCode string `json:"fail_code,omitempty" xml:"fail_code,omitempty"`
	// 创建是否成功
	Result bool `json:"result,omitempty" xml:"result,omitempty"`
}

CainiaoconsignplatformordercreateAPIResponseModel is 菜鸟发货工作台创建订单 成功返回结果

type OrderCancelRequest 

type OrderCancelRequest struct {
	// 外部订单id列表
	SubOuterOrderIds []string `json:"sub_outer_order_ids,omitempty" xml:"sub_outer_order_ids>string,omitempty"`
	// 外部订单id
	OuterOrderId string `json:"outer_order_id,omitempty" xml:"outer_order_id,omitempty"`
	// 订单来源
	OrderSource string `json:"order_source,omitempty" xml:"order_source,omitempty"`
}

OrderCancelRequest 结构体

type OrderCreateRequest 

type OrderCreateRequest struct {
	// 子订单列表
	SubOrderList []SubOrderDto `json:"sub_order_list,omitempty" xml:"sub_order_list>sub_order_dto,omitempty"`
	// 商家备注
	UserMemo string `json:"user_memo,omitempty" xml:"user_memo,omitempty"`
	// 外部订单id，会用来做幂等，需要保证唯一
	OuterOrderId string `json:"outer_order_id,omitempty" xml:"outer_order_id,omitempty"`
	// 买家留言
	BuyerMemo string `json:"buyer_memo,omitempty" xml:"buyer_memo,omitempty"`
	// 订单来源
	OrderSource string `json:"order_source,omitempty" xml:"order_source,omitempty"`
	// 收件地址
	ReceiveAddress *AddressDtoForTop `json:"receive_address,omitempty" xml:"receive_address,omitempty"`
	// 收件人
	Receiver *PersonDto `json:"receiver,omitempty" xml:"receiver,omitempty"`
}

OrderCreateRequest 结构体

type PersonDto 

type PersonDto struct {
	// 收件固定电话
	Phone string `json:"phone,omitempty" xml:"phone,omitempty"`
	// 收件电话
	MobilePhone string `json:"mobile_phone,omitempty" xml:"mobile_phone,omitempty"`
	// 收件人
	UserName string `json:"user_name,omitempty" xml:"user_name,omitempty"`
}

PersonDto 结构体

type SubOrderDto 

type SubOrderDto struct {
	// 外部子订单id
	OuterOrderId string `json:"outer_order_id,omitempty" xml:"outer_order_id,omitempty"`
	// 商品名称
	GoodsName string `json:"goods_name,omitempty" xml:"goods_name,omitempty"`
	// 商品图片链接
	PictureUrl string `json:"picture_url,omitempty" xml:"picture_url,omitempty"`
	// 商品id
	GoodsId string `json:"goods_id,omitempty" xml:"goods_id,omitempty"`
	// 商品数量
	Amount int64 `json:"amount,omitempty" xml:"amount,omitempty"`
	// 商品价格（单位分）
	Price int64 `json:"price,omitempty" xml:"price,omitempty"`
	// 商品类别。1 日用品; 2 食品; 3 文件; 4 衣物; 5 数码产品; 6 其他
	Category int64 `json:"category,omitempty" xml:"category,omitempty"`
}

SubOrderDto 结构体

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.