consignplatform

package
v1.3.5 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2024 License: Apache-2.0 Imports: 4 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

func ReleaseAddressDtoForTop added in v1.3.4

func ReleaseAddressDtoForTop(v *AddressDtoForTop)

ReleaseAddressDtoForTop 释放AddressDtoForTop

func ReleaseCainiaoConsignplatformOrderCancelAPIRequest added in v1.3.4

func ReleaseCainiaoConsignplatformOrderCancelAPIRequest(v *CainiaoConsignplatformOrderCancelAPIRequest)

ReleaseCainiaoConsignplatformOrderCancelAPIRequest 将 CainiaoConsignplatformOrderCancelAPIRequest 放入 sync.Pool

func ReleaseCainiaoConsignplatformOrderCancelAPIResponse added in v1.3.4

func ReleaseCainiaoConsignplatformOrderCancelAPIResponse(v *CainiaoConsignplatformOrderCancelAPIResponse)

ReleaseCainiaoConsignplatformOrderCancelAPIResponse 将 CainiaoConsignplatformOrderCancelAPIResponse 保存到 sync.Pool

func ReleaseCainiaoConsignplatformOrderCreateAPIRequest added in v1.3.4

func ReleaseCainiaoConsignplatformOrderCreateAPIRequest(v *CainiaoConsignplatformOrderCreateAPIRequest)

ReleaseCainiaoConsignplatformOrderCreateAPIRequest 将 CainiaoConsignplatformOrderCreateAPIRequest 放入 sync.Pool

func ReleaseCainiaoConsignplatformOrderCreateAPIResponse added in v1.3.4

func ReleaseCainiaoConsignplatformOrderCreateAPIResponse(v *CainiaoConsignplatformOrderCreateAPIResponse)

ReleaseCainiaoConsignplatformOrderCreateAPIResponse 将 CainiaoConsignplatformOrderCreateAPIResponse 保存到 sync.Pool

func ReleaseOrderCancelRequest added in v1.3.4

func ReleaseOrderCancelRequest(v *OrderCancelRequest)

ReleaseOrderCancelRequest 释放OrderCancelRequest

func ReleaseOrderCreateRequest added in v1.3.4

func ReleaseOrderCreateRequest(v *OrderCreateRequest)

ReleaseOrderCreateRequest 释放OrderCreateRequest

func ReleasePersonDto added in v1.3.4

func ReleasePersonDto(v *PersonDto)

ReleasePersonDto 释放PersonDto

func ReleaseSubOrderDto added in v1.3.4

func ReleaseSubOrderDto(v *SubOrderDto)

ReleaseSubOrderDto 释放SubOrderDto

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 结构体

func GetAddressDtoForTop added in v1.3.4

func GetAddressDtoForTop() *AddressDtoForTop

GetAddressDtoForTop() 从对象池中获取AddressDtoForTop

type CainiaoConsignplatformOrderCancelAPIRequest added in v1.2.0

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

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

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

func GetCainiaoConsignplatformOrderCancelAPIRequest added in v1.3.4

func GetCainiaoConsignplatformOrderCancelAPIRequest() *CainiaoConsignplatformOrderCancelAPIRequest

GetCainiaoConsignplatformOrderCancelRequest 从 sync.Pool 获取 CainiaoConsignplatformOrderCancelAPIRequest

func NewCainiaoConsignplatformOrderCancelRequest

func NewCainiaoConsignplatformOrderCancelRequest() *CainiaoConsignplatformOrderCancelAPIRequest

NewCainiaoConsignplatformOrderCancelRequest 初始化CainiaoConsignplatformOrderCancelAPIRequest对象

func (CainiaoConsignplatformOrderCancelAPIRequest) GetApiMethodName added in v1.2.0

GetApiMethodName IRequest interface 方法, 获取Api method

func (CainiaoConsignplatformOrderCancelAPIRequest) GetApiParams added in v1.2.0

GetApiParams IRequest interface 方法, 获取API参数

func (CainiaoConsignplatformOrderCancelAPIRequest) GetCancelRequest added in v1.2.0

GetCancelRequest CancelRequest Getter

func (CainiaoConsignplatformOrderCancelAPIRequest) GetRawParams added in v1.2.8

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

func (*CainiaoConsignplatformOrderCancelAPIRequest) Reset added in v1.3.4

Reset IRequest interface 方法, 清空结构体

func (*CainiaoConsignplatformOrderCancelAPIRequest) SetCancelRequest added in v1.2.0

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

