Documentation
¶
Overview ¶
Package union 小商店联盟相关接口
Index ¶
- type Address
- type AddressInfo
- type Category
- type CategoryInfo
- type CommissionStatus
- type CouponDetail
- type CouponInfo
- type CouponReceiveInfo
- type CouponValidInfo
- type DiscountCondition
- type DiscountInfo
- type FreightTemplate
- type LeagueExInfo
- type Order
- type OrderProduct
- type OrderSearchRequest
- type OrderSearchResult
- type Product
- type ProductDetail
- type ProductGenerateRequest
- type ProductInfo
- type ProductListRequest
- type ProductListResult
- type ProductSkuInfo
- type PromotionInfo
- type SameCityTemplate
- type ShareInfo
- type ShareProduct
- type ShippingMethods
- type ShopInfo
- type Sku
- type StockInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct {
// AddressInfo 地址信息
AddressInfo *AddressInfo `json:"addressInfo,omitempty"`
// AddressType 地址类型,结构同 shippingMethods
AddressType *ShippingMethods `json:"addressType,omitempty"`
}
Address 发货地址
type AddressInfo ¶
type AddressInfo struct {
// ProvinceName 国标收货地址第一级地址
ProvinceName string `json:"provinceName,omitempty"`
// CityName 国标收货地址第二级地址
CityName string `json:"cityName,omitempty"`
// CountryName 国标收货地址第三级地址
CountryName string `json:"countryName,omitempty"`
}
AddressInfo 地址信息
type Category ¶
type Category struct {
// CatID 类目ID
CatID string `json:"catId,omitempty"`
// Name 类目名称
Name string `json:"name,omitempty"`
// FCatID fCatId
FCatID string `json:"fCatId,omitempty"`
// CatType
CatType int `json:"catType,omitempty"`
// Bizuin
Bizuin string `json:"bizuin,omitempty"`
// BrandCat
BrandCat int `json:"brandCat,omitempty"`
// CatInfo
CatInfo *CategoryInfo `json:"catInfo,omitempty"`
}
Category 类目ID
type CategoryInfo ¶
type CommissionStatus ¶
type CommissionStatus string
CommissionStatus 分佣状态
const ( // SETTLEMENT_PENDING 待结算 SETTLEMENT_PENDING CommissionStatus = "SETTLEMENT_PENDING" // SETTLEMENT_SUCCESS 已结算 SETTLEMENT_SUCCESS CommissionStatus = "SETTLEMENT_SUCCESS" // SETTLEMENT_CANCELED 取消结算 SETTLEMENT_CANCELED CommissionStatus = "SETTLEMENT_CANCELED" )
type CouponDetail ¶
type CouponDetail struct {
// RestNum 券库存
RestNum int64 `json:"restNum,omitempty"`
// Type 券类型
Type int `json:"type,omitempty"`
// DiscountInfo 券面额
DiscountInfo *DiscountInfo `json:"discountInfo,omitempty"`
// ValidInfo 有效期
ValidInfo *CouponValidInfo `json:"validInfo,omitempty"`
// ReceiveInfo 领券时间
ReceiveInfo *CouponReceiveInfo `json:"receiveInfo,omitempty"`
}
CouponDetail 券详情
type CouponInfo ¶
type CouponInfo struct {
// HasCoupon 是否有联盟券,1为含券商品,0为全部商品
HasCoupon int `json:"hasCoupon,omitempty"`
// CouponID 券id
CouponID string `json:"couponId,omitempty"`
// CouponDetail 券详情
CouponDetail *CouponDetail `json:"couponDetail,omitempty"`
}
CouponInfo 联盟优惠券数据
type CouponReceiveInfo ¶
type CouponReceiveInfo struct {
// StartTime 领取开始时间戳
StartTime string `json:"startTime,omitempty"`
// EndTime 领取结束时间戳
EndTime string `json:"endTime,omitempty"`
// LimitNumOnePerson 每人限领张数
LimitNumOnePerson int `json:"limitNumOnePerson,omitempty"`
}
CouponReceiveInfo 领券时间
type CouponValidInfo ¶
type CouponValidInfo struct {
// ValidType 有效期类型,1 为商品指定时间区间,2 为生效天数
ValidType int `json:"validType,omitempty"`
// ValidDayNum 生效天数
ValidDayNum int `json:"validDayNum,omitempty"`
// StartTime 有效开始时间
StartTime string `json:"startTime,omitempty"`
// EndTime 有效结束时间
EndTime string `json:"endTime,omitempty"`
}
CouponValidInfo 有效期
type DiscountCondition ¶
type DiscountInfo ¶
type DiscountInfo struct {
DiscountCondition *DiscountCondition `json:"discountCondition,omitempty"`
// DiscountNum 折扣数,如 5.1 折 为 5.1 * 1000
DiscountNum int `json:"discountNum,omitempty"`
// DiscountFee 直减金额,单位为分
DiscountFee int64 `json:"discountFee,omitempty"`
}
DiscountInfo 券面额
type FreightTemplate ¶
type FreightTemplate struct {
// NotSendArea 不发货地区
NotSendArea struct {
// AddressInfoList 不发货地区地址列表
AddressInfoList []AddressInfo `json:"addressInfoList,omitempty"`
} `json:"notSendArea"`
}
FreightTemplate 运费模板,只有当配送方式包含「快递」才出此项
type LeagueExInfo ¶
type LeagueExInfo struct {
// HasCommission 是否有佣金,1/0
HasCommission int `json:"hasCommission,omitempty"`
// CommissionRatio 佣金比例,万分之一
CommissionRatio int64 `json:"commissionRatio,omitempty"`
// CommissionValue 佣金金额,单位分
CommissionValue int64 `json:"commissionValue,omitempty"`
}
LeagueExInfo 联盟佣金相关数据
type Order ¶
type Order struct {
// OrderID 订单ID
OrderID string `json:"orderId,omitempty"`
// PayTime 支付时间戳,单位为s
PayTime int64 `json:"payTime,omitempty"`
// ConfirmReceiveTime 确认收货时间戳,单位为s,没有时为0
ConfirmReceiveTime int64 `json:"confirmReceiveTime,omitempty"`
// ShopName 店铺名称
ShopName string `json:"shopName,omitempty"`
// ShopAppID 店铺 Appid
ShopAppID string `json:"shopAppId,omitempty"`
// ProductList 商品列表
ProductList []OrderProduct `json:"productList,omitempty"`
// CustomizeInfo 自定义信息
CustomizeInfo string `json:"customizeInfo,omitempty"`
// CustomUserID 自定义用户参数
CustomUserID string `json:"customUserId,omitempty"`
// UserNickName 用户昵称
UserNickName string `json:"userNickName,omitempty"`
}
Order 订单
func OrderSearch ¶
OrderSearch 获取订单列表
type OrderProduct ¶
type OrderProduct struct {
// ProductID 商品SPU ID
ProductID string `json:"productId,omitempty"`
// SkuID sku ID
SkuID string `json:"skuId,omitempty"`
// Title 商品名称
Title string `json:"title,omitempty"`
// ThumbImg 商品缩略图 url
ThumbImg string `json:"thumbImg,omitempty"`
// Price 商品成交总价,前带单位 ¥
Price util.MoneyFloat `json:"price,omitempty"`
// ProductCnt 成交数量
ProductCnt int `json:"productCnt,omitempty"`
// Ratio 分佣比例,单位为万分之一
Ratio int64 `json:"ratio,omitempty"`
// CommissionStatus 分佣状态
CommissionStatus CommissionStatus `json:"commissionStatus,omitempty"`
// CommissionStatusUpdateTime 分佣状态更新时间戳,单位为s
CommissionStatusUpdateTime util.Int64 `json:"commissionStatusUpdateTime,omitempty"`
// ProfitShardingSucTime 结算时间,当分佣状态为已结算才有值,单位为s
ProfitShardingSucTime util.Int64 `json:"profitShardingSucTime,omitempty"`
// Commission 分佣金额,前带单位 ¥
Commission util.MoneyFloat `json:"commission,omitempty"`
// EstimatedCommission 预估分佣金额,单位为分
EstimatedCommission int64 `json:"estimatedCommission,omitempty"`
// CategoryStr 类目名称,多个用英文逗号分隔
CategoryStr string `json:"categoryStr,omitempty"`
// CustomizeInfo 自定义信息
CustomizeInfo string `json:"customizeInfo,omitempty"`
// PromotionInfo 推广信息
PromotionInfo *PromotionInfo `json:"promotionInfo,omitempty"`
}
type OrderSearchRequest ¶
type OrderSearchRequest struct {
// Page 页码,起始为 1
Page int `json:"page,omitempty"`
// PageSize 分页大小,最大 200
PageSize int `json:"pageSize,omitempty"`
// StartTimestamp 起始时间戳,单位为秒
StartTimestamp int64 `json:"startTimestamp,omitempty"`
// EndTimestamp 结束时间戳,单位为秒
EndTimestamp int64 `json:"endTimestamp,omitempty"`
// CommissionStatus 分佣状态
CommissionStatus string `json:"commissionStatus,omitempty"`
// SortByCommissionUpdateTime 是否按照分佣状态更新时间排序和筛选订单,1:是,0:否
SortByCommissionUpdateTime int `json:"sortByCommissionUpdateTime,omitempty"`
// StartCommissionUpdateTime 分佣状态更新时间起始时间戳,单位为秒
StartCommissionUpdateTime int64 `json:"startCommissionUpdateTime,omitempty"`
// EndCommissionUpdateTime 分佣状态更新时间结束时间戳,单位为秒
EndCommissionUpdateTime int64 `json:"endCommissionUpdateTime,omitempty"`
}
OrderSearchRequest 根据订单支付时间、订单分佣状态拉取订单详情
type OrderSearchResult ¶
type OrderSearchResult struct {
// PageSize 分页大小
PageSize int `json:"pageSize,omitempty"`
// TotalNum 订单总数
TotalNum int `json:"totalNum,omitempty"`
// OrderList 订单列表
OrderList []Order `json:"orderList,omitempty"`
}
OrderSearchResult
type Product ¶
type Product struct {
// ProductID 商品SPU ID
ProductID string `json:"productId,omitempty"`
// AppID 商品所在小商店的AppID
AppID string `json:"appId,omitempty"`
// Product 商品具体信息
Product struct {
// ProductID 商品SPU ID
ProductID string `json:"productId,omitempty"`
// Info 商品具体信息
Info *ProductInfo `json:"info,omitempty"`
// Skus 商品SKU
Skus []Sku `json:"skus,omitempty"`
} `json:"product,omitempty"`
// LeagueExInfo 联盟佣金相关数据
LeagueExInfo *LeagueExInfo `json:"leagueExInfo,omitempty"`
// ShopInfo 商品所属小商店数据
ShopInfo *ShopInfo `json:"shopInfo,omitempty"`
// CouponInfo 联盟优惠券数据
CouponInfo *CouponInfo `json:"couponInfo,omitempty"`
}
Product 商品
func ProductList ¶
type ProductDetail ¶
type ProductDetail struct {
// DetailImg 商品详情图片
DetailImg []string `json:"detailImg,omitempty"`
// Param 商品参数
Param []interface{} `json:"param,omitempty"`
}
ProductDetail 商品详细数据
type ProductGenerateRequest ¶
type ProductGenerateRequest struct {
// Pid 推广位PID
Pid string `json:"pid,omitempty"`
// ProductList 商品列表
ProductList []ShareProduct `json:"productList,omitempty"`
}
ProductGenerateRequest 获取商品推广素材
type ProductInfo ¶
type ProductInfo struct {
// Title 商品标题
Title string `json:"title,omitempty"`
// SubTitle 商品子标题
SubTitle string `json:"subTitle,omitempty"`
// HeadImg 商品主图
HeadImg []string `json:"headImg,omitempty"`
// Category 商品类目
Category []Category `json:"category,omitempty"`
// ShopName 商店名称
ShopName string `json:"shopName,omitempty"`
// Brand 品牌名称
Brand string `json:"brand,omitempty"`
// BrandID 品牌ID
BrandID string `json:"brandId,omitempty"`
// Model 型号
Model string `json:"model,omitempty"`
// Detail 商品详细数据
Detail *ProductDetail `json:"detail,omitempty"`
// MinPrice 商品最低价格,单位分
MinPrice int64 `json:"minPrice,omitempty"`
// Discount 商品优惠金额,单位分
Discount int64 `json:"discount,omitempty"`
// DiscountPrice 商品券后价
DiscountPrice int `json:"discountPrice,omitempty"`
// TotalStockNum 总库存
TotalStock int64 `json:"totalStock,omitempty"`
// TotalSoldNum 累计销量
TotalSoldNum int64 `json:"totalSoldNum,omitempty"`
// TotalOrderNum 累计订单量
TotalOrderNum int64 `json:"totalOrderNum,omitempty"`
// PluginResult 是否引用小商店组件(未引用组件的商品不可推广),0:否,1:是
PluginResult int `json:"pluginResult,omitempty"`
}
ProductInfo 商品具体信息
type ProductListRequest ¶
type ProductListRequest struct {
// From 偏移,从0开始
From int `json:"from,omitempty"`
// Limit 每页条数
Limit int `json:"limit,omitempty"`
// Query 搜索关键词,具体含义与queryType相关
Query string `json:"query,omitempty"`
// QueryType 搜索类型
QueryType int `json:"queryType,omitempty"`
// MaxPrice 商品最高价格,单位分
MaxPrice int64 `json:"maxPrice,omitempty"`
// MinPrice 商品最低价格,单位分
MinPrice int64 `json:"minPrice,omitempty"`
// MinCommissionValue 佣金金额下限,单位分
MinCommissionValue int64 `json:"minCommissionValue,omitempty"`
// MinCommissionRatio 佣金比例下限,单位万分之一
MinCommissionRatio int64 `json:"minCommissionRatio,omitempty"`
// SortType
SortType int `json:"sortType,omitempty"`
// CategoryID 单个类目ID,值来自获取类目列表接口
CategoryID uint64 `json:"categoryId,omitempty"`
// ShopAppIDs 小商店AppID列表
ShopAppIDs []string `json:"shopAppIds,omitempty"`
// HasCoupon 是否有联盟券,1为含券商品,0为全部商品
HasCoupon int `json:"hasCoupon,omitempty"`
// Category 多个类目ID,多个用英文逗号分隔。若与 categoryid 同时存在,取categoryid
Category string `json:"category,omitempty"`
// NoCategory 黑名单类目ID,不拉出黑名单类目商品,多个用英文逗号分隔
NoCategory string `json:"noCategory,omitempty"`
// ProductID 商品SPUID,多个用英文逗号分隔
ProductID string `json:"productId,omitempty"`
// ShippingMethod 配送方式,JSON对象字符串,具体结构见shippingMethods 的结构
ShippingMethods *ShippingMethods `json:"shippingMethods,omitempty"`
// AddressList 发货地址列表,JSON数组字符串,单个结构见address
AddressList []Address `json:"addressList,omitempty"`
}
ProductListRequest 查询全量商品 API Request
type ProductListResult ¶
type ProductSkuInfo ¶
type ProductSkuInfo struct {
// ThumbImg 商品SKU 小图
ThumbImg string `json:"thumbImg,omitempty"`
// SalePrice 商品SKU 销售价格,单位分
SalePrice int64 `json:"salePrice,omitempty"`
// MarketPrice 商品SKU 市场价格,单位分
MarketPrice int64 `json:"marketPrice,omitempty"`
// StockInfo 商品SKU 库存
StockInfo *StockInfo `json:"stockInfo,omitempty"`
}
ProductSkuInfo 商品SKU 小图
type PromotionInfo ¶
type PromotionInfo struct {
// PromotionSourcePid 推广位 id
PromotionSourcePid string `json:"promotionSourcePid,omitempty"`
// PromotionSourceName 推广位名称
PromotionSourceName string `json:"promotionSourceName,omitempty"`
}
PromotionInfo 推广信息
type SameCityTemplate ¶
type SameCityTemplate struct {
// DeliverScopeType 配送范围的定义方式,0:按照距离定义配送范围,1:按照区域定义配送范围
DeliverScopeType int `json:"deliverScopeType,omitempty"`
// Scope 配送范围
Scope string `json:"scope,omitempty"`
// Region 全城配送时的配送范围,结构同addressInfo
Region *AddressInfo `json:"region,omitempty"`
}
SameCityTemplate 配送范围,只有当配送方式包含「同城配送」才出该项
type ShareInfo ¶
type ShareInfo struct {
AppID string `json:"appId,omitempty"`
Path string `json:"path,omitempty"`
CouponPath string `json:"couponPath,omitempty"`
PromotionURL string `json:"promotionUrl,omitempty"`
CouponPromotionURL string `json:"couponPromotionUrl,omitempty"`
PromotionWording string `json:"promotionWording,omitempty"`
CouponPromotionWording string `json:"couponPromotionWording,omitempty"`
PromotionTag string `json:"promotionTag,omitempty"`
CouponPromotionTag string `json:"couponPromotionTag,omitempty"`
}
ShareInfo 推广相关信息
type ShareProduct ¶
type ShareProduct struct {
ProductID string `json:"productId,omitempty"`
AppID string `json:"appId,omitempty"`
CustomizeInfo string `json:"customizeInfo,omitempty"`
ProductInfo *ProductInfo `json:"productInfo,omitempty"`
ShareInfo *ShareInfo `json:"shareInfo,omitempty"`
}
ShareProduct 商品
func ProductGenerate ¶
func ProductGenerate(clt *core.Client, req *ProductGenerateRequest) (list []ShareProduct, err error)
拉取会员信息(积分查询)接口 ProductGenerate 获取商品推广素材 通过该接口获取商品的推广素材,包括店铺appID、商品详情页Path、推广文案及推广短链、商品图片等
type ShippingMethods ¶
type ShippingMethods struct {
// Express 是否支持快递,1:是,0:否
Express int `json:"express,omitempty"`
// SameCity 是否支持同城配送,1:是,0:否
SameCity int `json:"sameCity,omitempty"`
// Pickup 是否支持上门自提,1:是,0:否
Pickup int `json:"pickup,omitempty"`
}
ShippingMethods 配送方式,JSON对象字符串,具体结构见shippingMethods 的结构
type ShopInfo ¶
type ShopInfo struct {
// Name 小商店名称
Name string `json:"name,omitempty"`
// AppID 小商店AppID
AppID string `json:"appId,omitempty"`
// Username 小商店原始id
Username string `json:"username,omitempty"`
// HeadImgUrl 小商店店铺头像
HeadImgUrl string `json:"headImgUrl,omitempty"`
// ShippingMethods 配送方式,结构见shippingMethods 的结构
ShippingMethods *ShippingMethods `json:"shippingMethods,omitempty"`
// AddressList 发货地,只有当配送方式包含「同城配送、上门自提」才出该项
AddressList []Address `json:"addressList,omitempty"`
// SameCityTemplate 配送范围,只有当配送方式包含「同城配送」才出该项
SameCityTemplate *SameCityTemplate `json:"sameCityTemplate,omitempty"`
// FreightTemplate 运费模板,只有当配送方式包含「快递」才出此项
FreightTemplate *FreightTemplate `json:"freightTemplate,omitempty"`
}
ShopInfo 商品所属小商店数据
type Sku ¶
type Sku struct {
// SkuID 商品SKU ID
SkuID string `json:"skuId,omitempty"`
// ProductSkuInfo 商品SKU 小图
ProductSkuInfo *ProductSkuInfo `json:"productSkuInfo,omitempty"`
}
Sku 商品SKU