consignplatform

Documentation

Index

• type AddressDtoForTop
• type CainiaoConsignplatformOrderCancelAPIResponse
• type CainiaoConsignplatformOrderCancelRequest
  • func NewCainiaoConsignplatformOrderCancelRequest() *CainiaoConsignplatformOrderCancelRequest
  • func (r CainiaoConsignplatformOrderCancelRequest) GetApiMethodName() string
  • func (r CainiaoConsignplatformOrderCancelRequest) GetApiParams() url.Values
  • func (r CainiaoConsignplatformOrderCancelRequest) GetCancelRequest() *OrderCancelRequest
  • func (r *CainiaoConsignplatformOrderCancelRequest) SetCancelRequest(cancelRequest *OrderCancelRequest) error
• type CainiaoConsignplatformOrderCancelResponse
• type CainiaoConsignplatformOrderCreateAPIResponse
• type CainiaoConsignplatformOrderCreateRequest
  • func NewCainiaoConsignplatformOrderCreateRequest() *CainiaoConsignplatformOrderCreateRequest
  • func (r CainiaoConsignplatformOrderCreateRequest) GetApiMethodName() string
  • func (r CainiaoConsignplatformOrderCreateRequest) GetApiParams() url.Values
  • func (r CainiaoConsignplatformOrderCreateRequest) GetCreateRequest() *OrderCreateRequest
  • func (r *CainiaoConsignplatformOrderCreateRequest) SetCreateRequest(createRequest *OrderCreateRequest) error
• type CainiaoConsignplatformOrderCreateResponse
• type OrderCancelRequest
• type OrderCreateRequest
• type PersonDto
• type 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

type CainiaoConsignplatformOrderCancelAPIResponse

type CainiaoConsignplatformOrderCancelAPIResponse struct {
	model.CommonResponse
	CainiaoConsignplatformOrderCancelResponse
}

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

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

type CainiaoConsignplatformOrderCancelRequest

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

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

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

func NewCainiaoConsignplatformOrderCancelRequest

func NewCainiaoConsignplatformOrderCancelRequest() *CainiaoConsignplatformOrderCancelRequest

初始化CainiaoConsignplatformOrderCancelRequest对象

func (CainiaoConsignplatformOrderCancelRequest) GetApiMethodName

func (r CainiaoConsignplatformOrderCancelRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (CainiaoConsignplatformOrderCancelRequest) GetApiParams

func (r CainiaoConsignplatformOrderCancelRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (CainiaoConsignplatformOrderCancelRequest) GetCancelRequest

func (r CainiaoConsignplatformOrderCancelRequest) GetCancelRequest() *OrderCancelRequest

CancelRequest Getter

func (*CainiaoConsignplatformOrderCancelRequest) SetCancelRequest

func (r *CainiaoConsignplatformOrderCancelRequest) SetCancelRequest(cancelRequest *OrderCancelRequest) error

CancelRequest Setter 取消参数

type CainiaoConsignplatformOrderCancelResponse

type CainiaoConsignplatformOrderCancelResponse 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"`
}

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

type CainiaoConsignplatformOrderCreateAPIResponse

type CainiaoConsignplatformOrderCreateAPIResponse struct {
	model.CommonResponse
	CainiaoConsignplatformOrderCreateResponse
}

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

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

type CainiaoConsignplatformOrderCreateRequest

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

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

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

func NewCainiaoConsignplatformOrderCreateRequest

func NewCainiaoConsignplatformOrderCreateRequest() *CainiaoConsignplatformOrderCreateRequest

初始化CainiaoConsignplatformOrderCreateRequest对象

func (CainiaoConsignplatformOrderCreateRequest) GetApiMethodName

func (r CainiaoConsignplatformOrderCreateRequest) GetApiMethodName() string

IRequest interface 方法, 获取Api method

func (CainiaoConsignplatformOrderCreateRequest) GetApiParams

func (r CainiaoConsignplatformOrderCreateRequest) GetApiParams() url.Values

IRequest interface 方法, 获取API参数

func (CainiaoConsignplatformOrderCreateRequest) GetCreateRequest

func (r CainiaoConsignplatformOrderCreateRequest) GetCreateRequest() *OrderCreateRequest

CreateRequest Getter

func (*CainiaoConsignplatformOrderCreateRequest) SetCreateRequest

func (r *CainiaoConsignplatformOrderCreateRequest) SetCreateRequest(createRequest *OrderCreateRequest) error

CreateRequest Setter 订单创建入参

type CainiaoConsignplatformOrderCreateResponse

type CainiaoConsignplatformOrderCreateResponse 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"`
}

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

type OrderCancelRequest

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

OrderCancelRequest

type OrderCreateRequest

type OrderCreateRequest struct {
	// 商家备注
	UserMemo string `json:"user_memo,omitempty" xml:"user_memo,omitempty"`
	// 收件地址
	ReceiveAddress *AddressDtoForTop `json:"receive_address,omitempty" xml:"receive_address,omitempty"`
	// 收件人
	Receiver *PersonDto `json:"receiver,omitempty" xml:"receiver,omitempty"`
	// 买家留言
	BuyerMemo string `json:"buyer_memo,omitempty" xml:"buyer_memo,omitempty"`
	// 外部订单id，会用来做幂等，需要保证唯一
	OuterOrderId string `json:"outer_order_id,omitempty" xml:"outer_order_id,omitempty"`
	// 订单来源
	OrderSource string `json:"order_source,omitempty" xml:"order_source,omitempty"`
	// 子订单列表
	SubOrderList []SubOrderDto `json:"sub_order_list,omitempty" xml:"sub_order_list>sub_order_dto,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"`
	// 商品数量
	Amount int64 `json:"amount,omitempty" xml:"amount,omitempty"`
	// 商品价格（单位分）
	Price int64 `json:"price,omitempty" xml:"price,omitempty"`
	// 商品图片链接
	PictureUrl string `json:"picture_url,omitempty" xml:"picture_url,omitempty"`
	// 商品类别。1 日用品; 2 食品; 3 文件; 4 衣物; 5 数码产品; 6 其他
	Category int64 `json:"category,omitempty" xml:"category,omitempty"`
	// 商品名称
	GoodsName string `json:"goods_name,omitempty" xml:"goods_name,omitempty"`
	// 商品id
	GoodsId string `json:"goods_id,omitempty" xml:"goods_id,omitempty"`
}

SubOrderDto