SetCancelRequest is CancelRequest Setter 取消参数

type CainiaoConsignplatformOrderCancelAPIResponse

type CainiaoConsignplatformOrderCancelAPIResponse struct {
	model.CommonResponse
	CainiaoConsignplatformOrderCancelAPIResponseModel
}

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

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

func GetCainiaoConsignplatformOrderCancelAPIResponse added in v1.3.4

func GetCainiaoConsignplatformOrderCancelAPIResponse() *CainiaoConsignplatformOrderCancelAPIResponse

GetCainiaoConsignplatformOrderCancelAPIResponse 从 sync.Pool 获取 CainiaoConsignplatformOrderCancelAPIResponse

func (*CainiaoConsignplatformOrderCancelAPIResponse) Reset added in v1.3.4

Reset 清空结构体

type CainiaoConsignplatformOrderCancelAPIResponseModel added in v1.2.0

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 菜鸟发货工作台取消包裹以及订单 成功返回结果

func (*CainiaoConsignplatformOrderCancelAPIResponseModel) Reset added in v1.3.4

Reset 清空结构体

type CainiaoConsignplatformOrderCreateAPIRequest added in v1.2.0

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

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

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

func GetCainiaoConsignplatformOrderCreateAPIRequest added in v1.3.4

func GetCainiaoConsignplatformOrderCreateAPIRequest() *CainiaoConsignplatformOrderCreateAPIRequest

GetCainiaoConsignplatformOrderCreateRequest 从 sync.Pool 获取 CainiaoConsignplatformOrderCreateAPIRequest

func NewCainiaoConsignplatformOrderCreateRequest

func NewCainiaoConsignplatformOrderCreateRequest() *CainiaoConsignplatformOrderCreateAPIRequest

NewCainiaoConsignplatformOrderCreateRequest 初始化CainiaoConsignplatformOrderCreateAPIRequest对象

func (CainiaoConsignplatformOrderCreateAPIRequest) GetApiMethodName added in v1.2.0

GetApiMethodName IRequest interface 方法, 获取Api method

func (CainiaoConsignplatformOrderCreateAPIRequest) GetApiParams added in v1.2.0

GetApiParams IRequest interface 方法, 获取API参数

func (CainiaoConsignplatformOrderCreateAPIRequest) GetCreateRequest added in v1.2.0

GetCreateRequest CreateRequest Getter

func (CainiaoConsignplatformOrderCreateAPIRequest) GetRawParams added in v1.2.8

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

func (*CainiaoConsignplatformOrderCreateAPIRequest) Reset added in v1.3.4

Reset IRequest interface 方法, 清空结构体

func (*CainiaoConsignplatformOrderCreateAPIRequest) SetCreateRequest added in v1.2.0

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

SetCreateRequest is CreateRequest Setter 订单创建入参

type CainiaoConsignplatformOrderCreateAPIResponse

type CainiaoConsignplatformOrderCreateAPIResponse struct {
	model.CommonResponse
	CainiaoConsignplatformOrderCreateAPIResponseModel
}

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

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

func GetCainiaoConsignplatformOrderCreateAPIResponse added in v1.3.4

func GetCainiaoConsignplatformOrderCreateAPIResponse() *CainiaoConsignplatformOrderCreateAPIResponse

GetCainiaoConsignplatformOrderCreateAPIResponse 从 sync.Pool 获取 CainiaoConsignplatformOrderCreateAPIResponse

func (*CainiaoConsignplatformOrderCreateAPIResponse) Reset added in v1.3.4

Reset 清空结构体

type CainiaoConsignplatformOrderCreateAPIResponseModel added in v1.2.0

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 菜鸟发货工作台创建订单 成功返回结果

func (*CainiaoConsignplatformOrderCreateAPIResponseModel) Reset added in v1.3.4

Reset 清空结构体

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 结构体

func GetOrderCancelRequest added in v1.3.4

func GetOrderCancelRequest() *OrderCancelRequest

GetOrderCancelRequest() 从对象池中获取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 结构体

func GetOrderCreateRequest added in v1.3.4

func GetOrderCreateRequest() *OrderCreateRequest

GetOrderCreateRequest() 从对象池中获取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 结构体

func GetPersonDto added in v1.3.4

func GetPersonDto() *PersonDto

GetPersonDto() 从对象池中获取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 结构体

func GetSubOrderDto added in v1.3.4

func GetSubOrderDto() *SubOrderDto

GetSubOrderDto() 从对象池中获取SubOrderDto

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL