shopeego

package module
v1.6.10 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2022 License: MIT Imports: 13 Imported by: 0

README

NO LONGER MAINTAINED (已暫停維護)

NOT RECOMMEND TO USE(暫不建議使用)

 

ShopeeGo GoDoc Coverage Status Build Status Go Report Card

Golang 所實作的 Shopee Open Platform API,包含所有 Shopee API v1 所提供的功能,這些功能都已經列舉在本專案的 Go Doc 之中。使用方式詳見 Shopee Open Platform Documentation

注意: Shopeego 是根據 Shopee 所提供的 API 文件與資料型態進行開發,但有些資料型態明顯是不正確的,這部份請參閱「參差不齊的官方文件」章節。

安裝方式

打開終端機並且透過 go get 安裝此套件即可。

$ go get gopkg.in/teacat/shopeego.v1

開始使用

透過 NewClient 並傳入你的 Partner 金鑰,如此一來就可以初始化一個 Shopee 客戶端。

// 初始化一個 Shopee 客戶端。
client := shopeego.NewClient(&shopeego.ClientOptions{
	Secret: "0c2c7b3bd59c2503f49a307fcf49dc985df43a1214821d5453e9ba54ca8e2e44",
})

// 取得指定商店的資料。
shop, _ := client.GetShopInfo(&shopeego.GetShopInfoRequest{
	PartnerID: 841237,
	ShopID:    307271,
	Timestamp: int(time.Now().Unix()),
})

fmt.Println(shop.ShopName) // 輸出:yamiodymel

參差不齊的官方文件

這個 API 套件在開發的時候發現了下列幾個問題。

這些問題你可能會在使用時遇到,當遇到 API 無法正常使用或是出現 error_param 時,請考慮到 Issue 中回報。

驗證介面

欲連接的賣場必須授權給你的 Shopee Open Platform 應用程式 才能夠與其對接。

簽署

這個套件仍然有幫你作這件事,但還是想讓你知道發生了什麼。應蝦皮官方要求所有的請求都必須簽署 HMAC-SHA256,很明顯這是有點神奇的蹦蹦安全手段(畢竟都已經有了 HTTPS)。如果你不明白,這裡舉個範例。

POST /api/v1/orders/detail HTTP/1.1
Host: partner.shopeemobile.com
Authorization: b37c061daf2fcfa2baffe7539110938be5b7525041c147e78ad8afa78cc1a72d

{"ordersn": "160726152598865", "shopid": 61299, "partner_id": 1, "timestamp": 1470198856}

在請求標頭的 Authorization 欄位中,這個雜湊碼來自於「請求網址|內容」並透過你的 API 金鑰作為祕密(Secret)演算而成。

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// There are errors in the input parameters
	ErrParams = errors.New("shopeego: there are errors in the input parameters")
	// The request is not authenticated. Ex: signature is wrong
	ErrAuth = errors.New("shopeego: the request is not authenticated. Ex: signature is wrong")
	// An error has occurred
	ErrServer = errors.New("shopeego: an error has occurred")
	// Too many request.Exceed 1000 request per min will be banned for an hour
	ErrTooManyRequest = errors.New("shopeego: too many request.Exceed 1000 request per min will be banned for an hour")
	// Not support action
	ErrNotSupport = errors.New("shopeego: not support action")
	// An inner error has occurred
	ErrInnerError = errors.New("shopeego: an inner error has occurred")
	// No Permission
	ErrPermission = errors.New("shopeego: no permission")
	// Not exist
	ErrNotExists = errors.New("shopeego: not exists")
)

Functions

This section is empty.

Types

type AccountHealthShopPenaltyRequest added in v1.5.0

type AccountHealthShopPenaltyRequest struct {
	V2RequestAuthenticationParams
}

======================================================= AccountHealthShopPenaltyRequest =======================================================

type AccountHealthShopPenaltyResponse added in v1.5.0

type AccountHealthShopPenaltyResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= AccountHealthShopPenaltyResponse =======================================================

type AccountHealthShopPerformanceRequest added in v1.5.0

type AccountHealthShopPerformanceRequest struct {
	V2RequestAuthenticationParams
}

======================================================= AccountHealthShopPerformanceRequest =======================================================

type AccountHealthShopPerformanceResponse added in v1.5.0

type AccountHealthShopPerformanceResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= AccountHealthShopPerformanceResponse =======================================================

type AddDiscountItemRequestItem

type AddDiscountItemRequestItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	//
	Variations []AddDiscountItemRequestItemVariation `json:"variations,omitempty"`
	// The discount price of the item. If the item has no variation, this param is necessary.
	ItemPromotionPrice float64 `json:"item_promotion_price,omitempty,string"`
	// The max number of this product in the promotion price.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
}

type AddDiscountItemRequestItemVariation

type AddDiscountItemRequestItemVariation struct {
	// Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0.
	VariationID int64 `json:"variation_id,omitempty"`
	// The discount price of the item.
	VariationPromotionPrice float64 `json:"variation_promotion_price,omitempty,string"`
}

type AddDiscountRequestItem

type AddDiscountRequestItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	//
	Variations []AddDiscountRequestItemVariation `json:"variations,omitempty"`
	// The discount price of the item. If the item has no variation, this param is necessary.
	ItemPromotionPrice float64 `json:"item_promotion_price,omitempty,string"`
	// The max number of this product in the promotion price.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
}

type AddDiscountRequestItemVariation

type AddDiscountRequestItemVariation struct {
	// Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0.
	VariationID int64 `json:"variation_id,omitempty"`
	// The discount price of the item.
	VariationPromotionPrice float64 `json:"variation_promotion_price,omitempty,string"`
}

type AddOnDealAddAddOnDeal added in v1.5.1

type AddOnDealAddAddOnDeal struct {
	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealAddAddOnDeal =======================================================

type AddOnDealAddAddOnDealMainItem added in v1.5.1

type AddOnDealAddAddOnDealMainItem struct {
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []AddOnDealAddAddOnDealMainItemMainItem `json:"main_item_list"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealAddAddOnDealMainItem =======================================================

type AddOnDealAddAddOnDealMainItemMainItem added in v1.5.5

type AddOnDealAddAddOnDealMainItemMainItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
}

======================================================= Object Raw Type - AddOnDealAddAddOnDealMainItemMainItem =======================================================

type AddOnDealAddAddOnDealMainItemRequest added in v1.5.0

type AddOnDealAddAddOnDealMainItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []MainItemList `json:"main_item_list"`
}

======================================================= AddOnDealAddAddOnDealMainItemRequest =======================================================

type AddOnDealAddAddOnDealMainItemResponse added in v1.5.0

type AddOnDealAddAddOnDealMainItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealAddAddOnDealMainItem `json:"response"`
}

======================================================= AddOnDealAddAddOnDealMainItemResponse =======================================================

type AddOnDealAddAddOnDealRequest added in v1.5.0

type AddOnDealAddAddOnDealRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_name is Title of the add on deal
	AddOnDealName string `json:"add_on_deal_name"`
	// start_time is The time when add on deal activity start.
	StartTime int `json:"start_time"`
	// end_time is The time when add on deal activity end
	EndTime int `json:"end_time"`
	// promotion_type is The type of add on deal:add on discount =0;gift with mini spend=1
	PromotionType int `json:"promotion_type"`
	// purchase_min_spend is The minimum purchase amount that needs to be met to buy the gift with min.Spend
	PurchaseMinSpend float64 `json:"purchase_min_spend,omitempty,string"`
	// per_gift_num is Number of gifts that buyers can get
	PerGiftNum int `json:"per_gift_num,omitempty"`
	// promotion_purchase_limit is promotion_purchase_limit
	PromotionPurchaseLimit int `json:"promotion_purchase_limit,omitempty"`
}

======================================================= AddOnDealAddAddOnDealRequest =======================================================

type AddOnDealAddAddOnDealResponse added in v1.5.0

type AddOnDealAddAddOnDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealAddAddOnDeal `json:"response,omitempty"`
}

======================================================= AddOnDealAddAddOnDealResponse =======================================================

type AddOnDealAddAddOnDealSubItem added in v1.5.1

type AddOnDealAddAddOnDealSubItem struct {
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []AddOnDealAddAddOnDealSubItemSubItem `json:"sub_item_list"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealAddAddOnDealSubItem =======================================================

type AddOnDealAddAddOnDealSubItemRequest added in v1.5.0

type AddOnDealAddAddOnDealSubItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []SubItemList `json:"sub_item_list"`
}

======================================================= AddOnDealAddAddOnDealSubItemRequest =======================================================

type AddOnDealAddAddOnDealSubItemResponse added in v1.5.0

type AddOnDealAddAddOnDealSubItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealAddAddOnDealSubItem `json:"response"`
}

======================================================= AddOnDealAddAddOnDealSubItemResponse =======================================================

type AddOnDealAddAddOnDealSubItemSubItem added in v1.5.5

type AddOnDealAddAddOnDealSubItemSubItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// fail_error is
	FailError string `json:"fail_error,omitempty"`
	// fail_message is
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - AddOnDealAddAddOnDealSubItemSubItem =======================================================

type AddOnDealDeleteAddOnDeal added in v1.5.1

type AddOnDealDeleteAddOnDeal struct {
	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealDeleteAddOnDeal =======================================================

type AddOnDealDeleteAddOnDealMainItem added in v1.5.1

type AddOnDealDeleteAddOnDealMainItem struct {
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []int `json:"main_item_list,omitempty"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealDeleteAddOnDealMainItem =======================================================

type AddOnDealDeleteAddOnDealMainItemRequest added in v1.5.0

type AddOnDealDeleteAddOnDealMainItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// main_item_list is  The main items added in this add on deal promotion.
	MainItemList []int `json:"main_item_list"`
}

======================================================= AddOnDealDeleteAddOnDealMainItemRequest =======================================================

type AddOnDealDeleteAddOnDealMainItemResponse added in v1.5.0

type AddOnDealDeleteAddOnDealMainItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealDeleteAddOnDealMainItem `json:"response"`
}

======================================================= AddOnDealDeleteAddOnDealMainItemResponse =======================================================

type AddOnDealDeleteAddOnDealRequest added in v1.5.0

type AddOnDealDeleteAddOnDealRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
}

======================================================= AddOnDealDeleteAddOnDealRequest =======================================================

type AddOnDealDeleteAddOnDealResponse added in v1.5.0

type AddOnDealDeleteAddOnDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealDeleteAddOnDeal `json:"response"`
}

======================================================= AddOnDealDeleteAddOnDealResponse =======================================================

type AddOnDealDeleteAddOnDealSubItem added in v1.5.1

type AddOnDealDeleteAddOnDealSubItem struct {
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []AddOnDealDeleteAddOnDealSubItemSubItem `json:"sub_item_list"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealDeleteAddOnDealSubItem =======================================================

type AddOnDealDeleteAddOnDealSubItemRequest added in v1.5.0

type AddOnDealDeleteAddOnDealSubItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []SubItemList `json:"sub_item_list"`
}

======================================================= AddOnDealDeleteAddOnDealSubItemRequest =======================================================

type AddOnDealDeleteAddOnDealSubItemResponse added in v1.5.0

type AddOnDealDeleteAddOnDealSubItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealDeleteAddOnDealSubItem `json:"response"`
}

======================================================= AddOnDealDeleteAddOnDealSubItemResponse =======================================================

type AddOnDealDeleteAddOnDealSubItemSubItem added in v1.5.5

type AddOnDealDeleteAddOnDealSubItemSubItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// fail_error is
	FailError string `json:"fail_error,omitempty"`
	// fail_message is
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - AddOnDealDeleteAddOnDealSubItemSubItem =======================================================

type AddOnDealEndAddOnDeal added in v1.5.1

type AddOnDealEndAddOnDeal struct {
	// add_on_deal_id is The identifier of the API request for error tracking
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealEndAddOnDeal =======================================================

type AddOnDealEndAddOnDealRequest added in v1.5.0

type AddOnDealEndAddOnDealRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is The identifier of the API request for error tracking
	AddOnDealID int `json:"add_on_deal_id"`
}

======================================================= AddOnDealEndAddOnDealRequest =======================================================

type AddOnDealEndAddOnDealResponse added in v1.5.0

type AddOnDealEndAddOnDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealEndAddOnDeal `json:"response"`
}

======================================================= AddOnDealEndAddOnDealResponse =======================================================

type AddOnDealGetAddOnDeal added in v1.5.1

type AddOnDealGetAddOnDeal struct {
	// start_time is The time when add on deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when add on deal activity end
	EndTime int `json:"end_time,omitempty"`
	// promotion_type is The type of add on deal:add on discount =0;gift with mini spend=1
	PromotionType int `json:"promotion_type,omitempty"`
	// purchase_min_spend is The minimum purchase amount that needs to be met to buy the gift with min.Spend
	PurchaseMinSpend float64 `json:"purchase_min_spend,omitempty,string"`
	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// per_gift_num is Number of gifts that buyers can get
	PerGiftNum int `json:"per_gift_num,omitempty"`
	// sub_item_priority is The order of the sub item
	SubItemPriority []int `json:"sub_item_priority,omitempty"`
	// promotion_purchase_limit is Max. number of add-on products that a customer can purchase per order.
	PromotionPurchaseLimit int `json:"promotion_purchase_limit,omitempty"`
	// add_on_deal_name is Title of the add on deal
	AddOnDealName string `json:"add_on_deal_name,omitempty"`
	// source is
	Source int `json:"source,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDeal =======================================================

type AddOnDealGetAddOnDealList added in v1.5.1

type AddOnDealGetAddOnDealList struct {
	// add_on_deal_list is The list of add on deal id
	AddOnDealList []AddOnDealGetAddOnDealListAddOnDeal `json:"add_on_deal_list"`
	// more is This is to indicate whether the promotion list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of promotions.
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealList =======================================================

type AddOnDealGetAddOnDealListAddOnDeal added in v1.5.5

type AddOnDealGetAddOnDealListAddOnDeal struct {
	// start_time is The time when add on deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when add on deal activity end
	EndTime int `json:"end_time,omitempty"`
	// promotion_type is The type of add on deal:add on discount =0;gift with mini spend=1
	PromotionType int `json:"promotion_type,omitempty"`
	// purchase_min_spend is The minimum purchase amount that needs to be met to buy the gift with min.Spend
	PurchaseMinSpend float64 `json:"purchase_min_spend,omitempty,string"`
	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// per_gift_num is Number of gifts that buyers can get
	PerGiftNum int `json:"per_gift_num,omitempty"`
	// promotion_purchase_limit is Max. number of add-on products that a customer can purchase per order.
	PromotionPurchaseLimit int `json:"promotion_purchase_limit,omitempty"`
	// add_on_deal_name is Title of the add on deal
	AddOnDealName string `json:"add_on_deal_name,omitempty"`
	// source is The create source of bundle deal:Seller=1,shopee admin=0
	Source int `json:"source,omitempty"`
	// sub_item_prioriry is The display sequence of sub item in buyer side
	SubItemPrioriry []int `json:"sub_item_prioriry,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealListAddOnDeal =======================================================

type AddOnDealGetAddOnDealListRequest added in v1.5.0

type AddOnDealGetAddOnDealListRequest struct {
	V2RequestAuthenticationParams

	// promotion_status is The Status of add on deal,default status is all
	PromotionStatus string `json:"promotion_status"`
	// page_no is The default page number is 1
	PageNo int `json:"page_no,omitempty"`
	// page_size is The default page size is 100
	PageSize int `json:"page_size,omitempty"`
}

======================================================= AddOnDealGetAddOnDealListRequest =======================================================

type AddOnDealGetAddOnDealListResponse added in v1.5.0

type AddOnDealGetAddOnDealListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealGetAddOnDealList `json:"response,omitempty"`
}

======================================================= AddOnDealGetAddOnDealListResponse =======================================================

type AddOnDealGetAddOnDealMainItem added in v1.5.1

type AddOnDealGetAddOnDealMainItem struct {
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []AddOnDealGetAddOnDealMainItemMainItem `json:"main_item_list"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealMainItem =======================================================

type AddOnDealGetAddOnDealMainItemMainItem added in v1.5.5

type AddOnDealGetAddOnDealMainItemMainItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealMainItemMainItem =======================================================

type AddOnDealGetAddOnDealMainItemRequest added in v1.5.0

type AddOnDealGetAddOnDealMainItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
}

======================================================= AddOnDealGetAddOnDealMainItemRequest =======================================================

type AddOnDealGetAddOnDealMainItemResponse added in v1.5.0

type AddOnDealGetAddOnDealMainItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealGetAddOnDealMainItem `json:"response"`
}

======================================================= AddOnDealGetAddOnDealMainItemResponse =======================================================

type AddOnDealGetAddOnDealRequest added in v1.5.0

type AddOnDealGetAddOnDealRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
}

======================================================= AddOnDealGetAddOnDealRequest =======================================================

type AddOnDealGetAddOnDealResponse added in v1.5.0

type AddOnDealGetAddOnDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealGetAddOnDeal `json:"response"`
}

======================================================= AddOnDealGetAddOnDealResponse =======================================================

type AddOnDealGetAddOnDealSubItem added in v1.5.1

type AddOnDealGetAddOnDealSubItem struct {
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []AddOnDealGetAddOnDealSubItemSubItem `json:"sub_item_list"`
	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealSubItem =======================================================

type AddOnDealGetAddOnDealSubItemRequest added in v1.5.0

type AddOnDealGetAddOnDealSubItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
}

======================================================= AddOnDealGetAddOnDealSubItemRequest =======================================================

type AddOnDealGetAddOnDealSubItemResponse added in v1.5.0

type AddOnDealGetAddOnDealSubItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealGetAddOnDealSubItem `json:"response"`
}

======================================================= AddOnDealGetAddOnDealSubItemResponse =======================================================

type AddOnDealGetAddOnDealSubItemSubItem added in v1.5.5

type AddOnDealGetAddOnDealSubItemSubItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
	// sub_item_limit is The purchase limit of each sub item. Only the add on discount can be set and the default limit of gift with mini.spend is 1
	SubItemLimit int `json:"sub_item_limit,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// price is
	Price AddOnDealGetAddOnDealSubItemSubItemPrice `json:"price"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealSubItemSubItem =======================================================

type AddOnDealGetAddOnDealSubItemSubItemPrice added in v1.5.5

type AddOnDealGetAddOnDealSubItemSubItemPrice struct {
	// promo_input_price is Add-on discount price before tax
	PromoInputPrice AddOnDealGetAddOnDealSubItemSubItemPricePromoInputPrice `json:"promo_input_price,string"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealSubItemSubItemPrice =======================================================

type AddOnDealGetAddOnDealSubItemSubItemPricePromoInputPrice added in v1.5.5

type AddOnDealGetAddOnDealSubItemSubItemPricePromoInputPrice struct {
	// promo_price is Add-on discount price after tax
	PromoPrice float64 `json:"promo_price,omitempty,string"`
}

======================================================= Object Raw Type - AddOnDealGetAddOnDealSubItemSubItemPricePromoInputPrice =======================================================

type AddOnDealUpdateAddOnDeal added in v1.5.1

type AddOnDealUpdateAddOnDeal struct {
	// start_time is The time when add on deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when add on deal activity end
	EndTime int `json:"end_time,omitempty"`
	// promotion_type is The type of add on deal:add on discount =0;gift with mini spend=1
	PromotionType int `json:"promotion_type,omitempty"`
	// purchase_min_spend is The minimum purchase amount that needs to be met to buy the gift with min.Spend
	PurchaseMinSpend float64 `json:"purchase_min_spend,omitempty,string"`
	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// per_gift_num is Number of gifts that buyers can get
	PerGiftNum int `json:"per_gift_num,omitempty"`
	// promotion_purchase_limit is Max. number of add-on products that a customer can purchase per order.
	PromotionPurchaseLimit int `json:"promotion_purchase_limit,omitempty"`
	// add_on_deal_name is Title of the add on deal
	AddOnDealName string `json:"add_on_deal_name,omitempty"`
}

======================================================= Object Raw Type - AddOnDealUpdateAddOnDeal =======================================================

type AddOnDealUpdateAddOnDealMainItem added in v1.5.1

type AddOnDealUpdateAddOnDealMainItem struct {
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []AddOnDealUpdateAddOnDealMainItemMainItem `json:"main_item_list"`
}

======================================================= Object Raw Type - AddOnDealUpdateAddOnDealMainItem =======================================================

type AddOnDealUpdateAddOnDealMainItemMainItem added in v1.5.5

type AddOnDealUpdateAddOnDealMainItemMainItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
}

======================================================= Object Raw Type - AddOnDealUpdateAddOnDealMainItemMainItem =======================================================

type AddOnDealUpdateAddOnDealMainItemRequest added in v1.5.0

type AddOnDealUpdateAddOnDealMainItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// main_item_list is The main items added in this add on deal promotion.
	MainItemList []MainItemList `json:"main_item_list"`
}

======================================================= AddOnDealUpdateAddOnDealMainItemRequest =======================================================

type AddOnDealUpdateAddOnDealMainItemResponse added in v1.5.0

type AddOnDealUpdateAddOnDealMainItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealUpdateAddOnDealMainItem `json:"response"`
}

======================================================= AddOnDealUpdateAddOnDealMainItemResponse =======================================================

type AddOnDealUpdateAddOnDealRequest added in v1.5.0

type AddOnDealUpdateAddOnDealRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for an add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// start_time is The time when bundle deal activity start.The start time must be 1 hour than current time.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when bundle deal activity end. The end time must be later than start time.
	EndTime int `json:"end_time,omitempty"`
	// purchase_min_spend is The minimum purchase amount that needs to be met to buy the gift with min.Spend
	PurchaseMinSpend float64 `json:"purchase_min_spend,omitempty,string"`
	// per_gift_num is Number of gifts that buyers can get
	PerGiftNum int `json:"per_gift_num,omitempty"`
	// promotion_purchase_limit is Max. number of add-on products that a customer can purchase per order.
	PromotionPurchaseLimit int `json:"promotion_purchase_limit,omitempty"`
	// sub_item_priority is The order of sub item
	SubItemPriority []int `json:"sub_item_priority,omitempty"`
	// add_on_deal_name is Title of the add on deal
	AddOnDealName string `json:"add_on_deal_name,omitempty"`
}

======================================================= AddOnDealUpdateAddOnDealRequest =======================================================

type AddOnDealUpdateAddOnDealResponse added in v1.5.0

type AddOnDealUpdateAddOnDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealUpdateAddOnDeal `json:"response,omitempty"`
}

======================================================= AddOnDealUpdateAddOnDealResponse =======================================================

type AddOnDealUpdateAddOnDealSubItem added in v1.5.1

type AddOnDealUpdateAddOnDealSubItem struct {
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []AddOnDealUpdateAddOnDealSubItemSubItem `json:"sub_item_list"`
}

======================================================= Object Raw Type - AddOnDealUpdateAddOnDealSubItem =======================================================

type AddOnDealUpdateAddOnDealSubItemRequest added in v1.5.0

type AddOnDealUpdateAddOnDealSubItemRequest struct {
	V2RequestAuthenticationParams

	// add_on_deal_id is Shopee's unique identifier for add on deal activity.
	AddOnDealID int `json:"add_on_deal_id"`
	// sub_item_list is The sub items added in this add on deal promotion.
	SubItemList []SubItemList `json:"sub_item_list"`
}

======================================================= AddOnDealUpdateAddOnDealSubItemRequest =======================================================

type AddOnDealUpdateAddOnDealSubItemResponse added in v1.5.0

type AddOnDealUpdateAddOnDealSubItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response AddOnDealUpdateAddOnDealSubItem `json:"response"`
}

======================================================= AddOnDealUpdateAddOnDealSubItemResponse =======================================================

type AddOnDealUpdateAddOnDealSubItemSubItem added in v1.5.5

type AddOnDealUpdateAddOnDealSubItemSubItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// fail_error is
	FailError string `json:"fail_error,omitempty"`
	// fail_message is
	FailMessage string `json:"fail_message,omitempty"`
	// sub_item_input_price is The discounted price of sub item
	SubItemInputPrice float64 `json:"sub_item_input_price,omitempty,string"`
	// sub_item_limit is The purchase limit of sub item.The purchase limit of each sub item. Only the add on discount can be set and the default limit of gift with mini.spend is 1
	SubItemLimit int `json:"sub_item_limit,omitempty"`
}

======================================================= Object Raw Type - AddOnDealUpdateAddOnDealSubItemSubItem =======================================================

type AddRequestAttribute

type AddRequestAttribute struct {
	// related to shopee.item.GetAttributes result.attributes.attribute_id
	AttributesID int64 `json:"attributes_id,omitempty"`
	// related to shopee.item.GetAttributes one of result.attributes.options. Max length is 40 letters.
	Value string `json:"value,omitempty"`
}

type AddRequestImage

type AddRequestImage struct {
	// Url of items' image.The system would synchronous download the image one by one.if one of those image can not fetch, would get a warning in result.But can continue the AddItem proccessing.
	// if all image failed to fetch, would return an error.
	URL string `json:"url,omitempty"`
}

type AddRequestLogistic

type AddRequestLogistic struct {
	// related to shopee.logistics.GetLogistics result.logistics.logistic_id
	LogisticID int64 `json:"logistic_id,omitempty"`
	// related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item
	Enabled bool `json:"enabled,omitempty"`
	// Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// If specify logistic fee_type is SIZE_SELECTION size_id is required
	SizeID int64 `json:"size_id,omitempty"`
	// when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
}

type AddRequestVariation

type AddRequestVariation struct {
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Max Length: 20 letters
	Name string `json:"name,omitempty"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// The current price of the variation in the listing currency.
	Price float64 `json:"price,omitempty,string"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSku string `json:"variation_sku,omitempty"`
}

type AddRequestWholesale

type AddRequestWholesale struct {
	// The min count of this tier wholesale. If the wholesale is not the first one, the min count must equal to max count of last tier plus one.
	Min int `json:"min,omitempty"`
	// The max count of this tier wholesale.
	Max int `json:"max,omitempty"`
	// The current price of the wholesale in the listing currency. The price must be cheaper than original price. And if the wholesale is not the first one, the price must be cheaper than previous tier.
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

type AddResponseItem

type AddResponseItem struct {
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// Enumerated type that defines the current status of the item. Applicable values: NORMAL, DELETED, UNLIST and BANNED.
	Status string `json:"status,omitempty"`
	// Name of the item in local language.
	Name string `json:"name,omitempty"`
	// Description of the item in local language.
	Description string `json:"description,omitempty"`
	// Image URLs of the item. It contains at most 9 URLs.
	Images []string `json:"images,omitempty"`
	// The three-digit code representing the currency unit used for the item in Shopee Listings.
	Currency string `json:"currency,omitempty"`
	// This is to indicate whether the item has variation(s).
	HasVariation bool `json:"has_variation,omitempty"`
	// The current price of the item in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the item.
	Stock int `json:"stock,omitempty"`
	// Timestamp that indicates the date and time that the item was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// the net weight of this item, the unit is KG.
	Weight float64 `json:"weight,omitempty,string"`
	// Could call shopee.item.GetCategories to get category detail.Related to result.categories.category_id.
	CategoryID int64 `json:"category_id,omitempty"`
	// The original price of the item in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The variation list of item.
	Variations []AddResponseItemVariation `json:"variations,omitempty"`
	//
	Attributes []AddResponseItemAttribute `json:"attributes,omitempty"`
	// The logistics list.
	Logistics []AddResponseItemLogistic `json:"logistics,omitempty"`
	// The wholesales tier list.
	Wholesales []AddResponseItemWholesale `json:"wholesales,omitempty"`
	// The sales volume of item.
	Sales int `json:"sales,omitempty"`
	// The page view of item.
	Views int `json:"views,omitempty"`
	// The conllection number of item.
	Likes int `json:"likes,omitempty"`
	// The length of package for this single item, the unit is CM
	PackageLength int `json:"package_length,omitempty"`
	// The width of package for this single item, the unit is CM
	PackageWidth int `json:"package_width,omitempty"`
	// The height of package for this single item, the unit is CM
	PackageHeight int `json:"package_height,omitempty"`
	// The guaranteed days to ship orders. For pre-order, please input value from 7 to 30; for non pre-order, please exclude this field and it will default to the respective standard per your shop location.(e.g. 3 for CrossBorder)
	DaysToShip int `json:"days_to_ship,omitempty"`
	// The rating star scores of this item.
	RatingStar float64 `json:"rating_star,omitempty,string"`
	// Count of comments for the item.
	CMTCount int `json:"cmt_count,omitempty"`
	// This indicates whether the item is secondhand.
	Condition string `json:"condition,omitempty"`
	// The ID of discount activity the item is currently in. One item can only have one discount at a time. discount_id will be 0 if the item has no discount applied, or item has variation.
	DiscountID int64 `json:"discount_id,omitempty"`
	// Use this field to identify whether the item is pre-order. Applicable value: true/false.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
}

type AddResponseItemAttribute

type AddResponseItemAttribute struct {
	// The Identify of each category.
	AttributeID int64 `json:"attribute_id,omitempty"`
	// The name of each attribute.
	AttributeName string `json:"attribute_name,omitempty"`
	// This is to indicate whether this attribute is mandantory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// Enumerated type that defines the type of the attribute. Applicable values: See Data Definition- AttributeType.
	AttributeType string `json:"attribute_type,omitempty"`
	// The value of this item attribute.
	AtributeValue string `json:"atribute_value,omitempty"`
}

type AddResponseItemLogistic

type AddResponseItemLogistic struct {
	// The identity of logistic channel.
	LogisticID int64 `json:"logistic_id,omitempty"`
	// The name of logistic.
	LogisticName string `json:"logistic_name,omitempty"`
	// related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item
	Enabled bool `json:"enabled,omitempty"`
	// Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// If specify logistic fee_type is SIZE_SELECTION size_id is required.
	SizeID int64 `json:"size_id,omitempty"`
	// when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
	// Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
}

type AddResponseItemVariation

type AddResponseItemVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// The current price of the variation in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// Enumerated type that defines the current status of the variation. Applicable values: MODEL_NORMAL and MODEL_DELETED.
	Status string `json:"status,omitempty"`
	// Timestamp that indicates the date and time that the variation was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the variation, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// The original price of the variation in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The ID of discount activity the variation is currently in. One variation can only have one discount at a time. discount_id will be 0 if the variation has no discount applied.
	DiscountID int64 `json:"discount_id,omitempty"`
}

type AddResponseItemWholesale

type AddResponseItemWholesale struct {
	// The min count of this tier wholesale.
	Min int `json:"min,omitempty"`
	// The max count of this tier wholesale.
	Max int `json:"max,omitempty"`
	// The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

type AddTierVariationRequestVariation

type AddTierVariationRequestVariation struct {
	// A list of tier variation combination index, which indicates variation's option position in tier_variation['options'] list. e.g. [0,1] means tier variation 1 option 1 and tier variation 2 option 2.
	TierIndex []int `json:"tier_index,omitempty"`
	// Stock value of this variation item. 0 stock will make this variation a greyout option for buyer.
	Stock int `json:"stock,omitempty"`
	// Price value of this variation item.
	Price float64 `json:"price,omitempty,string"`
	// SKU string of this variation item.
	VariationSKU string `json:"variation_sku,omitempty"`
}

type AddTierVariationResponseVariation

type AddTierVariationResponseVariation struct {
	// A list of tier variation indexes, which indicate variation's options in tier_variation['options'] list.
	TierIndex []int `json:"tier_index,omitempty"`
	// The identity of the variation.
	VariationID int64 `json:"variation_id,omitempty"`
}

type AddTopPicksResponseItem

type AddTopPicksResponseItem struct {
	// Item ID
	ItemID int64 `json:"item_id,omitempty"`
	// Item name
	ItemName string `json:"item_name,omitempty"`
	// Item discounted price(original price if no discount). Item level price will return if it has variation.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// The sales of the item
	Sales int `json:"sales,omitempty"`
}

type AddVariationsRequestVariation

type AddVariationsRequestVariation struct {
	// Name of the variation that belongs to the same item.A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// The current price of the variation in the listing currency.
	Price float64 `json:"price,omitempty,string"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
}

type AddVariationsResponseVariation

type AddVariationsResponseVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// The current price of the variation in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// Enumerated type that defines the current status of the variation. Applicable values: MODEL_NORMAL and MODEL_DELETED.
	Status string `json:"status,omitempty"`
	// Timestamp that indicates the date and time that the variation was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the variation, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// The original price of the variation in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

type AddressTypeConfig added in v1.5.0

type AddressTypeConfig struct {
	// address_id is The identifier id of the address.
	AddressID int `json:"address_id,omitempty"`
	// address_type is The type of addres. Available values: DEFAULT_ADDRESS, PICKUP_ADDRESS, RETURN_ADDRESS
	AddressType []string `json:"address_type,omitempty"`
}

======================================================= Object Raw Type - AddressTypeConfig =======================================================

type AttributeList added in v1.5.1

type AttributeList struct {
	// attribute_id is ID of attribute
	AttributeID int `json:"attribute_id,omitempty"`
	// attribute_value_list is
	AttributeValueList []AttributeListAttributeValue `json:"attribute_value_list,omitempty"`
}

======================================================= Object Raw Type - AttributeList =======================================================

type AttributeListAttributeValue added in v1.5.5

type AttributeListAttributeValue struct {
	// value_id is Value ID. In the following cases, the value id needs to be uploaded as 0, and original_value_name is mandatory, needs to be filled in customized value. (1) AttributeInputType is TEXT_FILED; (2) AttributeInputType is COMBO_BOX or MULTIPLE_SELECT_COMBO_BOX, and the seller want to fill in a customized value.
	ValueID int `json:"value_id,omitempty"`
	// original_value_name is Value name. original_value_name from product.get_attributes api. If value id=0, this field is required. If AttributeType is DATE_TYPE or TIMESTAMP_TYPE, you can upload timestamp(string type) as the original_value_name.
	OriginalValueName string `json:"original_value_name,omitempty"`
	// value_unit is Unit of attribute value (quantitative attribute only).
	ValueUnit string `json:"value_unit,omitempty"`
}

======================================================= Object Raw Type - AttributeListAttributeValue =======================================================

type AuthPartnerRequest

type AuthPartnerRequest struct {
	// The credential retrieved in the APP console
	PartnerID int64 `json:"partner_id,omitempty"`
	// An encrypted string generated in accordance with Shopee rule
	// Token string `json:"token,omitempty"`
	// Redirect url. The url to which the page directs after the authorization is completed. It can be any url(e.g. your company official website).
	Redirect string `json:"redirect,omitempty"`
	// Needs to be consistent with the timestamp in sign base string. Expires in 5 minutes.
	Timestamp int `json:"timestamp,omitempty"`
}

type BoostItemResponseBatchResult

type BoostItemResponseBatchResult struct {
	// A list of item ids which have been boosted successfully.
	Successes []int `json:"successes,omitempty"`
	// A list of failed-to-boost items, including error details.
	Failures []BoostItemResponseBatchResultFailure `json:"failures,omitempty"`
}

type BoostItemResponseBatchResultFailure

type BoostItemResponseBatchResultFailure struct {
	// to indicate error type.
	ErrorCode string `json:"error_code,omitempty"`
	// Failed item id.
	ID int64 `json:"id,omitempty"`
	// error description
	Description string `json:"description,omitempty"`
}

type Brand added in v1.5.0

type Brand struct {
	// brand_id is Id of brand.
	BrandID int `json:"brand_id,omitempty"`
}

======================================================= Object Raw Type - Brand =======================================================

type BundleDealAddBundleDeal added in v1.5.1

type BundleDealAddBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
}

======================================================= Object Raw Type - BundleDealAddBundleDeal =======================================================

type BundleDealAddBundleDealItem added in v1.5.1

type BundleDealAddBundleDealItem struct {
	// failed_list is Indicate error details.
	FailedList []BundleDealAddBundleDealItemFailed `json:"failed_list"`
	// success_list is The list of succeed added items
	SuccessList []map[string]interface{} `json:"success_list,omitempty"`
}

======================================================= Object Raw Type - BundleDealAddBundleDealItem =======================================================

type BundleDealAddBundleDealItemFailed added in v1.5.5

type BundleDealAddBundleDealItemFailed struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - BundleDealAddBundleDealItemFailed =======================================================

type BundleDealAddBundleDealItemRequest added in v1.5.0

type BundleDealAddBundleDealItemRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
	// item_list is The items added in this bundle deal promotion.
	ItemList []ItemList `json:"item_list"`
}

======================================================= BundleDealAddBundleDealItemRequest =======================================================

type BundleDealAddBundleDealItemResponse added in v1.5.0

type BundleDealAddBundleDealItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response BundleDealAddBundleDealItem `json:"response"`
}

======================================================= BundleDealAddBundleDealItemResponse =======================================================

type BundleDealAddBundleDealRequest added in v1.5.0

type BundleDealAddBundleDealRequest struct {
	V2RequestAuthenticationParams

	// rule_type is The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
	RuleType int `json:"rule_type"`
	// discount_value is The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
	DiscountValue float64 `json:"discount_value,string"`
	// fix_price is The amount of the buyer needs to spend to purchase a bundle deal. Need to input it when the bundle deal rule type is 1
	FixPrice float64 `json:"fix_price,string"`
	// discount_percentage is The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
	DiscountPercentage int `json:"discount_percentage"`
	// min_amount is The quantity of items that need buyer to combine purchased
	MinAmount int `json:"min_amount"`
	// start_time is The time when bundle deal activity start.The start time must be later than current time.
	StartTime int `json:"start_time"`
	// end_time is The time when bundle deal activity end. The end time must be 1 hour later than start time.
	EndTime int `json:"end_time"`
	// name is Title of the bundle deal
	Name string `json:"name"`
	// purchase_limit is Maximum number of bundle deals that can be bought by a buyer.
	PurchaseLimit int `json:"purchase_limit"`
}

======================================================= BundleDealAddBundleDealRequest =======================================================

type BundleDealAddBundleDealResponse added in v1.5.0

type BundleDealAddBundleDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response BundleDealAddBundleDeal `json:"response"`
}

======================================================= BundleDealAddBundleDealResponse =======================================================

type BundleDealDeleteBundleDeal added in v1.5.1

type BundleDealDeleteBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
}

======================================================= Object Raw Type - BundleDealDeleteBundleDeal =======================================================

type BundleDealDeleteBundleDealItem added in v1.5.1

type BundleDealDeleteBundleDealItem struct {
	// failed_list is Indicate error details.
	FailedList []BundleDealDeleteBundleDealItemFailed `json:"failed_list"`
	// success_list is The list of succeed added items
	SuccessList []map[string]interface{} `json:"success_list,omitempty"`
}

======================================================= Object Raw Type - BundleDealDeleteBundleDealItem =======================================================

type BundleDealDeleteBundleDealItemFailed added in v1.5.5

type BundleDealDeleteBundleDealItemFailed struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - BundleDealDeleteBundleDealItemFailed =======================================================

type BundleDealDeleteBundleDealItemRequest added in v1.5.0

type BundleDealDeleteBundleDealItemRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
	// item_list is The items deleted in this bundle deal promotion.
	ItemList []ItemList `json:"item_list"`
}

======================================================= BundleDealDeleteBundleDealItemRequest =======================================================

type BundleDealDeleteBundleDealItemResponse added in v1.5.0

type BundleDealDeleteBundleDealItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response BundleDealDeleteBundleDealItem `json:"response"`
}

======================================================= BundleDealDeleteBundleDealItemResponse =======================================================

type BundleDealDeleteBundleDealRequest added in v1.5.0

type BundleDealDeleteBundleDealRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
}

======================================================= BundleDealDeleteBundleDealRequest =======================================================

type BundleDealDeleteBundleDealResponse added in v1.5.0

type BundleDealDeleteBundleDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response BundleDealDeleteBundleDeal `json:"response"`
}

======================================================= BundleDealDeleteBundleDealResponse =======================================================

type BundleDealEndBundleDeal added in v1.5.1

type BundleDealEndBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
}

======================================================= Object Raw Type - BundleDealEndBundleDeal =======================================================

type BundleDealEndBundleDealRequest added in v1.5.0

type BundleDealEndBundleDealRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
}

======================================================= BundleDealEndBundleDealRequest =======================================================

type BundleDealEndBundleDealResponse added in v1.5.0

type BundleDealEndBundleDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response BundleDealEndBundleDeal `json:"response"`
}

======================================================= BundleDealEndBundleDealResponse =======================================================

type BundleDealGetBundleDeal added in v1.5.1

type BundleDealGetBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
	// name is Title of the bundle deal
	Name string `json:"name,omitempty"`
	// start_time is The time when bundle deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when bundle deal activity end.
	EndTime int `json:"end_time,omitempty"`
	// bundle_deal_rule is
	BundleDealRule BundleDealGetBundleDealBundleDealRule `json:"bundle_deal_rule"`
	// purchase_limit is Maximum number of bundle deals that can be bought by a buyer.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDeal =======================================================

type BundleDealGetBundleDealBundleDealRule added in v1.5.4

type BundleDealGetBundleDealBundleDealRule struct {
	// rule_type is The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
	RuleType int `json:"rule_type,omitempty"`
	// discount_value is The deducted price when when buying a bundle deal.Need to input it when the bundle deal rule type is 3
	DiscountValue float64 `json:"discount_value,omitempty,string"`
	// fix_price is The amount of the buyer needs to spend to purchase a bundle deal. Need to input it when the bundle deal rule type is 1
	FixPrice float64 `json:"fix_price,omitempty,string"`
	// discount_percentage is The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
	DiscountPercentage int `json:"discount_percentage,omitempty"`
	// min_amount is The quantity of items that need buyer to combine purchased
	MinAmount int `json:"min_amount,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealBundleDealRule =======================================================

type BundleDealGetBundleDealItem added in v1.5.1

type BundleDealGetBundleDealItem struct {
	// item_list is The list of bundle deal item
	ItemList []BundleDealGetBundleDealItemItem `json:"item_list"`
	// total_count is The number of  items in this bundle deal
	TotalCount int `json:"total_count,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealItem =======================================================

type BundleDealGetBundleDealItemItem added in v1.5.5

type BundleDealGetBundleDealItemItem struct {
	// item_id is Shopee's unique identifier for a bundle deal activity.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of items:enable = 1,disable =0
	Status int `json:"status,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealItemItem =======================================================

type BundleDealGetBundleDealItemRequest added in v1.5.0

type BundleDealGetBundleDealItemRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
}

======================================================= BundleDealGetBundleDealItemRequest =======================================================

type BundleDealGetBundleDealItemResponse added in v1.5.0

type BundleDealGetBundleDealItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response BundleDealGetBundleDealItem `json:"response"`
}

======================================================= BundleDealGetBundleDealItemResponse =======================================================

type BundleDealGetBundleDealList added in v1.5.1

type BundleDealGetBundleDealList struct {
	// bundle_deal_list is The list of bundle deal id
	BundleDealList []BundleDealGetBundleDealListBundleDeal `json:"bundle_deal_list"`
	// more is this field shows whether there are more bundle deals in next page or not
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealList =======================================================

type BundleDealGetBundleDealListBundleDeal added in v1.5.5

type BundleDealGetBundleDealListBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
	// name is Title of the bundle deal
	Name string `json:"name,omitempty"`
	// start_time is The time when bundle deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when bundle deal activity end.
	EndTime int `json:"end_time,omitempty"`
	// bundle_deal_rule is
	BundleDealRule BundleDealGetBundleDealListBundleDealBundleDealRule `json:"bundle_deal_rule"`
	// purchase_limit is Maximum number of bundle deals that can be bought by a buyer.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealListBundleDeal =======================================================

type BundleDealGetBundleDealListBundleDealBundleDealRule added in v1.5.5

type BundleDealGetBundleDealListBundleDealBundleDealRule struct {
	// rule_type is The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
	RuleType int `json:"rule_type,omitempty"`
	// discount_value is The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
	DiscountValue float64 `json:"discount_value,omitempty,string"`
	// fix_price is The amount of the buyer needs to spend to purchase a bundle deal. Need to input it when the bundle deal rule type is 1
	FixPrice float64 `json:"fix_price,omitempty,string"`
	// discount_percentage is The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
	DiscountPercentage int `json:"discount_percentage,omitempty"`
	// min_amount is The quantity of items that need buyer to combine purchased
	MinAmount int `json:"min_amount,omitempty"`
}

======================================================= Object Raw Type - BundleDealGetBundleDealListBundleDealBundleDealRule =======================================================

type BundleDealGetBundleDealListRequest added in v1.5.0

type BundleDealGetBundleDealListRequest struct {
	V2RequestAuthenticationParams

	// page_size is Data paging, representing the data size of each page, the maximum is 1000, the default is 20
	PageSize int `json:"page_size,omitempty"`
	// time_status is The Status of bundle deal,all=1;upcoming=2;ongoing=3,expired=4 , the default is 1
	TimeStatus int `json:"time_status,omitempty"`
	// page_no is Data paging, represents the page number, starting from 1, the default is 1
	PageNo int `json:"page_no,omitempty"`
}

======================================================= BundleDealGetBundleDealListRequest =======================================================

type BundleDealGetBundleDealListResponse added in v1.5.0

type BundleDealGetBundleDealListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response BundleDealGetBundleDealList `json:"response,omitempty"`
}

======================================================= BundleDealGetBundleDealListResponse =======================================================

type BundleDealGetBundleDealRequest added in v1.5.0

type BundleDealGetBundleDealRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
}

======================================================= BundleDealGetBundleDealRequest =======================================================

type BundleDealGetBundleDealResponse added in v1.5.0

type BundleDealGetBundleDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response BundleDealGetBundleDeal `json:"response"`
}

======================================================= BundleDealGetBundleDealResponse =======================================================

type BundleDealUpdateBundleDeal added in v1.5.1

type BundleDealUpdateBundleDeal struct {
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id,omitempty"`
	// name is Title of the bundle deal
	Name string `json:"name,omitempty"`
	// start_time is The time when bundle deal activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when bundle deal activity end.
	EndTime int `json:"end_time,omitempty"`
	// bundle_deal_rule is
	BundleDealRule BundleDealUpdateBundleDealBundleDealRule `json:"bundle_deal_rule"`
	// purchase_limit is Maximum number of bundle deals that can be bought by a buyer.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
}

======================================================= Object Raw Type - BundleDealUpdateBundleDeal =======================================================

type BundleDealUpdateBundleDealBundleDealRule added in v1.5.4

type BundleDealUpdateBundleDealBundleDealRule struct {
	// rule_type is The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
	RuleType int `json:"rule_type,omitempty"`
	// discount_value is The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
	DiscountValue float64 `json:"discount_value,omitempty,string"`
	// fix_price is The amount of the buyer needs to spend to purchase a bundle deal. Need to input it when the bundle deal rule type is 1
	FixPrice float64 `json:"fix_price,omitempty,string"`
	// discount_percentage is  The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
	DiscountPercentage int `json:"discount_percentage,omitempty"`
	// min_amount is  The quantity of items that need buyer to combine purchased
	MinAmount int `json:"min_amount,omitempty"`
}

======================================================= Object Raw Type - BundleDealUpdateBundleDealBundleDealRule =======================================================

type BundleDealUpdateBundleDealItem added in v1.5.1

type BundleDealUpdateBundleDealItem struct {
	// failed_list is Indicate error details.
	FailedList []BundleDealUpdateBundleDealItemFailed `json:"failed_list"`
	// success_list is The list of succeed added items
	SuccessList []map[string]interface{} `json:"success_list,omitempty"`
}

======================================================= Object Raw Type - BundleDealUpdateBundleDealItem =======================================================

type BundleDealUpdateBundleDealItemFailed added in v1.5.5

type BundleDealUpdateBundleDealItemFailed struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - BundleDealUpdateBundleDealItemFailed =======================================================

type BundleDealUpdateBundleDealItemRequest added in v1.5.0

type BundleDealUpdateBundleDealItemRequest struct {
	V2RequestAuthenticationParams

	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
	// item_list is The items added in this bundle deal promotion.
	ItemList []ItemList `json:"item_list"`
}

======================================================= BundleDealUpdateBundleDealItemRequest =======================================================

type BundleDealUpdateBundleDealItemResponse added in v1.5.0

type BundleDealUpdateBundleDealItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is  Detail informations you are querying.
	Response BundleDealUpdateBundleDealItem `json:"response"`
}

======================================================= BundleDealUpdateBundleDealItemResponse =======================================================

type BundleDealUpdateBundleDealRequest added in v1.5.0

type BundleDealUpdateBundleDealRequest struct {
	V2RequestAuthenticationParams

	// rule_type is The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
	RuleType int `json:"rule_type,omitempty"`
	// discount_value is  The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
	DiscountValue float64 `json:"discount_value,omitempty,string"`
	// fix_price is The amount of the buyer needs to spend to purchase a bundle deal.Need to input it when the bundle deal rule type is 1
	FixPrice float64 `json:"fix_price,omitempty,string"`
	// discount_percentage is The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
	DiscountPercentage int `json:"discount_percentage,omitempty"`
	// min_amount is The quantity of items that need buyer to combine purchased
	MinAmount int `json:"min_amount,omitempty"`
	// start_time is The time when bundle deal activity start.The start time must be later than current time.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when bundle deal activity end. The end time must be later than current time.
	EndTime int `json:"end_time,omitempty"`
	// name is Title of the bundle deal
	Name string `json:"name,omitempty"`
	// purchase_limit is Maximum number of bundle deals that can be bought by a buyer.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
	// bundle_deal_id is Shopee's unique identifier for a bundle deal activity.
	BundleDealID int `json:"bundle_deal_id"`
}

======================================================= BundleDealUpdateBundleDealRequest =======================================================

type BundleDealUpdateBundleDealResponse added in v1.5.0

type BundleDealUpdateBundleDealResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response BundleDealUpdateBundleDeal `json:"response"`
}

======================================================= BundleDealUpdateBundleDealResponse =======================================================

type Client

type Client interface {
	SetAccessToken(t string) *ShopeeClient

	// GetShopInfo Use this call to get information of shop
	GetShopInfo(*GetShopInfoRequest) (*GetShopInfoResponse, error)
	// UpdateShopInfo Use this call to update information of shop
	UpdateShopInfo(*UpdateShopInfoRequest) (*UpdateShopInfoResponse, error)
	// Performance Shop performance includes the indexes from "My Performance" of Seller Center.
	Performance(*PerformanceRequest) (*PerformanceResponse, error)
	// SetShopInstallmentStatus Only for TW whitelisted shop.Use this API to set the installment status of shop.
	SetShopInstallmentStatus(*SetShopInstallmentStatusRequest) (*SetShopInstallmentStatusResponse, error)
	//
	AuthPartner(*AuthPartnerRequest) string

	// GetAccessToken Use this API and the code to obtain the access_token and refresh_token.
	GetAccessToken(*GetAccessTokenRequest) (*GetAccessTokenResponse, error)
	// RefreshAccessToken Use this API to refresh the access_token after it expires.
	RefreshAccessToken(*RefreshAccessTokenRequest) (*RefreshAccessTokenResponse, error)

	// import generated files
	V2I
}

Client 定義了一個蝦皮的客戶端該有什麼功能。

func NewClient

func NewClient(opts *ClientOptions) Client

type ClientOptions

type ClientOptions struct {
	Secret string
	// 非必要
	//PartnerID int64
	// 非必要
	//ShopID int64
	//
	IsSandbox bool
	//
	Version ClientVersion
}

type ClientVersion

type ClientVersion int

ClientVersion is the API version of the client should be using.

const (
	// ClientVersionV1 for Open API V1, see: https://open.shopee.com/documents?module=63&type=2&id=53.
	ClientVersionV1 ClientVersion = iota
	// ClientVersionV2 for Open API V2, see: https://open.shopee.com/documents?module=63&type=2&id=56.
	ClientVersionV2
)

type CommentList added in v1.5.1

type CommentList struct {
	// comment_id is The identity of comment.
	CommentID int `json:"comment_id,omitempty"`
	// comment is The content of the comment.
	Comment string `json:"comment,omitempty"`
}

======================================================= Object Raw Type - CommentList =======================================================

type ComplaintPolicy added in v1.5.0

type ComplaintPolicy struct {
	// warranty_time is Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.
	WarrantyTime string `json:"warranty_time,omitempty"`
	// exclude_entrepreneur_warranty is Whether to exclude warranty complaints for entrepreneurs.If True means "I exclude warranty complaints for entrepreneur"
	ExcludeEntrepreneurWarranty bool `json:"exclude_entrepreneur_warranty,omitempty"`
	// complaint_address_id is  Address for complaint. Fetch available addresses using v2.logistics.get_address_list, and use address_id  returned from it.
	ComplaintAddressID int `json:"complaint_address_id,omitempty"`
	// additional_information is Additional information for warranty claim. Should be less than 1000 characters.
	AdditionalInformation string `json:"additional_information,omitempty"`
}

======================================================= Object Raw Type - ComplaintPolicy =======================================================

type DescriptionInfo added in v1.5.0

type DescriptionInfo struct {
	// extended_description is If description_type is extended , Description information should be set by this field.
	ExtendedDescription DescriptionInfoExtendedDescription `json:"extended_description,omitempty"`
}

======================================================= Object Raw Type - DescriptionInfo =======================================================

type DescriptionInfoExtendedDescription added in v1.5.4

type DescriptionInfoExtendedDescription struct {
	// field_list is Field of extended description.
	FieldList []DescriptionInfoExtendedDescriptionField `json:"field_list,omitempty"`
}

======================================================= Object Raw Type - DescriptionInfoExtendedDescription =======================================================

type DescriptionInfoExtendedDescriptionField added in v1.5.5

type DescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field: values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be set by this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image, image url will be set by this field.
	ImageInfo DescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info,omitempty"`
}

======================================================= Object Raw Type - DescriptionInfoExtendedDescriptionField =======================================================

type DescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type DescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - DescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type Dimension added in v1.5.0

type Dimension struct {
	// package_height is <p>Package height, unit is cm</p>
	PackageHeight int `json:"package_height,omitempty"`
	// package_length is <p>Package height, unit is cm</p>
	PackageLength int `json:"package_length,omitempty"`
	// package_width is <p>Package height, unit is cm</p>
	PackageWidth int `json:"package_width,omitempty"`
}

======================================================= Object Raw Type - Dimension =======================================================

type DiscountAddDiscount added in v1.5.1

type DiscountAddDiscount struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
}

======================================================= Object Raw Type - DiscountAddDiscount =======================================================

type DiscountAddDiscountItem added in v1.5.1

type DiscountAddDiscountItem struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// count is The number of items that add successfully.
	Count int `json:"count,omitempty"`
	// error_list is Indicate error details.
	ErrorList []DiscountAddDiscountItemError `json:"error_list"`
}

======================================================= Object Raw Type - DiscountAddDiscountItem =======================================================

type DiscountAddDiscountItemError added in v1.5.5

type DiscountAddDiscountItemError struct {
	// item_id is  Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0.
	ModelID int `json:"model_id,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
}

======================================================= Object Raw Type - DiscountAddDiscountItemError =======================================================

type DiscountAddDiscountItemRequest added in v1.5.0

type DiscountAddDiscountItemRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
	// item_list is The items added in this discount promotion.
	ItemList []ItemList `json:"item_list"`
}

======================================================= DiscountAddDiscountItemRequest =======================================================

type DiscountAddDiscountItemResponse added in v1.5.0

type DiscountAddDiscountItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountAddDiscountItem `json:"response"`
}

======================================================= DiscountAddDiscountItemResponse =======================================================

type DiscountAddDiscountRequest added in v1.5.0

type DiscountAddDiscountRequest struct {
	V2RequestAuthenticationParams

	// discount_name is Title of the discount.
	DiscountName string `json:"discount_name"`
	// start_time is The time when discount activity start.The start time must be 1 hour later than current time.
	StartTime int `json:"start_time"`
	// end_time is <p>The time when discount activity end.The end time must be 1 hour later than start time,and the discount period must be less than 180 days.</p>
	EndTime int `json:"end_time"`
}

======================================================= DiscountAddDiscountRequest =======================================================

type DiscountAddDiscountResponse added in v1.5.0

type DiscountAddDiscountResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response DiscountAddDiscount `json:"response"`
}

======================================================= DiscountAddDiscountResponse =======================================================

type DiscountDeleteDiscount added in v1.5.1

type DiscountDeleteDiscount struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// modify_time is The time when discount has been deleted.
	ModifyTime int `json:"modify_time,omitempty"`
}

======================================================= Object Raw Type - DiscountDeleteDiscount =======================================================

type DiscountDeleteDiscountItem added in v1.5.1

type DiscountDeleteDiscountItem struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// error_list is Detail informations about error.
	ErrorList []DiscountDeleteDiscountItemError `json:"error_list"`
}

======================================================= Object Raw Type - DiscountDeleteDiscountItem =======================================================

type DiscountDeleteDiscountItemError added in v1.5.5

type DiscountDeleteDiscountItemError struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// modle_id is Shopee's unique identifier for a variation of an item.
	ModleID int `json:"modle_id,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
}

======================================================= Object Raw Type - DiscountDeleteDiscountItemError =======================================================

type DiscountDeleteDiscountItemRequest added in v1.5.0

type DiscountDeleteDiscountItemRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id"`
	// model_id is Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0.
	ModelID int `json:"model_id,omitempty"`
}

======================================================= DiscountDeleteDiscountItemRequest =======================================================

type DiscountDeleteDiscountItemResponse added in v1.5.0

type DiscountDeleteDiscountItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountDeleteDiscountItem `json:"response,omitempty"`
}

======================================================= DiscountDeleteDiscountItemResponse =======================================================

type DiscountDeleteDiscountRequest added in v1.5.0

type DiscountDeleteDiscountRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
}

======================================================= DiscountDeleteDiscountRequest =======================================================

type DiscountDeleteDiscountResponse added in v1.5.0

type DiscountDeleteDiscountResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response DiscountDeleteDiscount `json:"response"`
}

======================================================= DiscountDeleteDiscountResponse =======================================================

type DiscountEndDiscount added in v1.5.1

type DiscountEndDiscount struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// modify_time is The time to track the modified time.
	ModifyTime int `json:"modify_time,omitempty"`
}

======================================================= Object Raw Type - DiscountEndDiscount =======================================================

type DiscountEndDiscountRequest added in v1.5.0

type DiscountEndDiscountRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
}

======================================================= DiscountEndDiscountRequest =======================================================

type DiscountEndDiscountResponse added in v1.5.0

type DiscountEndDiscountResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountEndDiscount `json:"response"`
}

======================================================= DiscountEndDiscountResponse =======================================================

type DiscountGetDiscount added in v1.5.1

type DiscountGetDiscount struct {
	// status is The status of discount promotion
	Status string `json:"status,omitempty"`
	// discount_name is Title of the discount.
	DiscountName string `json:"discount_name,omitempty"`
	// item_list is The items selected in this discount.
	ItemList []DiscountGetDiscountItem `json:"item_list"`
	// start_time is The time when discount activity start.
	StartTime int `json:"start_time,omitempty"`
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// end_time is The time when discount activity end.
	EndTime int `json:"end_time,omitempty"`
	// more is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - DiscountGetDiscount =======================================================

type DiscountGetDiscountItem added in v1.5.5

type DiscountGetDiscountItem struct {
	// item_promotion_price is The discount price of the item. If there is variation, this value is 0.
	ItemPromotionPrice float64 `json:"item_promotion_price,omitempty,string"`
	// item_name is Name of the item in local language.
	ItemName string `json:"item_name,omitempty"`
	// model_list is The models belong to this item.
	ModelList []DiscountGetDiscountItemModel `json:"model_list"`
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// purchase_limit is The max number of this product in the promotion price.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
	// item_original_price is The original price before discount of the item. If there is variation, this value is 0.
	ItemOriginalPrice float64 `json:"item_original_price,omitempty,string"`
	// normal_stock is The current stock quantity of the item.
	NormalStock int `json:"normal_stock,omitempty"`
	// item_inflated_price_of_original_price is The original price after tax of model (Only for taxable Shop).
	ItemInflatedPriceOfOriginalPrice float64 `json:"item_inflated_price_of_original_price,omitempty,string"`
	// item_inflated_price_of_promotion_price is The discount price after tax of model (Only for taxable Shop).
	ItemInflatedPriceOfPromotionPrice float64 `json:"item_inflated_price_of_promotion_price,omitempty,string"`
	// item_promotion_stock is The reserved stock of the item. If the item has no variation, this param is necessary.
	ItemPromotionStock int `json:"item_promotion_stock,omitempty"`
}

======================================================= Object Raw Type - DiscountGetDiscountItem =======================================================

type DiscountGetDiscountItemModel added in v1.5.5

type DiscountGetDiscountItemModel struct {
	// model_name is Name of the variation that belongs to the same item.
	ModelName string `json:"model_name,omitempty"`
	// model_normal_stock is The current stock quantity of the variation.
	ModelNormalStock int `json:"model_normal_stock,omitempty"`
	// model_original_price is The original price before discount of the variation.
	ModelOriginalPrice float64 `json:"model_original_price,omitempty,string"`
	// model_promotion_price is The discount price of the variation.
	ModelPromotionPrice float64 `json:"model_promotion_price,omitempty,string"`
	// model_id is Shopee's unique identifier for a variation of an item.
	ModelID int `json:"model_id,omitempty"`
	// model_inflated_price_of_original_price is The original price after tax of item (Only for taxable Shop).
	ModelInflatedPriceOfOriginalPrice float64 `json:"model_inflated_price_of_original_price,omitempty,string"`
	// model_inflated_price_of_promotion_price is The discount price after tax of item (Only for taxable Shop).
	ModelInflatedPriceOfPromotionPrice float64 `json:"model_inflated_price_of_promotion_price,omitempty,string"`
	// model_promotion_stock is The reserved stock of the model.
	ModelPromotionStock int `json:"model_promotion_stock,omitempty"`
}

======================================================= Object Raw Type - DiscountGetDiscountItemModel =======================================================

type DiscountGetDiscountList added in v1.5.1

type DiscountGetDiscountList struct {
	// discount_list is The discounts created in this shop.
	DiscountList []DiscountGetDiscountListDiscount `json:"discount_list"`
	// more is <p>This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.<br /></p>
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - DiscountGetDiscountList =======================================================

type DiscountGetDiscountListDiscount added in v1.5.5

type DiscountGetDiscountListDiscount struct {
	// status is The status of discount.
	Status string `json:"status,omitempty"`
	// discount_name is Title of the discount.
	DiscountName string `json:"discount_name,omitempty"`
	// start_time is The time when discount activity start.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The time when discount activity end.
	EndTime int `json:"end_time,omitempty"`
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// source is Source of the discount. 7: live stream, 1: admin, 0: others
	Source int `json:"source,omitempty"`
}

======================================================= Object Raw Type - DiscountGetDiscountListDiscount =======================================================

type DiscountGetDiscountListRequest added in v1.5.0

type DiscountGetDiscountListRequest struct {
	V2RequestAuthenticationParams

	// discount_status is The status filter for retriveing discount list. Available value: upcoming/ongoing/expired/all.
	DiscountStatus string `json:"discount_status"`
	// page_no is Specifies the starting entry of data to return in the current call. if data is more than one page, the offset can be some entry to start next call.
	PageNo int `json:"page_no"`
	// page_size is If many items are available to retrieve, you may need to call GetDiscountsList multiple times to retrieve all the data. Each result set is returned as a page of entries. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.
	PageSize int `json:"page_size"`
	// update_time_from is The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.
	UpdateTimeFrom int `json:"update_time_from,omitempty"`
	// update_time_to is The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the discount update time). The maximum date range that may be specified with the update_time_from and update_time_to fields is 30 days.
	UpdateTimeTo int `json:"update_time_to,omitempty"`
}

======================================================= DiscountGetDiscountListRequest =======================================================

type DiscountGetDiscountListResponse added in v1.5.0

type DiscountGetDiscountListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountGetDiscountList `json:"response,omitempty"`
}

======================================================= DiscountGetDiscountListResponse =======================================================

type DiscountGetDiscountRequest added in v1.5.0

type DiscountGetDiscountRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
	// page_no is Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
	PageNo int `json:"page_no"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.
	PageSize int `json:"page_size"`
}

======================================================= DiscountGetDiscountRequest =======================================================

type DiscountGetDiscountResponse added in v1.5.0

type DiscountGetDiscountResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountGetDiscount `json:"response"`
}

======================================================= DiscountGetDiscountResponse =======================================================

type DiscountUpdateDiscount added in v1.5.1

type DiscountUpdateDiscount struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// modify_time is The time when discount is updated.
	ModifyTime int `json:"modify_time,omitempty"`
}

======================================================= Object Raw Type - DiscountUpdateDiscount =======================================================

type DiscountUpdateDiscountItem added in v1.5.1

type DiscountUpdateDiscountItem struct {
	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id,omitempty"`
	// count is The number of items that modify successfully.
	Count int `json:"count,omitempty"`
	// error_list is Error list of this discount.
	ErrorList []DiscountUpdateDiscountItemError `json:"error_list"`
}

======================================================= Object Raw Type - DiscountUpdateDiscountItem =======================================================

type DiscountUpdateDiscountItemError added in v1.5.5

type DiscountUpdateDiscountItemError struct {
	// item_id is The items which have something error.
	ItemID int `json:"item_id,omitempty"`
	// model_id is The models which have something error.
	ModelID int `json:"model_id,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
}

======================================================= Object Raw Type - DiscountUpdateDiscountItemError =======================================================

type DiscountUpdateDiscountItemRequest added in v1.5.0

type DiscountUpdateDiscountItemRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
	// item_list is The items selected to this discount. You can update at most 50 items per call.
	ItemList []ItemList `json:"item_list"`
}

======================================================= DiscountUpdateDiscountItemRequest =======================================================

type DiscountUpdateDiscountItemResponse added in v1.5.0

type DiscountUpdateDiscountItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountUpdateDiscountItem `json:"response"`
}

======================================================= DiscountUpdateDiscountItemResponse =======================================================

type DiscountUpdateDiscountRequest added in v1.5.0

type DiscountUpdateDiscountRequest struct {
	V2RequestAuthenticationParams

	// discount_id is Shopee's unique identifier for a discount activity.
	DiscountID int `json:"discount_id"`
	// discount_name is Title of the discount.
	DiscountName string `json:"discount_name,omitempty"`
	// end_time is The time when discount activity end. The end time must be 1 hour later than start time.
	EndTime int `json:"end_time,omitempty"`
	// start_time is The time when discount activity start. The new start time must later than original start time.
	StartTime int `json:"start_time,omitempty"`
}

======================================================= DiscountUpdateDiscountRequest =======================================================

type DiscountUpdateDiscountResponse added in v1.5.0

type DiscountUpdateDiscountResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response DiscountUpdateDiscount `json:"response,omitempty"`
}

======================================================= DiscountUpdateDiscountResponse =======================================================

type Dropoff added in v1.5.0

type Dropoff struct {
	// branch_id is The identity of branch.
	BranchID int `json:"branch_id,omitempty"`
	// sender_real_name is The real name of sender.
	SenderRealName string `json:"sender_real_name,omitempty"`
	// tracking_number is Need input this field when "tracking_number" is returned from "info_need". Please note that this tracking number is assigned by third-party shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// slug is  The selected 3PL partner to drop-off parcels with.
	Slug string `json:"slug,omitempty"`
}

======================================================= Object Raw Type - Dropoff =======================================================

type FirstMileBindFirstMileTrackingNumber added in v1.5.1

type FirstMileBindFirstMileTrackingNumber struct {
	// first_mile_tracking_number is The first mile tracking number
	FirstMileTrackingNumber string `json:"first_mile_tracking_number,omitempty"`
	// order_list is The list of orders.
	OrderList []FirstMileBindFirstMileTrackingNumberOrder `json:"order_list"`
}

======================================================= Object Raw Type - FirstMileBindFirstMileTrackingNumber =======================================================

type FirstMileBindFirstMileTrackingNumberOrder added in v1.5.5

type FirstMileBindFirstMileTrackingNumberOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - FirstMileBindFirstMileTrackingNumberOrder =======================================================

type FirstMileBindFirstMileTrackingNumberRequest added in v1.5.0

type FirstMileBindFirstMileTrackingNumberRequest struct {
	V2RequestAuthenticationParams

	// first_mile_tracking_number is The first-mile tracking number.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number"`
	// shipment_method is <p>The shipment method for bound orders, should be pickup, dropoff or self-deliver.</p>
	ShipmentMethod string `json:"shipment_method"`
	// region is Use this field to specify the region you want to ship parcel.
	Region string `json:"region"`
	// logistics_channel_id is The identity of first-mile logistic channel
	LogisticsChannelID int `json:"logistics_channel_id"`
	// volume is The volume of the parcel.
	Volume float64 `json:"volume,omitempty,string"`
	// weight is The weight of the parcel.
	Weight float64 `json:"weight,omitempty,string"`
	// width is The width of the parcel.
	Width float64 `json:"width,omitempty,string"`
	// length is The length of the parcel.
	Length float64 `json:"length,omitempty,string"`
	// height is The height of the parcel.
	Height float64 `json:"height,omitempty,string"`
	// order_list is The set of ordersn. You can specify up to 50 ordersns in this call.one fm_tn maximum number of total bind orders is 10000.
	OrderList []OrderList `json:"order_list"`
}

======================================================= FirstMileBindFirstMileTrackingNumberRequest =======================================================

type FirstMileBindFirstMileTrackingNumberResponse added in v1.5.0

type FirstMileBindFirstMileTrackingNumberResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileBindFirstMileTrackingNumber `json:"response"`
}

======================================================= FirstMileBindFirstMileTrackingNumberResponse =======================================================

type FirstMileCodeBindOrderRequestOrder

type FirstMileCodeBindOrderRequestOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
}

type FirstMileCodeBindOrderResponseFail

type FirstMileCodeBindOrderResponseFail struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
	// The reason why the order/fulfillment order cannot be bound.
	Reason string `json:"reason,omitempty"`
}

type FirstMileGenerateFirstMileTrackingNumber added in v1.5.1

type FirstMileGenerateFirstMileTrackingNumber struct {
	// first_mile_tracking_number_list is The list of first mile tracking number that you generate
	FirstMileTrackingNumberList []string `json:"first_mile_tracking_number_list,omitempty"`
}

======================================================= Object Raw Type - FirstMileGenerateFirstMileTrackingNumber =======================================================

type FirstMileGenerateFirstMileTrackingNumberRequest added in v1.5.0

type FirstMileGenerateFirstMileTrackingNumberRequest struct {
	V2RequestAuthenticationParams

	// declare_date is This field is used for seller to specify the declare time.
	DeclareDate string `json:"declare_date"`
	// quantity is The number of first-mile tracking numbers generated. Up to 20 first-mile tracking numbers can be generated for one declaration day.
	Quantity int `json:"quantity,omitempty"`
	// seller_info is This object contains detailed breakdown for the seller address.
	SellerInfo SellerInfo `json:"seller_info"`
}

======================================================= FirstMileGenerateFirstMileTrackingNumberRequest =======================================================

type FirstMileGenerateFirstMileTrackingNumberResponse added in v1.5.0

type FirstMileGenerateFirstMileTrackingNumberResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileGenerateFirstMileTrackingNumber `json:"response"`
}

======================================================= FirstMileGenerateFirstMileTrackingNumberResponse =======================================================

type FirstMileGetChannelList added in v1.5.1

type FirstMileGetChannelList struct {
	// logistics_channel_list is
	LogisticsChannelList []FirstMileGetChannelListLogisticsChannel `json:"logistics_channel_list"`
}

======================================================= Object Raw Type - FirstMileGetChannelList =======================================================

type FirstMileGetChannelListLogisticsChannel added in v1.5.5

type FirstMileGetChannelListLogisticsChannel struct {
	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id,omitempty"`
	// logistics_channel_name is The name of logistic channel.
	LogisticsChannelName string `json:"logistics_channel_name,omitempty"`
	// shipment_method is <p>The shipment method for bound orders.Available values: pickup, dropoff, self_deliver.</p>
	ShipmentMethod string `json:"shipment_method,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetChannelListLogisticsChannel =======================================================

type FirstMileGetChannelListRequest added in v1.5.0

type FirstMileGetChannelListRequest struct {
	V2RequestAuthenticationParams

	// region is Use this field to specify the region you want to ship parcel. Available value: CN
	Region string `json:"region"`
}

======================================================= FirstMileGetChannelListRequest =======================================================

type FirstMileGetChannelListResponse added in v1.5.0

type FirstMileGetChannelListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileGetChannelList `json:"response"`
}

======================================================= FirstMileGetChannelListResponse =======================================================

type FirstMileGetDetail added in v1.5.1

type FirstMileGetDetail struct {
	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id,omitempty"`
	// first_mile_tracking_number is The first-mile tracking number.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number,omitempty"`
	// shipment_method is The shipment method for bound orders, should be pickup or dropoff.
	ShipmentMethod string `json:"shipment_method,omitempty"`
	// status is The logistics status for first-mile tracking number. Status could be: INIT,ORDER_CREATED,PICKED_UP,DELIVERED,ORDER_RECEIVED,CANCELING,CANCELED.
	Status string `json:"status,omitempty"`
	// declare_date is The specified delivery date.
	DeclareDate string `json:"declare_date,omitempty"`
	// more is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	More bool `json:"more,omitempty"`
	// order_list is The list of order.
	OrderList []FirstMileGetDetailOrder `json:"order_list"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetDetail =======================================================

type FirstMileGetDetailOrder added in v1.5.5

type FirstMileGetDetailOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// sls_tracking_number is The tracking number of SLS for orders/forders.
	SlsTrackingNumber string `json:"sls_tracking_number,omitempty"`
	// pick_up_done is Use this filed to indicate whether the order has been picked up by carrier.
	PickUpDone bool `json:"pick_up_done,omitempty"`
	// arrived_transit_warehouse is Use this filed to indicate whether the order has arrived at transit warehouse.
	ArrivedTransitWarehouse bool `json:"arrived_transit_warehouse,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetDetailOrder =======================================================

type FirstMileGetDetailRequest added in v1.5.0

type FirstMileGetDetailRequest struct {
	V2RequestAuthenticationParams

	// first_mile_tracking_number is The first mile tracking number.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number"`
	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
}

======================================================= FirstMileGetDetailRequest =======================================================

type FirstMileGetDetailResponse added in v1.5.0

type FirstMileGetDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileGetDetail `json:"response,omitempty"`
}

======================================================= FirstMileGetDetailResponse =======================================================

type FirstMileGetTrackingNumberList added in v1.5.1

type FirstMileGetTrackingNumberList struct {
	// more is This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders.
	More bool `json:"more,omitempty"`
	// first_mile_tracking_number_list is The first-mile tracking number.
	FirstMileTrackingNumberList []FirstMileGetTrackingNumberListFirstMileTrackingNumber `json:"first_mile_tracking_number_list"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetTrackingNumberList =======================================================

type FirstMileGetTrackingNumberListFirstMileTrackingNumber added in v1.5.5

type FirstMileGetTrackingNumberListFirstMileTrackingNumber struct {
	// first_mile_tracking_number is The specified delivery date.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number,omitempty"`
	// status is The logistics status for bound orders.
	Status string `json:"status,omitempty"`
	// declare_date is The first-mile tracking number.
	DeclareDate string `json:"declare_date,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetTrackingNumberListFirstMileTrackingNumber =======================================================

type FirstMileGetTrackingNumberListRequest added in v1.5.0

type FirstMileGetTrackingNumberListRequest struct {
	V2RequestAuthenticationParams

	// from_date is The start time of declare_date.
	FromDate string `json:"from_date"`
	// to_date is The end time of declare_date.
	ToDate string `json:"to_date"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. limit [1, 50]
	PageSize int `json:"page_size,omitempty"`
	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
}

======================================================= FirstMileGetTrackingNumberListRequest =======================================================

type FirstMileGetTrackingNumberListResponse added in v1.5.0

type FirstMileGetTrackingNumberListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileGetTrackingNumberList `json:"response,omitempty"`
}

======================================================= FirstMileGetTrackingNumberListResponse =======================================================

type FirstMileGetUnbindOrderList added in v1.5.1

type FirstMileGetUnbindOrderList struct {
	// more is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	More bool `json:"more,omitempty"`
	// order_list is The result list of order you querying.
	OrderList []FirstMileGetUnbindOrderListOrder `json:"order_list"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetUnbindOrderList =======================================================

type FirstMileGetUnbindOrderListOrder added in v1.5.5

type FirstMileGetUnbindOrderListOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// logistics_status is The Shopee logistics status for the order. Applicable values: See Data Definition- LogisticsStatus.
	LogisticsStatus string `json:"logistics_status,omitempty"`
}

======================================================= Object Raw Type - FirstMileGetUnbindOrderListOrder =======================================================

type FirstMileGetUnbindOrderListRequest added in v1.5.0

type FirstMileGetUnbindOrderListRequest struct {
	V2RequestAuthenticationParams

	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. limit [1, 100]
	PageSize int `json:"page_size,omitempty"`
	// response_optional_fields is Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them.  Available values: logistic_status,package_number.
	ResponseOptionalFields string `json:"response_optional_fields,omitempty"`
}

======================================================= FirstMileGetUnbindOrderListRequest =======================================================

type FirstMileGetUnbindOrderListResponse added in v1.5.0

type FirstMileGetUnbindOrderListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileGetUnbindOrderList `json:"response,omitempty"`
}

======================================================= FirstMileGetUnbindOrderListResponse =======================================================

type FirstMileGetWaybillRequest added in v1.5.0

type FirstMileGetWaybillRequest struct {
	V2RequestAuthenticationParams

	// first_mile_tracking_number_list is The first mile tracking number that you want to print waybill.limit [1, 50]
	FirstMileTrackingNumberList []string `json:"first_mile_tracking_number_list"`
}

======================================================= FirstMileGetWaybillRequest =======================================================

type FirstMileGetWaybillResponse added in v1.5.0

type FirstMileGetWaybillResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= FirstMileGetWaybillResponse =======================================================

type FirstMileUnbindFirstMileTrackingNumber added in v1.5.1

type FirstMileUnbindFirstMileTrackingNumber struct {
	// first_mile_tracking_number is The first mile tracking number.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number,omitempty"`
	// order_list is The binding result list of each order.
	OrderList []FirstMileUnbindFirstMileTrackingNumberOrder `json:"order_list"`
}

======================================================= Object Raw Type - FirstMileUnbindFirstMileTrackingNumber =======================================================

type FirstMileUnbindFirstMileTrackingNumberOrder added in v1.5.5

type FirstMileUnbindFirstMileTrackingNumberOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - FirstMileUnbindFirstMileTrackingNumberOrder =======================================================

type FirstMileUnbindFirstMileTrackingNumberRequest added in v1.5.0

type FirstMileUnbindFirstMileTrackingNumberRequest struct {
	V2RequestAuthenticationParams

	// first_mile_tracking_number is The identifier for an API request for error tracking.
	FirstMileTrackingNumber string `json:"first_mile_tracking_number"`
	// order_list is The list of order info you want to unbind from the given first mile tracking number.
	OrderList []OrderList `json:"order_list"`
}

======================================================= FirstMileUnbindFirstMileTrackingNumberRequest =======================================================

type FirstMileUnbindFirstMileTrackingNumberResponse added in v1.5.0

type FirstMileUnbindFirstMileTrackingNumberResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response FirstMileUnbindFirstMileTrackingNumber `json:"response"`
}

======================================================= FirstMileUnbindFirstMileTrackingNumberResponse =======================================================

type FirstMileUnbindRequestOrderList

type FirstMileUnbindRequestOrderList struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
}

type FirstMileUnbindResponseFailList

type FirstMileUnbindResponseFailList struct {
	// The reason why the order/fulfillment order cannot be unbound.
	Reason string `json:"reason,omitempty"`
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
}

type FollowPrizeAddFollowPrize added in v1.5.1

type FollowPrizeAddFollowPrize struct {
	// campagin_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaginID int `json:"campagin_id,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeAddFollowPrize =======================================================

type FollowPrizeAddFollowPrizeRequest added in v1.5.0

type FollowPrizeAddFollowPrizeRequest struct {
	V2RequestAuthenticationParams

	// follow_prize_name is <p>The name of the follow prize,The follow prize name length max limit is 20.<br /></p>
	FollowPrizeName string `json:"follow_prize_name"`
	// start_time is <p>The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	StartTime int `json:"start_time"`
	// end_time is <p>The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	EndTime int `json:"end_time"`
	// usage_quantity is <p>Please enter a value between 1 and 200000.</p>
	UsageQuantity int `json:"usage_quantity"`
	// min_spend is <p>The minimum spend required for using this follow prize.<br /></p>
	MinSpend float64 `json:"min_spend,string"`
	// reward_type is <p>The reward type of the follow prize.The available values are:1:discount---fix amount,2:discount---by percentage,3:coin cash back.<br /></p>
	RewardType int `json:"reward_type"`
	// discount_amount is <p>The discount amount set for this particular follow prize.Only fill in when you are creating a fix amount follow prize.<br /></p>
	DiscountAmount float64 `json:"discount_amount,omitempty,string"`
	// percentage is <p>The discount percentage set for this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.Discount percentage (reward_type ==2) or Percentage of coins cash back (reward_type==3).<br /></p>
	Percentage int `json:"percentage,omitempty"`
	// max_price is <p>The max amount of discount/value a user can enjoy by using this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.<br /></p>
	MaxPrice float64 `json:"max_price,omitempty,string"`
}

======================================================= FollowPrizeAddFollowPrizeRequest =======================================================

type FollowPrizeAddFollowPrizeResponse added in v1.5.0

type FollowPrizeAddFollowPrizeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeAddFollowPrize `json:"response,omitempty"`
}

======================================================= FollowPrizeAddFollowPrizeResponse =======================================================

type FollowPrizeDeleteFollowPrize added in v1.5.1

type FollowPrizeDeleteFollowPrize struct {
	// campagin_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaginID int `json:"campagin_id,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeDeleteFollowPrize =======================================================

type FollowPrizeDeleteFollowPrizeRequest added in v1.5.0

type FollowPrizeDeleteFollowPrizeRequest struct {
	V2RequestAuthenticationParams

	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id"`
}

======================================================= FollowPrizeDeleteFollowPrizeRequest =======================================================

type FollowPrizeDeleteFollowPrizeResponse added in v1.5.0

type FollowPrizeDeleteFollowPrizeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeDeleteFollowPrize `json:"response"`
}

======================================================= FollowPrizeDeleteFollowPrizeResponse =======================================================

type FollowPrizeEndFollowPrize added in v1.5.1

type FollowPrizeEndFollowPrize struct {
	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeEndFollowPrize =======================================================

type FollowPrizeEndFollowPrizeRequest added in v1.5.0

type FollowPrizeEndFollowPrizeRequest struct {
	V2RequestAuthenticationParams

	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id"`
}

======================================================= FollowPrizeEndFollowPrizeRequest =======================================================

type FollowPrizeEndFollowPrizeResponse added in v1.5.0

type FollowPrizeEndFollowPrizeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeEndFollowPrize `json:"response"`
}

======================================================= FollowPrizeEndFollowPrizeResponse =======================================================

type FollowPrizeGetFollowPrizeDetail added in v1.5.1

type FollowPrizeGetFollowPrizeDetail struct {
	// campaign_status is <p>The status of follow prize,the campagin status have upcoming/ongoing/expired.<br /></p>
	CampaignStatus string `json:"campaign_status,omitempty"`
	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id,omitempty"`
	// usage_quantity is <p>Please enter a value between 1 and 200000.<br /></p>
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// start_time is <p>The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	StartTime int `json:"start_time,omitempty"`
	// end_time is <p>The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	EndTime int `json:"end_time,omitempty"`
	// min_spend is <p>The minimum spend required for using this follow prize.<br /></p>
	MinSpend int `json:"min_spend,omitempty"`
	// reward_type is <p>The reward type of the follow prize.The available values are:1:discount---fix amount,2:discount---by percentage,3:coin cash back.<br /></p>
	RewardType int `json:"reward_type,omitempty"`
	// follow_prize_name is <p>The name of the follow prize,The follow prize name length max limit is 20.<br /></p>
	FollowPrizeName string `json:"follow_prize_name,omitempty"`
	// discount_amount is <p>The discount amount set for this particular follow prize.Only fill in when you are creating a fix amount follow prize.<br /></p>
	DiscountAmount int `json:"discount_amount,omitempty"`
	// percentage is <p>The discount percentage set for this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.Discount percentage (reward_type ==2) or Percentage of coins cash back (reward_type==3).<br /></p>
	Percentage int `json:"percentage,omitempty"`
	// max_price is <p>The max amount of discount/value a user can enjoy by using this particular follow prize. Only fill in when you are creating a discount percentage follow prize or coins cashback follow prize.<br /></p>
	MaxPrice int `json:"max_price,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeGetFollowPrizeDetail =======================================================

type FollowPrizeGetFollowPrizeDetailRequest added in v1.5.0

type FollowPrizeGetFollowPrizeDetailRequest struct {
	V2RequestAuthenticationParams

	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id,omitempty"`
}

======================================================= FollowPrizeGetFollowPrizeDetailRequest =======================================================

type FollowPrizeGetFollowPrizeDetailResponse added in v1.5.0

type FollowPrizeGetFollowPrizeDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeGetFollowPrizeDetail `json:"response,omitempty"`
}

======================================================= FollowPrizeGetFollowPrizeDetailResponse =======================================================

type FollowPrizeGetFollowPrizeList added in v1.5.1

type FollowPrizeGetFollowPrizeList struct {
	// more is <p>This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments.<br /></p>
	More bool `json:"more,omitempty"`
	// follow_prize_list is <p>The list of follow prize.<br /></p>
	FollowPrizeList FollowPrizeGetFollowPrizeListFollowPrize `json:"follow_prize_list"`
}

======================================================= Object Raw Type - FollowPrizeGetFollowPrizeList =======================================================

type FollowPrizeGetFollowPrizeListFollowPrize added in v1.5.5

type FollowPrizeGetFollowPrizeListFollowPrize struct {
	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id,omitempty"`
	// campaign_status is <p>The status of follow prize,the campagin status have upcoming/ongoing/expired.<br /></p>
	CampaignStatus string `json:"campaign_status,omitempty"`
	// follow_prize_name is <p>The name of the follow prize,The follow prize name length max limit is 20.<br /></p>
	FollowPrizeName string `json:"follow_prize_name,omitempty"`
	// start_time is <p>The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	StartTime int `json:"start_time,omitempty"`
	// end_time is <p>The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	EndTime int `json:"end_time,omitempty"`
	// usage_quantity is <p>Please enter a value between 1 and 200000.<br /></p>
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// claimed is <p>This is to indicate the quantity of voucher claimed.<br /></p>
	Claimed int `json:"claimed,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeGetFollowPrizeListFollowPrize =======================================================

type FollowPrizeGetFollowPrizeListRequest added in v1.5.0

type FollowPrizeGetFollowPrizeListRequest struct {
	V2RequestAuthenticationParams

	// page_no is <p>Specifies the page number of data to return in the current call. Default to be 1.<br /></p>
	PageNo int `json:"page_no,omitempty"`
	// page_size is <p>Use the 'page_size' filters to control the maximum number of entries to retrieve per page (i.e., per call). Default to be 20 and allowed input is from 1- 100.<br /></p>
	PageSize int `json:"page_size,omitempty"`
	// status is <p>The status filter for retrieving follow prize list. Available value: upcoming/ongoing/expired/all.<br /></p>
	Status string `json:"status"`
}

======================================================= FollowPrizeGetFollowPrizeListRequest =======================================================

type FollowPrizeGetFollowPrizeListResponse added in v1.5.0

type FollowPrizeGetFollowPrizeListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeGetFollowPrizeList `json:"response"`
}

======================================================= FollowPrizeGetFollowPrizeListResponse =======================================================

type FollowPrizeUpdateFollowPrize added in v1.5.1

type FollowPrizeUpdateFollowPrize struct {
	// campagin_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaginID int `json:"campagin_id,omitempty"`
}

======================================================= Object Raw Type - FollowPrizeUpdateFollowPrize =======================================================

type FollowPrizeUpdateFollowPrizeRequest added in v1.5.0

type FollowPrizeUpdateFollowPrizeRequest struct {
	V2RequestAuthenticationParams

	// follow_prize_name is <p>The name of the follow prize,The follow prize name length max limit is 20.<br /></p>
	FollowPrizeName string `json:"follow_prize_name,omitempty"`
	// campaign_id is <p>The unique identifier for the created follow prize.<br /></p>
	CampaignID int `json:"campaign_id"`
	// start_time is <p>The timing from when the follow prize is valid,the start time later than the current time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	StartTime int `json:"start_time,omitempty"`
	// end_time is <p>The timing until when the follow prize is still valid,the end time must be greater than the start time by at least 1 day and end time cannot exceed 3 months after start time.If the start time and end time passed in by the seller overlap with other upcoming/ongoing activities, it will prompt "Another Follow Prize voucher already exists during this time period, please set another period."<br /></p>
	EndTime int `json:"end_time,omitempty"`
	// usage_quantity is <p>Please enter a value between 1 and 200000.</p>
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// min_spend is <p>The minimum spend required for using this follow prize.<br /></p>
	MinSpend int `json:"min_spend,omitempty"`
}

======================================================= FollowPrizeUpdateFollowPrizeRequest =======================================================

type FollowPrizeUpdateFollowPrizeResponse added in v1.5.0

type FollowPrizeUpdateFollowPrizeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detailed informations you are querying.<br /></p>
	Response FollowPrizeUpdateFollowPrize `json:"response,omitempty"`
}

======================================================= FollowPrizeUpdateFollowPrizeResponse =======================================================

type GenerateFMTrackingNoRequestSellerInfo

type GenerateFMTrackingNoRequestSellerInfo struct {
	// The full address of the seller.
	Address string `json:"address,omitempty"`
	// Seller's name for the address.
	Name string `json:"name,omitempty"`
	// Seller's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// Seller's location.
	Area string `json:"area,omitempty"`
	// Seller's phone number.
	Phone string `json:"phone,omitempty"`
}

type GetAccessTokenRequest

type GetAccessTokenRequest struct {
	// The code in redirect url after shop authorization. Valid for one-time use, expires in 10 minutes.
	Code string `json:"code,omitempty"`
	// The shop_id of the shop that authorized the developer.
	ShopID int64 `json:"shop_id,omitempty"`
	// The credential retrieved in the APP console.
	PartnerID int64 `json:"partner_id,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type GetAccessTokenResponse

type GetAccessTokenResponse struct {
	// The identifier for an API request for error tracking.
	RequestID string `json:"request_id,omitempty"`
	// Error code. Empty when the api call succeeded.
	Error string `json:"error,omitempty"`
	// Use refresh_token to obtain new access_token. Valid for one-time use, expires in 30 days.
	RefreshToken string `json:"refresh_token,omitempty"`
	// Use access_token as a common request parameter for certian APIs. Valid for multiple use, expires in 4 hours.
	AccessToken string `json:"access_token,omitempty"`
	// Access_token expiration time, unit is second.
	ExpireIn int `json:"expire_in,omitempty"`
}

type GetAddressResponseAddress

type GetAddressResponseAddress struct {
	// The identity of address
	AddressID int64 `json:"address_id,omitempty"`
	// The country of specify address
	Country string `json:"country,omitempty"`
	// The state of specify address
	State string `json:"state,omitempty"`
	// The city of specify address
	City string `json:"city,omitempty"`
	// The address description of specify address
	Address string `json:"address,omitempty"`
	// The zipcode of specify address
	Zipcode string `json:"zipcode,omitempty"`
	// The district of specify address
	District string `json:"district,omitempty"`
	// The town of specify address
	Town string `json:"town,omitempty"`
	// The flag of shop address, applicable values: default_address, pickup_address, return_address
	AddressFlag []string `json:"address_flag,omitempty"`
}

type GetAirwayBillResponseBatchResult

type GetAirwayBillResponseBatchResult struct {
	// The number of orderSN to get airway bills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// The list contains urls of retrieving airway bill in PDF format. Each url contains the airway bills which is in the same logistics channel.
	AirwayBills []string `json:"airway_bills,omitempty"`
}

type GetAirwayBillResponseResult

type GetAirwayBillResponseResult struct {
	// The number of ordersn to get airway bills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// This Object contains the airway bill to each order.
	AirwayBills []GetAirwayBillResponseResultAirwayBill `json:"airway_bills,omitempty"`
	// This list contains the ordersn and error descriptions of all orders that failed to retrieve airway bill in this call.
	Errors []GetAirwayBillResponseResultError `json:"errors,omitempty"`
}

type GetAirwayBillResponseResultAirwayBill

type GetAirwayBillResponseResultAirwayBill struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The url of retrieving airway bill.
	AirwayBill string `json:"airway_bill,omitempty"`
}

type GetAirwayBillResponseResultError

type GetAirwayBillResponseResultError struct {
	// The ordersn of orders which occurred error.
	OrderSN string `json:"ordersn,omitempty"`
	//
	ErrorCode string `json:"error_code,omitempty"`
	// The detail information of this error.
	ErrorDescription string `json:"error_description,omitempty"`
}

type GetAttributesResponseAttribute

type GetAttributesResponseAttribute struct {
	// The Identify of each category.
	AttributeID int64 `json:"attribute_id,omitempty"`
	// The name of each attribute.
	AttributeName string `json:"attribute_name,omitempty"`
	// This is to indicate whether this attribute is mandantory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// Enumerated type that defines the type of the attribute. Applicable values: See Data Definition- AttributeType.
	AttribuiteType string `json:"attribuite_type,omitempty"`
	// Enumerated type that defines the input type of the attribute. Applicable values: See Data Definition- AttributeInputType.
	InputType string `json:"input_type,omitempty"`
	// All options that attribute contains.
	Options []string `json:"options,omitempty"`
	// The option values in different language.
	Values []GetAttributesResponseAttributeValue `json:"values,omitempty"`
}

type GetAttributesResponseAttributeValue

type GetAttributesResponseAttributeValue struct {
	// Value in original language. It's MANDATORY to use attributes in original_value to add items.
	OriginalValue string `json:"original_value,omitempty"`
	// Value in translated language. As referrence only, CANNOT be used to add item. If the selected language is not supported in certain shop location, this field will be empty.
	TranslateValue string `json:"translate_value,omitempty"`
}

type GetBoostedItemResponseItem

type GetBoostedItemResponseItem struct {
	// boosted items' id.
	ItemID int64 `json:"item_id,omitempty"`
	// Cooldown_second time is four hours after boost. After four hours you can boost this item again.
	CooldownSecond int `json:"cooldown_second,omitempty"`
}

type GetBranchResponseBranch

type GetBranchResponseBranch struct {
	// The identity of branch.
	BranchID int64 `json:"branch_id,omitempty"`
	// The country of specify branch.
	Country string `json:"country,omitempty"`
	// The state of specify branch.
	State string `json:"state,omitempty"`
	// The city of specify branch.
	City string `json:"city,omitempty"`
	// The address description of specify branch.
	Address string `json:"address,omitempty"`
	// The zipcode of specify branch.
	Zipcode string `json:"zipcode,omitempty"`
	// The district of specify branch.
	District string `json:"district,omitempty"`
	// The town of specify branch.
	Town string `json:"town,omitempty"`
}

type GetCategoriesByCountryResponseCategory

type GetCategoriesByCountryResponseCategory struct {
	// The Identify of the parent of the category
	ParentID int64 `json:"parent_id,omitempty"`
	// This is to indicate whether the category has children.
	HasChildren bool `json:"has_children,omitempty"`
	// The Identify of each category
	CategoryID int64 `json:"category_id,omitempty"`
	// The name of each category
	CategoryName string `json:"category_name,omitempty"`
	// To indicate if this category supports size chart
	IsSuppSizechart bool `json:"is_supp_sizechart,omitempty"`
}

type GetCategoriesResponseCategory

type GetCategoriesResponseCategory struct {
	// The Identify of each category.
	CategoryID int64 `json:"category_id,omitempty"`
	// The Identify of the parent of the category.
	ParentID int64 `json:"parent_id,omitempty"`
	// The name of each category.
	CategoryName string `json:"category_name,omitempty"`
	// This is to indicate whether the category has children. Attributes can ONLY be fetched for the category_id WITHOUT children.
	HasChildren bool `json:"has_children,omitempty"`
	// The limits of pre-order items' days_to_ship based on per category.
	DaysToShipLimits GetCategoriesResponseCategoryDaysToShipLimits `json:"days_to_ship_limits,omitempty"`
}

type GetCategoriesResponseCategoryDaysToShipLimits

type GetCategoriesResponseCategoryDaysToShipLimits struct {
	// The maximum of dts,-1 means no dts.
	MaxLimit int `json:"max_limit,omitempty"`
	// The minimum of dts, -1 means no dts.
	MinLimit int `json:"min_limit,omitempty"`
}

type GetCommentResponseItemCMTList

type GetCommentResponseItemCMTList struct {
	// The identity of comment.
	CMTID int64 `json:"cmt_id,omitempty"`
	// Content of the comment.
	Comment string `json:"comment,omitempty"`
	// Username of the buyer who posted the comment.
	BuyerUsername string `json:"buyer_username,omitempty"`
	// Commented ordersn
	OrderSN string `json:"ordersn,omitempty"`
	// Commented item's id
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// The create time of the comment
	CreateTime int `json:"create_time,omitempty"`
	// The status of comment, available values: DELETE/NORMAL/VALID/HIDDEN
	Status string `json:"status,omitempty"`
	// Buyer's rating for the item
	RatingStar int `json:"rating_star,omitempty"`
	// The edit status of comment, available values: EXPIRED/EDITABLE/HAVE_EDIT_ONCE
	Editable string `json:"editable,omitempty"`
	// The status of comment, available values: DELETE/NORMAL/VALID/HIDDEN
	CMTReply GetCommentResponseItemCMTListCMTReply `json:"cmt_reply,omitempty"`
}

type GetCommentResponseItemCMTListCMTReply

type GetCommentResponseItemCMTListCMTReply struct {
	// The content of reply
	Reply string `json:"reply,omitempty"`
	// The status of comment, available values: DELETE/NORMAL/VALID/HIDDEN
	Status string `json:"status,omitempty"`
}

type GetDiscountDetailResponseItem

type GetDiscountDetailResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Name of the item in local language.
	ItemName string `json:"item_name,omitempty"`
	// The max number of this product in the promotion price.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
	// The original price before discount of the item. If there is variation, this value is 0.
	ItemOriginalPrice float64 `json:"item_original_price,omitempty,string"`
	// The discount price of the item. If there is variation, this value is 0.
	ItemPromotionPrice float64 `json:"item_promotion_price,omitempty,string"`
	// The current stock quantity of the item.
	Stock int `json:"stock,omitempty"`
	//
	Variations []GetDiscountDetailResponseItemVariation `json:"variations,omitempty"`
}

type GetDiscountDetailResponseItemVariation

type GetDiscountDetailResponseItemVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of the variation that belongs to the same item.
	VariationName string `json:"variation_name,omitempty"`
	// The original price before discount of the variation.
	VariationOriginalPrice float64 `json:"variation_original_price,omitempty,string"`
	// The discount price of the variation.
	VariationPromotionPrice float64 `json:"variation_promotion_price,omitempty,string"`
	// The current stock quantity of the variation.
	VariationStock int `json:"variation_stock,omitempty"`
}

type GetDiscountsListResponseDiscount

type GetDiscountsListResponseDiscount struct {
	// Shopee's unique identifier for a discount activity.
	DiscountID int64 `json:"discount_id,omitempty"`
	// Title of the discount.
	DiscountName string `json:"discount_name,omitempty"`
	// The time when discount activity start.
	StartTime int `json:"start_time,omitempty"`
	// The time when discount activity end.
	EndTime int `json:"end_time,omitempty"`
	// The status of discount, applicable values: expired, ongoing, upcoming.
	Status string `json:"status,omitempty"`
}

type GetEscrowDetailsResponseOrder

type GetEscrowDetailsResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The two-digit code representing the country where the order was made.
	Country string `json:"country,omitempty"`
	// This object contains detailed income breakdown for the order.
	IncomeDetails GetEscrowDetailsResponseOrderIncomeDetail `json:"income_details,omitempty"`
	// The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// The three-digit code representing the currency unit of total order amount (escorw_amount) at the point of payment to the seller.
	EscrowCurrency string `json:"escrow_currency,omitempty"`
	// The exchange rate used by Shopee to convert local_currency to escrow_currency.
	ExchangeRate string `json:"exchange_rate,omitempty"`
	// The payment channel that the seller selected to receive escrow for the order.
	EscrowChannel string `json:"escrow_channel,omitempty"`
	// The unique identifier for a payee by the 3rd party payment service provider selected in escrow_channel.
	PayeeID string `json:"payee_id,omitempty"`
	// This object contains detailed breakdown for bank account of the seller if selected escorw_channel is Bank Transfer.
	BankAccount GetEscrowDetailsResponseOrderBankAccount `json:"bank_account,omitempty"`
	// This object contains the detailed breakdown for all the items in this order, including regular items(non-activity) and activity items.
	Items []GetEscrowDetailsResponseOrderItem `json:"items,omitempty"`
	// This object contains the activity in this order.
	Activity []GetEscrowDetailsResponseOrderActivity `json:"activity,omitempty"`
}

type GetEscrowDetailsResponseOrderActivity

type GetEscrowDetailsResponseOrderActivity struct {
	// ID of activity.
	ActivityID int64 `json:"activity_id,omitempty"`
	// Type of activity. Currently only one type: bundle_deal
	ActivityType string `json:"activity_type,omitempty"`
	// The original TOTAL price of ALL items in one activity(e.g. bundle deal. Define by activity_id) in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The after-discocunt TOTAL price of ALL items in one activity(e.g. bundle deal. Define by activity_id) in the listing currency.
	DiscountedPrice float64 `json:"discounted_price,omitempty,string"`
	// This object contains the items in this activity.
	Items []GetEscrowDetailsResponseOrderActivityItem `json:"items,omitempty"`
}

type GetEscrowDetailsResponseOrderActivityItem

type GetEscrowDetailsResponseOrderActivityItem struct {
	// ID of item.
	ItemID int64 `json:"item_id,omitempty"`
	// ID of the variation that belongs to the same item.
	VariationID int64 `json:"variation_id,omitempty"`
	// The number of identical items purchased at the same time by the same buyer from one listing/item.
	QuantityPurchased int `json:"quantity_purchased,omitempty"`
	// The price used to participate activity. E.g. itemA original price is $10, promo price is $9, and bundle deal is buy 2 get 20% off equals to $14.4. The original_price value will be $9 in this case.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

type GetEscrowDetailsResponseOrderBankAccount

type GetEscrowDetailsResponseOrderBankAccount struct {
	// Name of the seller's receiving bank
	BankName string `json:"bank_name,omitempty"`
	// Account number of the seller's receiving bank
	BankAccountNumber string `json:"bank_account_number,omitempty"`
	// The two-digit code representing country of the seller's receiving bank account
	BankAccountCountry string `json:"bank_account_country,omitempty"`
}

type GetEscrowDetailsResponseOrderIncomeDetail

type GetEscrowDetailsResponseOrderIncomeDetail struct {
	// The three-digit code representing the currency unit used for all transactional amount under
	LocalCurrency string `json:"local_currency,omitempty"`
	// The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable.
	TotalAmount float64 `json:"total_amount,omitempty,string"`
	// Final value of coins used by seller for the order.
	Coin float64 `json:"coin,omitempty,string"`
	// Final value of voucher provided by Shopee for the order.
	Voucher float64 `json:"voucher,omitempty,string"`
	// Final value of voucher provided by Seller for the order.
	VoucherSeller float64 `json:"voucher_seller,omitempty,string"`
	// Final sum of each item Shopee discount of a specific order. This amount will rebate to seller.
	SellerRebate float64 `json:"seller_rebate,omitempty,string"`
	// The final shipping cost of order . For Non-integrated logistics channel is 0.
	ActualShippingCost float64 `json:"actual_shipping_cost,omitempty,string"`
	// The platform shipping subsidy to the seller
	ShippingFeeRebate float64 `json:"shipping_fee_rebate,omitempty,string"`
	// The commission fee charged by Shopee platform if applicable.
	CommissionFee float64 `json:"commission_fee,omitempty,string"`
	// The voucher code or promotion code the buyer used.
	VoucherCode float64 `json:"voucher_code,omitempty,string"`
	// The voucher name or promotion name the buyer used.
	VoucherName float64 `json:"voucher_name,omitempty,string"`
	// The total amount that the seller is expected to receive for the order and will change before order completed. escrow_amount=total_amount+voucher+credit_card_promotion+seller_rebate+coin-commission_fee-credit_card_transaction_fee-cross_border_tax-service_fee-buyer_shopee_kredit-seller_coin_cash_back+final_shipping_fee-seller_return_refund_amount.
	EscrowAmount float64 `json:"escrow_amount,omitempty,string"`
	// Amount incurred by Buyer for purchasing items outside of home country. Amount may change after Return Refund.
	CroossBorderTax float64 `json:"crooss_border_tax,omitempty,string"`
	// Include buyer transaction fee and seller transaction fee.
	CreditCardTransactionFee float64 `json:"credit_card_transaction_fee,omitempty,string"`
	// Amount charged by Shopee to seller for additional services.
	ServiceFee float64 `json:"service_fee,omitempty,string"`
	// Amount charged by Shopee to Buyer for using ShopeeKredit for the order. Currently only applicable in ID.
	BuyerShopeeKredit float64 `json:"buyer_shopee_kredit,omitempty,string"`
	// Value of coins provided by Seller for purchasing with his or her store for the order.
	SellerCoinCashBack float64 `json:"seller_coin_cash_back,omitempty,string"`
	// Final adjusted amount that seller has to bear as part of escrow. This amount could be negative or positive.
	FinalShippingFee float64 `json:"final_shipping_fee,omitempty,string"`
	// Amount returned to Seller in the event of partial return.
	SellerReturnRefundAmount float64 `json:"seller_return_refund_amount,omitempty,string"`
	// The amount offset via payment promotion. May include bank payment promotion and Shopee payment promotion.
	CreditCardPromotion float64 `json:"credit_card_promotion,omitempty,string"`
	// True means incoming won't change any more.
	IsCompleted bool `json:"is_completed,omitempty"`
	// Use this field to fetch the list of voucher codes.
	VoucherCodeList []string `json:"voucher_code_list,omitempty"`
	// The transaction_fee of seller.
	SellerTransactionFee float64 `json:"seller_transaction_fee,omitempty,string"`
	// The transaction_fee of buyer.
	BuyerTransactionFee float64 `json:"buyer_transaction_fee,omitempty,string"`
}

type GetEscrowDetailsResponseOrderItem

type GetEscrowDetailsResponseOrderItem struct {
	// ID of item
	ItemID int64 `json:"item_id,omitempty"`
	// Name of item
	ItemName string `json:"item_name,omitempty"`
	// A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// ID of the variation that belongs to the same item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	VariationName string `json:"variation_name,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// This value indicates the number of identical items purchased at the same time by the same buyer from one listing/item.
	QuantityPurchased int `json:"quantity_purchased,omitempty"`
	// The original price of the item before ANY promotion/discount in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The after-discount price of the item in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1. If there is no discount, this value will be the same as that of original_price.
	// In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/variation level. Due to technical restriction, the value will return the price before bundle deal if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the bundle deal discount breakdown on item level.
	DiscountedPrice float64 `json:"discounted_price,omitempty,string"`
	// The offset of this item when the buyer consumed Shopee Coins upon checkout.
	// In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the breakdown on item level.
	DiscountFromCoin float64 `json:"discount_from_coin,omitempty,string"`
	// The offset of this item when the buyer use Shopee voucher.
	// In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the breakdown on item level.
	DiscountFromVoucher float64 `json:"discount_from_voucher,omitempty,string"`
	// The offset of this item when the buyer use seller-specific voucher.
	// In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the breakdown on item level.
	DiscountFromVoucherSeller float64 `json:"discount_from_voucher_seller,omitempty,string"`
	// Platform subsidy to the seller for this item.
	// In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the breakdown on item level.
	SellerRebate float64 `json:"seller_rebate,omitempty,string"`
	// This value indicates the actual price the buyer pay.
	// In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/variation level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please use the value under "income_details" and "activity" to calculate the bundle deal discount breakdown on item level.
	DealPrice float64 `json:"deal_price,omitempty,string"`
	// This value indicate the offset via credit card promotion.
	// In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0. Please use the value under "income_details" and "activity" to calculate the breakdown on item level.
	CreditCardPromotion float64 `json:"credit_card_promotion,omitempty,string"`
	// To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// The unique identity of an addon deal.
	AddOnDealID int64 `json:"add_on_deal_id,omitempty"`
}

type GetEscrowReleasedOrdersResponseOrder

type GetEscrowReleasedOrdersResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// Order's escrow amount.
	PayoutAmount float64 `json:"payout_amount,omitempty,string"`
	// Timestamp of escrow amount transaction finished.
	EscrowReleaseTime int `json:"escrow_release_time,omitempty"`
}

type GetFMTrackingNoWaybillResponseBatchResult

type GetFMTrackingNoWaybillResponseBatchResult struct {
	// The list contains urls of retrieving waybill in PDF format. Each url contains the airway bills which is in the same logistics channel.
	Waybills []string `json:"waybills,omitempty"`
	// The number of Tracking Number to get waybills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// This list contains the first-mile tracking number and error descriptions of all tracking numbers that failed to retrieve airway bill in this call.
	Errors []GetFMTrackingNoWaybillResponseError `json:"errors,omitempty"`
}

type GetFMTrackingNoWaybillResponseError

type GetFMTrackingNoWaybillResponseError struct {
	//
	ErrorCode string `json:"error_code,omitempty"`
	// The detail information of this error.
	ErrorDescription string `json:"error_description,omitempty"`
	// The first-mile tracking number.
	FMTN string `json:"fm_tn,omitempty"`
}

type GetFMTrackingNoWaybillResponseResult

type GetFMTrackingNoWaybillResponseResult struct {
	// This Object contains the waybill to each tracking number.
	Waybills []GetFMTrackingNoWaybillResponseResultWaybill `json:"waybills,omitempty"`
	// The number of Tracking Number to get waybills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// This list contains the first-mile tracking number and error descriptions of all tracking numbers that failed to retrieve airway bill in this call.
	Errors []GetFMTrackingNoWaybillResponseError `json:"errors,omitempty"`
}

type GetFMTrackingNoWaybillResponseResultWaybill

type GetFMTrackingNoWaybillResponseResultWaybill struct {
	// The first-mile tracking number.
	FMTN string `json:"fm_tn,omitempty"`
	// The url of retrieving waybill.
	Waybill string `json:"waybill,omitempty"`
}

type GetFmTnDetailResponseOrder

type GetFmTnDetailResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
	// The tracking number of SLS for orders/forders.
	SLSTN string `json:"slstn,omitempty"`
	// Use this filed to indicate whether the order has been picked up by carrier.
	IsPickUpDone bool `json:"is_pick_up_done,omitempty"`
	// Use this filed to indicate whether the order has arrived at transit warehouse.
	IsArrivedTWS bool `json:"is_arrived_tws,omitempty"`
}

type GetForderInfoResponseForder

type GetForderInfoResponseForder struct {
	// The unique identifier for a fulfill order.
	ForderID string `json:"forder_id,omitempty"`
	// The fulfill order logistics status. Applicable values: See Data Definition - LogisticsStatus.
	Status string `json:"status,omitempty"`
	// Logistics tracking info.
	TrackingLog []GetForderInfoResponseForderLog `json:"tracking_log,omitempty"`
	// The items included in this fulfill order.
	Items []GetForderInfoResponseForderItem `json:"items,omitempty"`
	//
	LogisticsInfo []GetForderInfoResponseForderLogisticsInfo `json:"logistics_info,omitempty"`
	// The first-mile tracking number.
	FMTN string `json:"fm_tn,omitempty"`
	// The last-mile tracking number. Only for Cross Board BR seller.
	LMTN string `json:"lm_tn,omitempty"`
}

type GetForderInfoResponseForderItem

type GetForderInfoResponseForderItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// The number of identical items/variations purchased at the same time by the same buyer from one listing/item.
	Num int `json:"num,omitempty"`
	// The original price of the item in the listing currency.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// The original price of the variation in the listing currency.
	VariationPrice float64 `json:"variation_price,omitempty,string"`
}

type GetForderInfoResponseForderLog

type GetForderInfoResponseForderLog struct {
	// The time when logistics info has been updated.
	Ctime int `json:"ctime,omitempty"`
	// The order logistics tracking info.
	Description string `json:"description,omitempty"`
}

type GetForderInfoResponseForderLogisticsInfo

type GetForderInfoResponseForderLogisticsInfo struct {
	// The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// Only work for cross-border order. This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
	GoodsToDeclare bool `json:"goods_to_declare,omitempty"`
	// Only work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes.
	ServiceCode string `json:"service_code,omitempty"`
	// The tracking number of fullfill order assigned by the shipping carrier for item shipment.
	TrackingNo string `json:"tracking_no,omitempty"`
}

type GetForderWaybillRequestOrder

type GetForderWaybillRequestOrder struct {
	// The order serial numbers. Make sure the order has trackingNo generated before calling this API.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
}

type GetForderWaybillResponseBatchResult

type GetForderWaybillResponseBatchResult struct {
	// The number of orderSN to get airway bills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// This list contains the ordersn and error descriptions of all orders that failed to retrieve airway bill in this call.
	Errors []GetForderWaybillResponseError `json:"errors,omitempty"`
	// The url of retrieving airway bill.
	Waybills []string `json:"waybills,omitempty"`
}

type GetForderWaybillResponseError

type GetForderWaybillResponseError struct {
	// The ordersn of orders which occurred error.
	OrderSN string `json:"ordersn,omitempty"`
	// The forder_id of fulfillment orders which occurred error.
	ForderID string `json:"forder_id,omitempty"`
	//
	ErrorCode string `json:"error_code,omitempty"`
	// The detail information of this error.
	ErrorDescription string `json:"error_description,omitempty"`
}

type GetForderWaybillResponseResult

type GetForderWaybillResponseResult struct {
	// The number of ordersn to get airway bills in this call.
	TotalCount int `json:"total_count,omitempty"`
	// This Object contains the airway bill to each order.
	Waybills []GetForderWaybillResponseResultWaybill `json:"waybills,omitempty"`
	// This list contains the ordersn and error descriptions of all orders that failed to retrieve airway bill in this call.
	Errors []GetForderWaybillResponseError `json:"errors,omitempty"`
}

type GetForderWaybillResponseResultWaybill

type GetForderWaybillResponseResultWaybill struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
	// The url of retrieving airway bill.
	Waybill string `json:"waybill,omitempty"`
}

type GetItemDetailResponseItem

type GetItemDetailResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// Enumerated type that defines the current status of the item. Applicable values: NORMAL, DELETED, BANNED and UNLIST.
	Status string `json:"status,omitempty"`
	// Name of the item in local language.
	Name string `json:"name,omitempty"`
	// Description of the item in local language.
	Description string `json:"description,omitempty"`
	// Image URLs of the item. It contains at most 9 URLs.
	Images []string `json:"images,omitempty"`
	// The three-digit code representing the currency unit used for the item in Shopee Listings.
	Currency string `json:"currency,omitempty"`
	// This is to indicate whether the item has variation(s).
	HasVariaion bool `json:"has_variaion,omitempty"`
	// The current price of the item in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the item.
	Stock int `json:"stock,omitempty"`
	// Timestamp that indicates the date and time that the item was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// the net weight of this item, the unit is KG.
	Weight float64 `json:"weight,omitempty,string"`
	// Could call shopee.item.GetCategories to get category detail.Related to result.categories.category_id
	CategoryID int64 `json:"category_id,omitempty"`
	// The original price of the item in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The variation list of item
	Variations []GetItemDetailResponseItemVariation `json:"variations,omitempty"`
	//
	Attributes []GetItemDetailResponseItemAttribute `json:"attributes,omitempty"`
	// The logistics list.
	Logistics []GetItemDetailResponseItemLogistic `json:"logistics,omitempty"`
	// The wholesales tier list.
	Wholesales []GetItemDetailResponseItemWholesale `json:"wholesales,omitempty"`
	// The rating star scores of this item.
	RatingStar float64 `json:"rating_star,omitempty,string"`
	// Count of comments for the item.
	CMTCount int `json:"cmt_count,omitempty"`
	// The sales volume of item.
	Sales int `json:"sales,omitempty"`
	// The page view of item.
	Views int `json:"views,omitempty"`
	// The conllection number of item.
	Likes int `json:"likes,omitempty"`
	// The length of package for this single item, the unit is CM
	PackageLength float64 `json:"package_length,omitempty,string"`
	// The width of package for this single item, the unit is CM
	PackageWidth float64 `json:"package_width,omitempty,string"`
	// The height of package for this single item, the unit is CM
	PackageHeight float64 `json:"package_height,omitempty,string"`
	// The days to ship.
	DaysToShip int `json:"days_to_ship,omitempty"`
	// url of size chart image. Only particular categories support it.
	SizeChart string `json:"size_chart,omitempty"`
	// This indicates whether the item is secondhand.
	Condition string `json:"condition,omitempty"`
	// The ID of discount activity the item is currently in. One item can only have one discount at a time. discount_id will be 0 if the item has no discount applied, or item has variation.
	DiscountID int64 `json:"discount_id,omitempty"`
	// Whether 2-tier variation structure is activated for this item
	Is2TierItem bool `json:"is_2_tier_item,omitempty"`
	// Only for TW seller. List of installments
	Tenures []int `json:"tenures,omitempty"`
	// Use this field to get the locked stock of item by promotions.
	ReservedStock int `json:"reserved_stock,omitempty"`
	// Use this field to identify whether the item is pre-order. Applicable value: true/false.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
}

type GetItemDetailResponseItemAttribute

type GetItemDetailResponseItemAttribute struct {
	// The Identify of each category
	AttributeID int64 `json:"attribute_id,omitempty"`
	// The name of each attribute
	AttributeName string `json:"attribute_name,omitempty"`
	// This is to indicate whether this attribute is mandantory
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// Enumerated type that defines the type of the attribute. Applicable values: See Data Definition- AttributeType.
	AttributeType string `json:"attribute_type,omitempty"`
	// The value of this item attribute.
	AttributeValue string `json:"attribute_value,omitempty"`
}

type GetItemDetailResponseItemLogistic

type GetItemDetailResponseItemLogistic struct {
	// The identity of logistic channel
	LogisticID int64 `json:"logistic_id,omitempty"`
	// The name of logistic
	LogisticName string `json:"logistic_name,omitempty"`
	// related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item
	Enabled bool `json:"enabled,omitempty"`
	// Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// If specify logistic fee_type is SIZE_SELECTION size_id is required
	SizeID int64 `json:"size_id,omitempty"`
	// when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
	// Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
}

type GetItemDetailResponseItemVariation

type GetItemDetailResponseItemVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// The current price of the variation in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// Enumerated type that defines the current status of the variation. Applicable values: MODEL_NORMAL and MODEL_DELETED.
	Status string `json:"status,omitempty"`
	// Timestamp that indicates the date and time that the variation was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the variation, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// The original price of the variation in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The ID of discount activity the variation is currently in. One variation can only have one discount at a time. discount_id will be 0 if the variation has no discount applied.
	DiscountID int64 `json:"discount_id,omitempty"`
	// Use this field to get the locked stock of variation by promotions.
	ReservedStock int64 `json:"reserved_stock,omitempty"`
	// Use this field to indicate the after-tax price of variation.
	InflatedPrice float64 `json:"inflated_price,omitempty,string"`
	// Use this field to indicate the after-tax original price of variation.
	InflatedOriginalPrice float64 `json:"inflated_original_price,omitempty,string"`
	// The settlement price of SIP item.
	SIPItemPrice float64 `json:"sip_item_price,omitempty,string"`
	// The strategy of creating sip_item_price. auto: automatically created; manual: manually created.
	PriceSource string `json:"price_source,omitempty"`
}

type GetItemDetailResponseItemWholesale

type GetItemDetailResponseItemWholesale struct {
	// The min count of this tier wholesale.
	Min int `json:"min,omitempty"`
	// The max count of this tier wholesale.
	Max int `json:"max,omitempty"`
	// The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

type GetItemsListResponseItem

type GetItemsListResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// The latest update time of the item.
	UpdateTime int `json:"update_time,omitempty"`
	// Enumerated type that defines the current status of the item. Applicable values: NORMAL, BANNED and UNLIST.
	Status string `json:"status,omitempty"`
	// An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// The variation list of item
	Variations []GetItemsListResponseItemVariation `json:"variations,omitempty"`
	// Whether 2-tier variation structure is activated for this item
	Is2TierItem bool `json:"is_2_tier_item,omitempty"`
	// Only for TW seller. List of installments
	Tenures []int `json:"tenures,omitempty"`
}

type GetItemsListResponseItemVariation

type GetItemsListResponseItemVariation struct {
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type GetItemsResponseItem

type GetItemsResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
}

type GetLogisticInfoResponseDropoff

type GetLogisticInfoResponseDropoff struct {
	// List of available dropoff branches info.
	BranchList []GetLogisticInfoResponseDropoffBranch `json:"branch_list,omitempty"`
}

type GetLogisticInfoResponseDropoffBranch

type GetLogisticInfoResponseDropoffBranch struct {
	// The identity of branch.
	BranchID int64 `json:"branch_id,omitempty"`
	// The country of specify branch.
	Country string `json:"country,omitempty"`
	// The state of specify branch.
	State string `json:"state,omitempty"`
	// The city of specify branch.
	City string `json:"city,omitempty"`
	// The address description of specify branch.
	Address string `json:"address,omitempty"`
	// The zipcode of specify branch.
	Zipcode string `json:"zipcode,omitempty"`
	// The district of specify branch.
	District string `json:"district,omitempty"`
	// The town of specify branch.
	Town string `json:"town,omitempty"`
}

type GetLogisticInfoResponseInfo

type GetLogisticInfoResponseInfo struct {
	// Logistics information for pickup mode order.
	Pickup []string `json:"pickup,omitempty"`
	// Logistics information for dropoff mode order.
	Dropoff []string `json:"dropoff,omitempty"`
	// The parameters required based on each specific order to Init. Must use the fields included under info_needed to call Init.
	NonIntegrated []string `json:"non_integrated,omitempty"`
}

type GetLogisticInfoResponsePickup

type GetLogisticInfoResponsePickup struct {
	// List of available pickup address info.
	AddressList []GetLogisticInfoResponsePickupAddress `json:"address_list,omitempty"`
}

type GetLogisticInfoResponsePickupAddress

type GetLogisticInfoResponsePickupAddress struct {
	// The identity of address.
	AddressID int64 `json:"address_id,omitempty"`
	// The country of specify branch.
	Country string `json:"country,omitempty"`
	// The state of specify branch.
	State string `json:"state,omitempty"`
	// The city of specify branch.
	City string `json:"city,omitempty"`
	// The address description of specify branch.
	Address string `json:"address,omitempty"`
	// The zipcode of specify branch.
	Zipcode string `json:"zipcode,omitempty"`
	// The district of specify branch.
	District string `json:"district,omitempty"`
	// The town of specify branch.
	Town string `json:"town,omitempty"`
	// List of pickup_time information corresponding to the address_id.
	TimeSlotList []string `json:"time_slot_list,omitempty"`
	// The identity of pickuptime.
	PickupTimeID string `json:"pickup_time_id,omitempty"`
	// The date of pickup time. In timestamp.
	Date int `json:"date,omitempty"`
	// The text description of pickup time. Only applicable for certain channels.
	TimeText string `json:"time_text,omitempty"`
	// The flag of shop address, applicable values: default_address, pickup_address, return_address
	AddressFlag []string `json:"address_flag,omitempty"`
}

type GetLogisticsMessageResponseInfo

type GetLogisticsMessageResponseInfo struct {
	// The time when logistics info has been updated.
	CTime int `json:"c_time,omitempty"`
	// The order logistics tracking info.
	Description string `json:"description,omitempty"`
	// The 3PL logistics status for the order. Applicable values: See Data Definition - TrackingLogisticsStatus.
	Status string `json:"status,omitempty"`
}

type GetLogisticsResponseLogistic

type GetLogisticsResponseLogistic struct {
	// The identity of logistic channel
	LogisticID int64 `json:"logistic_id,omitempty"`
	// The name of logistic channel
	LogisticName string `json:"logistic_name,omitempty"`
	// This is to indicate whether this logistic channel supports COD
	HasCOD bool `json:"has_cod,omitempty"`
	// Whether this logistic channel is enabled on shop level.
	Enabled bool `json:"enabled,omitempty"`
	// See Define FeeType, related to FeeType Value
	FeeType string `json:"fee_type,omitempty"`
	// Only for fee_type is SIZE_SELECTION
	Sizes []GetLogisticsResponseLogisticSize `json:"sizes,omitempty"`
	// The weight limit for this logistic channel.
	WeightLimits GetLogisticsResponseLogisticLimit `json:"weight_limits,omitempty"`
	// The dimension limit for this logistic channel.
	ItemMaxDimension GetLogisticsResponseLogisticDimension `json:"item_max_dimension,omitempty"`
}

type GetLogisticsResponseLogisticDimension

type GetLogisticsResponseLogisticDimension struct {
	// The max height limit.
	Height float64 `json:"height,omitempty,string"`
	// The max width limit.
	Width float64 `json:"width,omitempty,string"`
	// The max length limit.
	Length float64 `json:"length,omitempty,string"`
	// The unit for the limit.
	Unit string `json:"unit,omitempty"`
}

type GetLogisticsResponseLogisticLimit

type GetLogisticsResponseLogisticLimit struct {
	// The max weight for an item on this logistic channel.If the value is 0 or null, that means there is no limit.
	ItemMaxWeight float64 `json:"item_max_weight,omitempty,string"`
	// The min weight for an item on this logistic channel. If the value is 0 or null, that means there is no limit.
	ItemMinWeight float64 `json:"item_min_weight,omitempty,string"`
}

type GetLogisticsResponseLogisticSize

type GetLogisticsResponseLogisticSize struct {
	// The identity of size.
	SizeID int64 `json:"size_id,omitempty"`
	// The name of size.
	Name int `json:"name,omitempty"`
	// The pre-defined shipping fee for the specific size.
	DefaultPrice int `json:"default_price,omitempty"`
}

type GetOrderDetailsResponseOrder

type GetOrderDetailsResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The two-digit code representing the country where the order was made.
	Country string `json:"country,omitempty"`
	// The three-digit code representing the currency unit for which the order was paid.
	Currency string `json:"currency,omitempty"`
	// This value indicates whether the order was a COD (cash on delivery) order.
	COD bool `json:"cod,omitempty"`
	// The tracking number assigned by the shipping carrier for item shipment.
	TrackingNo string `json:"tracking_no,omitempty"`
	// Shipping preparation time set by the seller when listing item on Shopee.
	DaysToShip int `json:"days_to_ship,omitempty"`
	// This object contains detailed breakdown for the recipient address.
	RecipientAddress GetOrderDetailsResponseOrderAddress `json:"recipient_address,omitempty"`
	// The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
	// The actual shipping cost of the order if available from external logistics partners.
	ActualShippingCost float64 `json:"actual_shipping_cost,omitempty,string"`
	// The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order.
	TotalAmount float64 `json:"total_amount,omitempty,string"`
	// The total amount that the seller is expected to receive for the order. This amount includes buyer paid order amount (total_amount), all forms of Shopee platform subsidy; and offset by any cost and commission incurred.
	EscrowAmount float64 `json:"escrow_amount,omitempty,string"`
	// Enumerated type that defines the current status of the order.
	OrderStatus string `json:"order_status,omitempty"`
	// The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// The payment method that the buyer selected to pay for the order.
	// Applicable values: See Data Definition- Payment Methods.
	PaymentMethod string `json:"payment_method,omitempty"`
	// Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
	GoodsToDeclare bool `json:"goods_to_declare,omitempty"`
	// Message to seller.
	MessageToSeller string `json:"message_to_seller,omitempty"`
	// The note seller made for own reference.
	Note string `json:"note,omitempty"`
	// Update time for the note.
	NoteUpdateTime int `json:"note_update_time,omitempty"`
	// Timestamp that indicates the date and time that the order was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
	UpdateTime int `json:"update_time,omitempty"`
	// This object contains the detailed breakdown for the result of this API call.
	Items []GetOrderDetailsResponseOrderItem `json:"items,omitempty"`
	// The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet.
	PayTime int `json:"pay_time,omitempty"`
	// For Indonesia orders only. The name of the dropshipper.
	Dropshipper string `json:"dropshipper,omitempty"`
	// Last 4 digits of the credit card
	CreditCardNumber string `json:"credit_card_number,omitempty"`
	// The name of buyer
	BuyerUsername string `json:"buyer_username,omitempty"`
	// The phone number of dropshipper
	DropshipperPhone string `json:"dropshipper_phone,omitempty"`
	// The deadline to ship out the parcel.
	ShipByDate int `json:"ship_by_date,omitempty"`
	// To indicate whether this order is split to fullfil order(forder) level. Call GetForderInfo if it's "true".
	IsSplitUp bool `json:"is_split_up,omitempty"`
	// Cancel reason from buyer.
	BuyerCancelReason string `json:"buyer_cancel_reason,omitempty"`
	// Could be one of buyer, seller or system
	CancelBy string `json:"cancel_by,omitempty"`
	// The first-mile tracking number.
	FMTN string `json:"fm_tn,omitempty"`
	// Use this field to get reason for buyer, seller, and system cancellation.
	CancelReason string `json:"cancel_reason,omitempty"`
	// Cross-border tax imposed by the Indonesian government on sellers.
	EscrowTax float64 `json:"escrow_tax,omitempty,string"`
	// Use this filed to judge whether the actual_shipping_fee is confirmed.
	IsActualShippingFeeConfirmed bool `json:"is_actual_shipping_fee_confirmed,omitempty"`
	// Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
	BuyerCPFID string `json:"buyer_cpf_id,omitempty"`
	// Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.
	OrderFlag string `json:"order_flag,omitempty"`
	// The last-mile tracking number. Only for Cross Board BR seller.
	LMTN string `json:"lm_tn,omitempty"`
}

type GetOrderDetailsResponseOrderAddress

type GetOrderDetailsResponseOrderAddress struct {
	// Recipient's name for the address.
	Name string `json:"name,omitempty"`
	// Recipient's phone number input when order was placed.
	Phone string `json:"phone,omitempty"`
	// The town of the recipient's address. Whether there is a town will depend on the region and/or country.
	Town string `json:"town,omitempty"`
	// The district of the recipient's address. Whether there is a town will depend on the region and/or country.
	District string `json:"district,omitempty"`
	// The city of the recipient's address. Whether there is a town will depend on the region and/or country.
	City string `json:"city,omitempty"`
	// The state/province of the recipient's address. Whether there is a town will depend on the region and/or country.
	State string `json:"state,omitempty"`
	// The two-digit code representing the country of the Recipient.
	Country string `json:"country,omitempty"`
	// Recipient's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// The full address of the recipient, including country, state, even street, and etc.
	FullAddress string `json:"full_address,omitempty"`
}

type GetOrderDetailsResponseOrderItem

type GetOrderDetailsResponseOrderItem struct {
	// ID of item
	ItemID int64 `json:"item_id,omitempty"`
	// Name of item
	ItemName string `json:"item_name,omitempty"`
	// A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// ID of the variation that belongs to the same item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of the variation that belongs to the same item.
	// A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	VariationName string `json:"variation_name,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// The number of identical items purchased at the same time by the same buyer from one listing/item.
	VariationQuantityPurchased int `json:"variation_quantity_purchased,omitempty"`
	// The original price of the item in the listing currency.
	VariationOriginalPrice float64 `json:"variation_original_price,omitempty,string"`
	// The after-discount price of the item in the listing currency. If there is no discount, this value will be same as that of variation_original_price.
	// In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/variation level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please call GetEscrowDetails if you want to calculate item-level discounted price for bundle deal item.
	VariationDiscountedPrice float64 `json:"variation_discounted_price,omitempty,string"`
	// This value indicates whether buyer buy the order item in wholesale price.
	IsWholesale bool `json:"is_wholesale,omitempty"`
	// The weight of the item
	Weight float64 `json:"weight,omitempty"`
	// To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// The unique identity of an addon deal.
	AddOnDealID int64 `json:"add_on_deal_id,omitempty"`
	// The type of the promotion,
	PromotionType string `json:"promotion_type,omitempty"`
	// The ID of the promotion.
	PromotionID int64 `json:"promotion_id,omitempty"`
}

type GetOrderLogisticsResponseLogistic

type GetOrderLogisticsResponseLogistic struct {
	// The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// The identity of logistic channel.
	LogisticID int64 `json:"logistic_id,omitempty"`
	// Only work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes.
	ServiceCode string `json:"service_code,omitempty"`
	// Only work for cross-border order.The name of the carrier ships cross countries.
	FirstMileName string `json:"first_mile_name,omitempty"`
	// Only work for cross-border order.The name of the carrier delivers the parcels in local country.
	LastMileName string `json:"last_mile_name,omitempty"`
	// Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
	GoodsToDeclare bool `json:"goods_to_declare,omitempty"`
	// The tracking number assigned by the shipping carrier for item shipment.
	TrackingNo string `json:"tracking_no,omitempty"`
	//
	Zone string `json:"zone,omitempty"`
	// Only work for cross-border order. The string use for waybill printing. The format is "S - country_code and lane_number". For example, S-TH01, S-TH02
	LaneCode string `json:"lane_code,omitempty"`
	// Only work for cross-border order in some special shop. The address info of the warehouse.
	WarehouseAddress string `json:"warehouse_address,omitempty"`
	// Only work for cross-border order in some special shop. The ID of the warehouse.
	WarehouseID int64 `json:"warehouse_id,omitempty"`
	// This object contains detailed breakdown for the recipient address.
	RecipientAddress GetOrderLogisticsResponseLogisticRecipientAddress `json:"recipient_address,omitempty"`
	// This value indicates whether the order was a COD (cash on delivery) order.
	COD bool `json:"cod,omitempty"`
	// The sort_code of recipient.
	RecipientSortCode GetOrderLogisticsResponseLogisticRecipientSortCode `json:"recipient_sort_code,omitempty"`
	// The sort_code of sender.
	SenderSortCode GetOrderLogisticsResponseLogisticSenderSortCode `json:"sender_sort_code,omitempty"`
	// Only used for local TW sellers.
	ThirdPartyLogisticInfo GetOrderLogisticsResponseLogisticThirdPartyLogisticInfo `json:"third_party_logistic_info,omitempty"`
	// Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
	BuyerCPFID string `json:"buyer_cpf_id,omitempty"`
	// First mile tracking NO. for CrossBoard BR seller can be used to self-design CB Brazil AWB.
	ShopeeTrackingNo string `json:"shopee_tracking_no,omitempty"`
	// The last-mile tracking number. Only for Cross Board BR seller.
	LMTN string `json:"lm_tn,omitempty"`
}

type GetOrderLogisticsResponseLogisticRecipientAddress

type GetOrderLogisticsResponseLogisticRecipientAddress struct {
	// Recipient's name for the address.
	Name string `json:"name,omitempty"`
	// Recipient's phone number input when order was placed.
	Phone string `json:"phone,omitempty"`
	// The town of the recipient's address. Whether there is a town will depend on the region and/or country.
	Town string `json:"town,omitempty"`
	// The district of the recipient's address. Whether there is a town will depend on the region and/or country.
	District string `json:"district,omitempty"`
	// The city of the recipient's address. Whether there is a town will depend on the region and/or country.
	City string `json:"city,omitempty"`
	// The state/province of the recipient's address. Whether there is a town will depend on the region and/or country.
	State string `json:"state,omitempty"`
	// The two-digit code representing the country of the Recipient.
	Country string `json:"country,omitempty"`
	// Recipient's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// The full address of the recipient, including country, state, even street, and etc.
	FullAddress string `json:"full_address,omitempty"`
}

type GetOrderLogisticsResponseLogisticRecipientSortCode

type GetOrderLogisticsResponseLogisticRecipientSortCode struct {
	// The first-level sort_code of recipient.
	FirstRecipientSortCode string `json:"first_recipient_sort_code,omitempty"`
	// The second-level sort_code of recipient.
	SecondRecipientSortCode string `json:"second_recipient_sort_code,omitempty"`
	// The third-level sort_code of recipient.
	ThirdRecipientSortCode string `json:"third_recipient_sort_code,omitempty"`
}

type GetOrderLogisticsResponseLogisticSenderSortCode

type GetOrderLogisticsResponseLogisticSenderSortCode struct {
	// The first-level sort_code of sender.
	FirstSenderSortCode string `json:"first_sender_sort_code,omitempty"`
	// The second-level sort_code of sender.
	SecondSenderSortCode string `json:"second_sender_sort_code,omitempty"`
	// The third-level sort_code of sender.
	ThirdSenderSortCode string `json:"third_sender_sort_code,omitempty"`
}

type GetOrderLogisticsResponseLogisticThirdPartyLogisticInfo

type GetOrderLogisticsResponseLogisticThirdPartyLogisticInfo struct {
	// Use this field to indicate the order category.
	ServiceDescription string `json:"service_description,omitempty"`
	// The manufacturer barcode.
	Barcode string `json:"barcode,omitempty"`
	// The purchase_time of the store.
	PurchaseTime string `json:"purchase_time,omitempty"`
	// The return_time of the store.
	ReturnTime string `json:"return_time,omitempty"`
	// The name of manufacturers.
	ManufacturesName string `json:"manufacturers_name,omitempty"`
	// The website of manufacturers.
	ManufacturesWebsite string `json:"manufacturers_website,omitempty"`
	// The identification of recipient area.
	RecipientArea string `json:"recipient_area,omitempty"`
	// The route code of the waybill.
	RouteStep string `json:"route_step,omitempty"`
	// The tally code of the waybill.
	Suda5Code string `json:"suda5_code,omitempty"`
	// The code of large logistics.
	LargeLogisticsID string `json:"large_logistics_id,omitempty"`
	// The parent code of the waybill.
	ParentID string `json:"parent_id,omitempty"`
	// Use this field to indicate the return cycle.
	ReturnCycle string `json:"return_cycle,omitempty"`
	// Use this field to indicate the return mode.
	ReturnMode string `json:"return_mode,omitempty"`
	// The reminder of stork work.
	Prompt string `json:"prompt,omitempty"`
	// Shopee's unique identifier for an order.
	OrderNo string `json:"order_no,omitempty"`
	// The QR code of the waybill.
	QRCode string `json:"qrcode,omitempty"`
	// The supplier name of channel.
	ECSupplierName string `json:"ec_supplier_name,omitempty"`
	// Use this field to indicate the first barcode.
	ECBarCode16 string `json:"ec_bar_code16,omitempty"`
	// The device code.
	EquipmentID string `json:"equipment_id,omitempty"`
	// The child code for B2C Family-mart.
	EShopID string `json:"eshop_id,omitempty"`
	// Use this field to indicate the pick barcode.
	ECBarCode9 string `json:"ec_bar_code9,omitempty"`
}

type GetOrdersByStatusResponseOrder

type GetOrdersByStatusResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// Enumerated type that defines the current status of the order. Applicable values: See Data Definition- OrderStatus.
	OrderStatus string `json:"order_status,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
	UpdateTime int `json:"update_time,omitempty"`
}

type GetOrdersListResponseOrder

type GetOrdersListResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// Enumerated type that defines the current status of the order. Applicable values: See Data Definition- OrderStatus.
	OrderStatus string `json:"order_status,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
	UpdateTime int `json:"update_time,omitempty"`
}

type GetPaymentListResponseMethod

type GetPaymentListResponseMethod struct {
	// The payment method
	PaymentMethod string `json:"payment_method,omitempty"`
	// The country for this payment method
	Country string `json:"country,omitempty"`
}

type GetPromotionInfoResponseItem

type GetPromotionInfoResponseItem struct {
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
	// Promotion information list.
	Promotions []GetPromotionInfoResponseItemPromotion `json:"promotions,omitempty"`
	// The list of error items.
	Errors []GetPromotionInfoResponseItemError `json:"errors,omitempty"`
}

type GetPromotionInfoResponseItemError

type GetPromotionInfoResponseItemError struct {
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
	// Error Message.
	ErrorMsg string `json:"error_msg,omitempty"`
}

type GetPromotionInfoResponseItemPromotion

type GetPromotionInfoResponseItemPromotion struct {
	//
	PromotionType string `json:"promotion_type,omitempty"`
	// The ID of promotion.
	PromotionID int64 `json:"promotion_id,omitempty"`
	// ID of the variation that belongs to the same item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Start timestamp of promotion.
	StartTime int `json:"start_time,omitempty"`
	// End timestamp of promotion.
	EndTime int `json:"end_time,omitempty"`
	// The promotion price of item.
	PromotionPrice float64 `json:"promotion_price,omitempty,string"`
	// The Locked stock of item by promotion.
	ReservedStock int `json:"reserved_stock,omitempty"`
	// The sold out timestamp of promotion stock.
	StockoutTime int `json:"stockout_time,omitempty"`
	// The stage at which the promotion goes. Available values: ongoing/upcoming.
	Staging string `json:"staging,omitempty"`
}

type GetPushConfigResponseDeatiledConfig

type GetPushConfigResponseDeatiledConfig struct {
	// 0 stands for off and 1 stands for on.
	OrderStatus int `json:"order_status,omitempty"`
	// 0 stands for off and 1 stands for on.
	OrderTrackingNo int `json:"order_trackingno,omitempty"`
	// 0 stands for off and 1 stands for on.
	ShopUpdate int `json:"shop_update,omitempty"`
	// 0 stands for off and 1 stands for on.
	BannedItem int `json:"banned_item,omitempty"`
	// 0 stands for off and 1 stands for on.
	ItemPromotion int `json:"item_promotion,omitempty"`
	// 0 stands for off and 1 stands for on.
	ReservedStockChange int `json:"reserved_stock_change,omitempty"`
}

type GetReturnDetailResponseItem

type GetReturnDetailResponseItem struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of item in local language.
	Name string `json:"name,omitempty"`
	// Image URLs of item.
	Images []string `json:"images,omitempty"`
	// Amount of this item.
	Amount int `json:"amount,omitempty"`
	// The price of item.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// The unique identity of an addon deal.
	AddOnDealID int64 `json:"add_on_deal_id,omitempty"`
}

type GetReturnDetailResponseUser

type GetReturnDetailResponseUser struct {
	// Buyer's nickname.
	Username int `json:"username,omitempty"`
	// Buyer's email.
	Email string `json:"email,omitempty"`
	// Buyer's portrait.
	Portrait string `json:"portrait,omitempty"`
}

type GetReturnListResponseReturn

type GetReturnListResponseReturn struct {
	// Image URLs of return.
	Images []string `json:"images,omitempty"`
	// Reason for return product. Applicable values: See Data Definition- ReturnReason.
	Reason string `json:"reason,omitempty"`
	// Reason that buyer provide.
	TextReason string `json:"text_reason,omitempty"`
	// The serial number of return.
	ReturnSN int `json:"return_sn,omitempty"`
	// Amount of the refund.
	RefundAmount float64 `json:"refund_amount,omitempty,string"`
	// Currency of the return.
	Currency string `json:"currency,omitempty"`
	// The time of return create.
	CreateTime int `json:"create_time,omitempty"`
	// The time of modify return.
	UpdateTime int `json:"update_time,omitempty"`
	// Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
	Status string `json:"status,omitempty"`
	// The last time seller deal with this return.
	DueDate int `json:"due_date,omitempty"`
	// The tracking number assigned by the shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.
	DisputeReason string `json:"dispute_reason,omitempty"`
	// The reason that seller provide. While the return has been disputed, this field is useful.
	DisputeTextReason string `json:"dispute_text_reason,omitempty"`
	// Items to be sent back to seller. Can be either integrated/non-integrated.
	NeedsLogistics bool `json:"needs_logistics,omitempty"`
	// Order price before discount.
	AmountBeforeDiscount float64 `json:"amount_before_discount,omitempty,string"`
	//
	User GetReturnListResponseReturnUser `json:"user,omitempty"`
	//
	Item []GetReturnListResponseReturnItem `json:"item,omitempty"`
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
}

type GetReturnListResponseReturnItem

type GetReturnListResponseReturnItem struct {
	// Item id.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of item in local language.
	Name string `json:"name,omitempty"`
	// Image URLs of item.
	Images []string `json:"images,omitempty"`
	// Amount of this item.
	Amount int `json:"amount,omitempty"`
	// The price of Item.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// The unique identity of an addon deal.
	AddOnDealID int64 `json:"add_on_deal_id,omitempty"`
}

type GetReturnListResponseReturnUser

type GetReturnListResponseReturnUser struct {
	// Buyer's nickname.
	Username int `json:"username,omitempty"`
	// Buyer's email.
	Email string `json:"email,omitempty"`
	// Buyer's portrait.
	Protrait string `json:"protrait,omitempty"`
}

type GetShopCategoriesResponseCategory

type GetShopCategoriesResponseCategory struct {
	// ShopCategory's unique identifier.
	ShopCategoryID int64 `json:"shop_category_id,omitempty"`
	// ShopCategory's status. Applicable values: NORMAL, INACTIVE, DELETED.
	Status string `json:"status,omitempty"`
	// ShopCategory's name.
	Name string `json:"name,omitempty"`
	// ShopCategory's sort weight.
	SortWeight int `json:"sort_weight,omitempty"`
}

type GetShopFMTrackingNoResponseFMTNList

type GetShopFMTrackingNoResponseFMTNList struct {
	// The specified delivery date.
	DeclareDate string `json:"declare_date,omitempty"`
	// The logistics status for bound orders.
	Status string `json:"status,omitempty"`
	// The first-mile tracking number.
	FMTN string `json:"fm_tn,omitempty"`
}

type GetShopFirstMileChannelResponseLogistic

type GetShopFirstMileChannelResponseLogistic struct {
	// The identity of logistic channel.
	LogisticID int64 `json:"logistic_id,omitempty"`
	// The name of logistic.
	LogisticName string `json:"logistic_name,omitempty"`
	// The shipment method for bound orders, should be pickup or dropoff.
	ShipmentMethod string `json:"shipment_method,omitempty"`
}

type GetShopInfoRequest

type GetShopInfoRequest struct {
	// Partner ID is assigned upon registration is successful. Required for all requests.
	PartnerID int64 `json:"partner_id,omitempty"`
	// Shopee's unique identifier for a shop. Required for all requests.
	ShopID int64 `json:"shopid,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type GetShopInfoResponse

type GetShopInfoResponse struct {
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// Name of the shop.
	ShopName string `json:"shop_name,omitempty"`
	// The two-digit code representing the country where the order was made.
	Country string `json:"country,omitempty"`
	// Description of the shop.
	ShopDescription string `json:"shop_description,omitempty"`
	// List of videos URLs of the shop.
	Videos []string `json:"videos,omitempty"`
	// List of images URLs of the shop.
	Images []string `json:"images,omitempty"`
	// Allow negotiations or not, 1: don't allow, 0: allow.
	DisableMakeOffer int `json:"disable_make_offer,omitempty"`
	// Display pickup address or not.
	EnableDisplayUnitNo bool `json:"enable_display_unit_no,omitempty"`
	// Listing limitation of items for the shop.
	ItemLimit int `json:"item_limit,omitempty"`
	// The identifier for an API request for error tracking
	RequestID string `json:"request_id,omitempty"`
	// Applicable status: BANNED, FROZEN, NORMAL
	Status string `json:"status,omitempty"`
	// Only for TW seller. The status of whether shop support installment: 1 means true and 0 means false
	InstallmentStatus int `json:"installment_status,omitempty"`
	// SIP affiliate shops info list
	SIPAShops []GetShopInfoResponseShop `json:"sip_a_shops,omitempty"`
	// Use this filed to indicate whether the shop is a cross-border shop.
	IsCB bool `json:"is_cb,omitempty"`
	// The days-to-ship value for non-pre orders.
	NonPreOrderDTS int64 `json:"non_pre_order_dts,omitempty"`
	// The timestamp when the shop was authorized to the partner.
	AuthTime int64 `json:"auth_time,omitempty"`
	// Use this field to indicate the expiration date for shop authorization.
	ExpireTime int64 `json:"expire_time,omitempty"`
}

type GetShopInfoResponseShop

type GetShopInfoResponseShop struct {
	// Affiliate shop's id.
	AShopID string `json:"a_shopid,omitempty"`
	// Affiliate Shop's area.
	Country string `json:"country,omitempty"`
}

type GetShopsByPartnerResponseShop

type GetShopsByPartnerResponseShop struct {
	// The two-digit code representing the country where the order was made.
	Country string `json:"country,omitempty"`
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// The timestamp when the shop was authorized to the partner.
	AuthTime int `json:"auth_time,omitempty"`
	// SIP affiliate shops info list
	SIPAShops []GetShopsByPartnerResponseShopSIP `json:"sip_a_shops,omitempty"`
	// Use this field to indicate the expiration date for shop authorization.
	ExpireTime int `json:"expire_time,omitempty"`
}

type GetShopsByPartnerResponseShopSIP

type GetShopsByPartnerResponseShopSIP struct {
	// Affiliate Shop's area
	Country string `json:"country,omitempty"`
	// Affiliate shop's id
	AShopID int64 `json:"a_shopid,omitempty"`
}

type GetTimeSlotResponseTime

type GetTimeSlotResponseTime struct {
	// The identity of pickuptime.
	PickupTimeID string `json:"pickup_time_id,omitempty"`
	// The date of pickup time. In timestamp.
	Date int `json:"date,omitempty"`
	// The text description of pickup time. Only applicable for certain channels.
	TimeText string `json:"time_text,omitempty"`
}

type GetTopPicksListResponseCollection

type GetTopPicksListResponseCollection struct {
	// Collection name
	Name string `json:"name,omitempty"`
	// Collection ID
	TopPicksID int64 `json:"top_picks_id,omitempty"`
	// True or False
	IsActivated bool `json:"is_activated,omitempty"`
	// Item list of the collection
	Items []GetTopPicksListResponseCollectionItem `json:"items,omitempty"`
}

type GetTopPicksListResponseCollectionItem

type GetTopPicksListResponseCollectionItem struct {
	// Item ID
	ItemID int64 `json:"item_id,omitempty"`
	// Item name
	ItemName string `json:"item_name,omitempty"`
	// Item discounted price(original price if no discount). Item level price will return if it has variation.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// The sales of the item
	Sales int `json:"sales,omitempty"`
}

type GetTransactionListResponseTransactionList

type GetTransactionListResponseTransactionList struct {
	// The ID of transaction.
	TransactionID int64 `json:"transaction_id,omitempty"`
	// The status of the transaction,available values: FAILED,COMPLETED,PENDING,INITIAL.
	Status string `json:"status,omitempty"`
	// The type of wallet, available values: shopee pay, jko pay.
	WalletType string `json:"wallet_type,omitempty"`
	// The type of transaction.
	TransactionType string `json:"transaction_type,omitempty"`
	// The amount of transaction.
	Amount float64 `json:"amount,omitempty,string"`
	// The current balance of this account.
	CurrentBalance float64 `json:"current_balance,omitempty,string"`
	// The create time of the transaction.
	CreateTime int `json:"create_time,omitempty"`
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The serial number of return.
	RefundSN string `json:"refund_sn,omitempty"`
	// The type of withdrawal.
	WithdrawalType string `json:"withdrawal_type,omitempty"`
	// This field indicates the transaction fee.
	TransactionFee float64 `json:"transaction_fee,omitempty,string"`
	// The detailed description of TOPUP SUCCESS and TOPUP FAILED.
	Description string `json:"description,omitempty"`
	// The name of buyer.
	BuyerName string `json:"buyer_name,omitempty"`
	// List of ordersn included in the transaction.
	PayOrderList GetTransactionListResponseTransactionListPayOrderList `json:"pay_order_list,omitempty"`
	// Name of the shop.
	ShopName string `json:"shop_name,omitempty"`
	// Withdraw ID when transaction type is withdraw_created, withdrawal_completed, withdrawal_cancelled.
	WithdrawID float64 `json:"withdraw_id,omitempty,string"`
	// The reason for ADJUSTMENT_ADD and ADJUSTMENT_MINUS.
	Reason string `json:"reason,omitempty"`
	// Use this field to indicate the event where a withdrawal is split into several withdrawals due to the withdrawal limit.
	RootWithdrawID float64 `json:"root_withdrawal_id,omitempty"`
}

type GetTransactionListResponseTransactionListPayOrderList

type GetTransactionListResponseTransactionListPayOrderList struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// Name of the shop.
	ShopName string `json:"shop_name,omitempty"`
}

type GetUnbindOrderListResponseOrder

type GetUnbindOrderListResponseOrder struct {
	// Shopee's unique identifier for an order.
	OrderSN string `json:"ordersn,omitempty"`
	// The Shopee logistics status for the order. Applicable values: See Data Definition- LogisticsStatus.
	LogisticStatus string `json:"logistic_status,omitempty"`
	// The unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
}

type GetVariationResponseTierVariation

type GetVariationResponseTierVariation struct {
	// Tier variation name.
	Name string `json:"name,omitempty"`
	// Tier variation value options list.
	Options []string `json:"options,omitempty"`
	// Tier variation images. Can only be applied for the first level options. Urls sequence match the options sequence and urls number cannot exceed options number.
	ImagesURL []string `json:"images_url,omitempty"`
}

type GetVariationResponseVariation

type GetVariationResponseVariation struct {
	// Unique identifier of the variation.
	VariationID string `json:"variation_id,omitempty"`
	// A list of tier variation combination index, which indicates variation's option position in tier_variation['options'] list. e.g. [0,1] means tier variation 1 option 1 and tier variation 2 option 2.
	TierIndex []int `json:"tier_index,omitempty"`
}

type GlobalModel added in v1.5.1

type GlobalModel struct {
	// original_price is Original price of global model.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// normal_stock is Normal stock of global model.
	NormalStock int `json:"normal_stock,omitempty"`
	// global_model_sku is Sku of global model. model_sku length information needs to be no more than 100 characters.
	GlobalModelSku string `json:"global_model_sku,omitempty"`
	// tier_index is Tier index of global model. Index starts from 0.
	TierIndex []int `json:"tier_index,omitempty"`
}

======================================================= Object Raw Type - GlobalModel =======================================================

type GlobalProductAddGlobalItem added in v1.5.1

type GlobalProductAddGlobalItem struct {
	// global_item_id is Id of added global item.
	GlobalItemID int `json:"global_item_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductAddGlobalItem =======================================================

type GlobalProductAddGlobalItemRequest added in v1.5.0

type GlobalProductAddGlobalItemRequest struct {
	V2RequestAuthenticationParams

	// category_id is Category id of global item.
	CategoryID int `json:"category_id"`
	// global_item_name is Name of global item.
	GlobalItemName string `json:"global_item_name"`
	// description is Description of global item.
	Description string `json:"description"`
	// global_item_sku is Sku of global item.
	GlobalItemSku string `json:"global_item_sku,omitempty"`
	// image is Image information of global item.
	Image Image `json:"image,omitempty"`
	// original_price is Original price of global item.
	OriginalPrice float64 `json:"original_price,string"`
	// normal_stock is Normal stock of global item.
	NormalStock int `json:"normal_stock"`
	// weight is Weight of global item.
	Weight float64 `json:"weight,string"`
	// dimension is Dimension information of global item.
	Dimension Dimension `json:"dimension,omitempty"`
	// pre_order is Preorder information of global item.
	PreOrder PreOrder `json:"pre_order"`
	// condition is Condition of global item, "NEW" or "USED" is available.
	Condition string `json:"condition,omitempty"`
	// video_upload_id is Video upload id of global item. Only accept one video_upload_id at most.
	VideoUploadID []string `json:"video_upload_id,omitempty"`
	// brand is
	Brand Brand `json:"brand,omitempty"`
	// attribute_list is Item attributes.
	AttributeList []AttributeList `json:"attribute_list,omitempty"`
	// description_info is New description field. New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo DescriptionInfo `json:"description_info,omitempty"`
	// description_type is Values: See Data Definition- description_type (normal , extended). If you want to use extended_description, this field must be inputed
	DescriptionType string `json:"description_type,omitempty"`
}

======================================================= GlobalProductAddGlobalItemRequest =======================================================

type GlobalProductAddGlobalItemResponse added in v1.5.0

type GlobalProductAddGlobalItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductAddGlobalItem `json:"response,omitempty"`
}

======================================================= GlobalProductAddGlobalItemResponse =======================================================

type GlobalProductAddGlobalModelRequest added in v1.5.0

type GlobalProductAddGlobalModelRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
	// global_model is Global model setting list. Limit is  [1,50].
	GlobalModel []GlobalModel `json:"global_model"`
}

======================================================= GlobalProductAddGlobalModelRequest =======================================================

type GlobalProductAddGlobalModelResponse added in v1.5.0

type GlobalProductAddGlobalModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductAddGlobalModelResponse =======================================================

type GlobalProductCategoryRecommend added in v1.5.1

type GlobalProductCategoryRecommend struct {
	// category_id is Shopee's unique identifier for a category.
	CategoryID []int `json:"category_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductCategoryRecommend =======================================================

type GlobalProductCategoryRecommendRequest added in v1.5.0

type GlobalProductCategoryRecommendRequest struct {
	V2RequestAuthenticationParams

	// global_item_name is name of item
	GlobalItemName string `json:"global_item_name"`
}

======================================================= GlobalProductCategoryRecommendRequest =======================================================

type GlobalProductCategoryRecommendResponse added in v1.5.0

type GlobalProductCategoryRecommendResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductCategoryRecommend `json:"response"`
}

======================================================= GlobalProductCategoryRecommendResponse =======================================================

type GlobalProductCreatePublishTask added in v1.5.1

type GlobalProductCreatePublishTask struct {
	// publish_task_id is The id of publish task.
	PublishTaskID int `json:"publish_task_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductCreatePublishTask =======================================================

type GlobalProductCreatePublishTaskRequest added in v1.5.0

type GlobalProductCreatePublishTaskRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id"`
	// shop_id is Id of shop to publish to.
	ShopID int `json:"shop_id"`
	// shop_region is Region of shop.
	ShopRegion string `json:"shop_region"`
	// item is Item information.
	Item Item `json:"item,omitempty"`
}

======================================================= GlobalProductCreatePublishTaskRequest =======================================================

type GlobalProductCreatePublishTaskResponse added in v1.5.0

type GlobalProductCreatePublishTaskResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductCreatePublishTask `json:"response,omitempty"`
}

======================================================= GlobalProductCreatePublishTaskResponse =======================================================

type GlobalProductDeleteGlobalItem added in v1.5.1

type GlobalProductDeleteGlobalItem struct {
	// failure_delete_item is If delete failed, this field shows the details.
	FailureDeleteItem []GlobalProductDeleteGlobalItemFailureDeleteItem `json:"failure_delete_item"`
}

======================================================= Object Raw Type - GlobalProductDeleteGlobalItem =======================================================

type GlobalProductDeleteGlobalItemFailureDeleteItem added in v1.5.4

type GlobalProductDeleteGlobalItemFailureDeleteItem struct {
	// shop_id is The id of shop corresponding to the related item failed to delete.
	ShopID int `json:"shop_id,omitempty"`
	// item_id is The id of related item failed to delete.
	ItemID int `json:"item_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductDeleteGlobalItemFailureDeleteItem =======================================================

type GlobalProductDeleteGlobalItemRequest added in v1.5.0

type GlobalProductDeleteGlobalItemRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is The id of global item to delete.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductDeleteGlobalItemRequest =======================================================

type GlobalProductDeleteGlobalItemResponse added in v1.5.0

type GlobalProductDeleteGlobalItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductDeleteGlobalItem `json:"response"`
}

======================================================= GlobalProductDeleteGlobalItemResponse =======================================================

type GlobalProductDeleteGlobalModel added in v1.5.1

type GlobalProductDeleteGlobalModel struct {
	// global_model_id is Global model id.
	GlobalModelID int `json:"global_model_id,omitempty"`
	// failures is
	Failures []GlobalProductDeleteGlobalModelFailure `json:"failures"`
}

======================================================= Object Raw Type - GlobalProductDeleteGlobalModel =======================================================

type GlobalProductDeleteGlobalModelFailure added in v1.5.5

type GlobalProductDeleteGlobalModelFailure struct {
	// shop_id is Failed shop id.
	ShopID int `json:"shop_id,omitempty"`
	// item_id is Failed item id.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Failed model id.
	ModelID int `json:"model_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductDeleteGlobalModelFailure =======================================================

type GlobalProductDeleteGlobalModelRequest added in v1.5.0

type GlobalProductDeleteGlobalModelRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Shopee's unique identifier for an global item.
	GlobalItemID int `json:"global_item_id"`
	// global_model_id is Shopee's unique identifier for an global model.
	GlobalModelID int `json:"global_model_id"`
}

======================================================= GlobalProductDeleteGlobalModelRequest =======================================================

type GlobalProductDeleteGlobalModelResponse added in v1.5.0

type GlobalProductDeleteGlobalModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductDeleteGlobalModel `json:"response"`
}

======================================================= GlobalProductDeleteGlobalModelResponse =======================================================

type GlobalProductGetAttributes added in v1.5.1

type GlobalProductGetAttributes struct {
	// attribute_list is Attribute info list.
	AttributeList []GlobalProductGetAttributesAttribute `json:"attribute_list"`
}

======================================================= Object Raw Type - GlobalProductGetAttributes =======================================================

type GlobalProductGetAttributesAttribute added in v1.5.5

type GlobalProductGetAttributesAttribute struct {
	// attribute_id is ID of attribute.
	AttributeID int `json:"attribute_id,omitempty"`
	// original_attribute_name is Attribute default name.
	OriginalAttributeName string `json:"original_attribute_name,omitempty"`
	// display_attribute_name is Attribute display name.
	DisplayAttributeName string `json:"display_attribute_name,omitempty"`
	// is_mandatory is Whether is mandatory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// input_validation_type is Attribute input validation type : INT_TYPE STRING_TYPE ENUM_TYPE FLOAT_TYPE DATE_TYPE TIMESTAMP_TYPE
	InputValidationType string `json:"input_validation_type,omitempty"`
	// format_type is Attribute format type: NORMAL QUANTITATIVE .
	FormatType string `json:"format_type,omitempty"`
	// date_format_type is Attribute date format type:YEAR_MONTH_DATE YEAR_MONTH.
	DateFormatType string `json:"date_format_type,omitempty"`
	// input_type is Attribute input type: DROP_DOWN MULTIPLE_SELECT TEXT_FILED COMBO_BOX MULTIPLE_SELECT_COMBO_BOX.
	InputType string `json:"input_type,omitempty"`
	// attribute_unit is All applicable attribute units.
	AttributeUnit []string `json:"attribute_unit,omitempty"`
	// attribute_value_list is Value list of this attribute.
	AttributeValueList []GlobalProductGetAttributesAttributeAttributeValue `json:"attribute_value_list"`
	// mandatory_region is This attribute will be used to check the required regions.
	MandatoryRegion []string `json:"mandatory_region,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetAttributesAttribute =======================================================

type GlobalProductGetAttributesAttributeAttributeValue added in v1.5.5

type GlobalProductGetAttributesAttributeAttributeValue struct {
	// value_id is ID of attribute value.
	ValueID int `json:"value_id,omitempty"`
	// original_value_name is Original name of value.
	OriginalValueName string `json:"original_value_name,omitempty"`
	// display_value_name is Display name of value.
	DisplayValueName string `json:"display_value_name,omitempty"`
	// value_unit is Unit of value.
	ValueUnit string `json:"value_unit,omitempty"`
	// parent_attribute_list is
	ParentAttributeList []GlobalProductGetAttributesAttributeAttributeValueParentAttribute `json:"parent_attribute_list"`
	// parent_brand_list is
	ParentBrandList []GlobalProductGetAttributesAttributeAttributeValueParentBrand `json:"parent_brand_list"`
}

======================================================= Object Raw Type - GlobalProductGetAttributesAttributeAttributeValue =======================================================

type GlobalProductGetAttributesAttributeAttributeValueParentAttribute added in v1.5.5

type GlobalProductGetAttributesAttributeAttributeValueParentAttribute struct {
	// parent_attribute_id is ID of parent attribute.
	ParentAttributeID int `json:"parent_attribute_id,omitempty"`
	// parent_value_id is ID of parent attribute value.
	ParentValueID int `json:"parent_value_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetAttributesAttributeAttributeValueParentAttribute =======================================================

type GlobalProductGetAttributesAttributeAttributeValueParentBrand added in v1.5.5

type GlobalProductGetAttributesAttributeAttributeValueParentBrand struct {
	// parent_brand_id is ID of parent brand.
	ParentBrandID int `json:"parent_brand_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetAttributesAttributeAttributeValueParentBrand =======================================================

type GlobalProductGetAttributesRequest added in v1.5.0

type GlobalProductGetAttributesRequest struct {
	V2RequestAuthenticationParams

	// language is Language for display name zh-hans   zh-hant  ms-my   en-my   en   id   vi   th    pt-br.
	Language string `json:"language,omitempty"`
	// category_id is ID of category.
	CategoryID int `json:"category_id"`
	// need_region_mandatory is Do you want to return the mandatory of attribute_ Region attribute.
	NeedRegionMandatory bool `json:"need_region_mandatory,omitempty"`
}

======================================================= GlobalProductGetAttributesRequest =======================================================

type GlobalProductGetAttributesResponse added in v1.5.0

type GlobalProductGetAttributesResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetAttributes `json:"response,omitempty"`
}

======================================================= GlobalProductGetAttributesResponse =======================================================

type GlobalProductGetBrandList added in v1.5.1

type GlobalProductGetBrandList struct {
	// brand_list is
	BrandList []GlobalProductGetBrandListBrand `json:"brand_list"`
	// has_next_page is  This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	HasNextPage bool `json:"has_next_page,omitempty"`
	// next_offset is If has_next_page is true, this value need set to next request.offset
	NextOffset int `json:"next_offset,omitempty"`
	// is_mandatory is Whether is mandatory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// input_type is Input type: DROP_DOWN  TEXT_FILED COMBO_BOX.
	InputType string `json:"input_type,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetBrandList =======================================================

type GlobalProductGetBrandListBrand added in v1.5.5

type GlobalProductGetBrandListBrand struct {
	// brand_id is  Id of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is Original name of brand
	OriginalBrandName string `json:"original_brand_name,omitempty"`
	// display_brand_name is  Display name of brand
	DisplayBrandName string `json:"display_brand_name,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetBrandListBrand =======================================================

type GlobalProductGetBrandListRequest added in v1.5.0

type GlobalProductGetBrandListRequest struct {
	V2RequestAuthenticationParams

	// offset is Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
	Offset int `json:"offset"`
	// page_size is the size of one page.
	PageSize int `json:"page_size"`
	// category_id is ID of category.
	CategoryID int `json:"category_id"`
	// status is Brand status , 1: normal brand, 2: pending brand.
	Status int `json:"status"`
}

======================================================= GlobalProductGetBrandListRequest =======================================================

type GlobalProductGetBrandListResponse added in v1.5.0

type GlobalProductGetBrandListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetBrandList `json:"response"`
}

======================================================= GlobalProductGetBrandListResponse =======================================================

type GlobalProductGetCategory added in v1.5.1

type GlobalProductGetCategory struct {
	// category_list is
	CategoryList []GlobalProductGetCategoryCategory `json:"category_list"`
}

======================================================= Object Raw Type - GlobalProductGetCategory =======================================================

type GlobalProductGetCategoryCategory added in v1.5.5

type GlobalProductGetCategoryCategory struct {
	// category_id is
	CategoryID int `json:"category_id,omitempty"`
	// parent_category_id is
	ParentCategoryID int `json:"parent_category_id,omitempty"`
	// original_category_name is
	OriginalCategoryName string `json:"original_category_name,omitempty"`
	// display_category_name is
	DisplayCategoryName string `json:"display_category_name,omitempty"`
	// has_children is
	HasChildren bool `json:"has_children,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetCategoryCategory =======================================================

type GlobalProductGetCategoryRequest added in v1.5.0

type GlobalProductGetCategoryRequest struct {
	V2RequestAuthenticationParams

	// language is Display language. Language should be one of "zh-hans", "zh-hant", "ms-my", "en-my", "en", "id", "vi", "th", "pt-br".
	Language string `json:"language,omitempty"`
}

======================================================= GlobalProductGetCategoryRequest =======================================================

type GlobalProductGetCategoryResponse added in v1.5.0

type GlobalProductGetCategoryResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetCategory `json:"response,omitempty"`
}

======================================================= GlobalProductGetCategoryResponse =======================================================

type GlobalProductGetDtsLimit added in v1.5.1

type GlobalProductGetDtsLimit struct {
	// days_to_ship_range_list is If the length of the range list is greater than one, the final result is the union of multiple intervals
	DaysToShipRangeList []GlobalProductGetDtsLimitDaysToShipRange `json:"days_to_ship_range_list"`
}

======================================================= Object Raw Type - GlobalProductGetDtsLimit =======================================================

type GlobalProductGetDtsLimitDaysToShipRange added in v1.5.5

type GlobalProductGetDtsLimitDaysToShipRange struct {
	// min_limit is Days to ship min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Days to ship max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetDtsLimitDaysToShipRange =======================================================

type GlobalProductGetDtsLimitRequest added in v1.5.0

type GlobalProductGetDtsLimitRequest struct {
	V2RequestAuthenticationParams

	// category_id is Id of category.
	CategoryID int `json:"category_id"`
}

======================================================= GlobalProductGetDtsLimitRequest =======================================================

type GlobalProductGetDtsLimitResponse added in v1.5.0

type GlobalProductGetDtsLimitResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetDtsLimit `json:"response"`
}

======================================================= GlobalProductGetDtsLimitResponse =======================================================

type GlobalProductGetGlobalItemID added in v1.5.1

type GlobalProductGetGlobalItemID struct {
	// item_id_map is
	ItemIdMap []GlobalProductGetGlobalItemIDItemIdMap `json:"item_id_map"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemID =======================================================

type GlobalProductGetGlobalItemIDItemIdMap added in v1.5.4

type GlobalProductGetGlobalItemIDItemIdMap struct {
	// item_id is Id of item.
	ItemID int `json:"item_id,omitempty"`
	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemIDItemIdMap =======================================================

type GlobalProductGetGlobalItemIDRequest added in v1.5.0

type GlobalProductGetGlobalItemIDRequest struct {
	V2RequestAuthenticationParams

	// shop_id is Id of shop.
	ShopID int `json:"shop_id"`
	// item_id_list is Item id list. Length limit is [1,20].
	ItemIdList []int `json:"item_id_list"`
}

======================================================= GlobalProductGetGlobalItemIDRequest =======================================================

type GlobalProductGetGlobalItemIDResponse added in v1.5.0

type GlobalProductGetGlobalItemIDResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetGlobalItemID `json:"response"`
}

======================================================= GlobalProductGetGlobalItemIDResponse =======================================================

type GlobalProductGetGlobalItemInfo added in v1.5.1

type GlobalProductGetGlobalItemInfo struct {
	// global_item_list is
	GlobalItemList []GlobalProductGetGlobalItemInfoGlobalItem `json:"global_item_list"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfo =======================================================

type GlobalProductGetGlobalItemInfoGlobalItem added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItem struct {
	// global_item_id is Shopee's unique identifier for an global item.
	GlobalItemID int `json:"global_item_id,omitempty"`
	// global_item_name is Name of the global item.
	GlobalItemName string `json:"global_item_name,omitempty"`
	// description is Description of the global item.
	Description string `json:"description,omitempty"`
	// global_item_sku is An global item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	GlobalItemSku string `json:"global_item_sku,omitempty"`
	// global_item_status is The current status of the item. You can only query global product with normal status, otherwise api will return error.
	GlobalItemStatus string `json:"global_item_status,omitempty"`
	// create_time is Timestamp that indicates the date and time that the global item was created.
	CreateTime int `json:"create_time,omitempty"`
	// update_time is Timestamp that indicates the last time that there was a change in value of the global item.
	UpdateTime int `json:"update_time,omitempty"`
	// stock_info is If the item has models, this field will not be returned, please get it through get_model_list api.
	StockInfo []GlobalProductGetGlobalItemInfoGlobalItemStockInfo `json:"stock_info"`
	// price_info is If the item has models, price_info will not be returned. Please get the price of each model through the get_global_model_list api.
	PriceInfo []GlobalProductGetGlobalItemInfoGlobalItemPriceInfo `json:"price_info"`
	// image is
	Image GlobalProductGetGlobalItemInfoGlobalItemImage `json:"image"`
	// weight is The weight of this item.
	Weight float64 `json:"weight,omitempty,string"`
	// dimension is
	Dimension GlobalProductGetGlobalItemInfoGlobalItemDimension `json:"dimension"`
	// pre_order is
	PreOrder GlobalProductGetGlobalItemInfoGlobalItemPreOrder `json:"pre_order"`
	// size_chart is Url of size chart image.
	SizeChart string `json:"size_chart,omitempty"`
	// condition is Is it second-hand.
	Condition string `json:"condition,omitempty"`
	// has_model is Does it contain model.
	HasModel bool `json:"has_model,omitempty"`
	// video is
	Video GlobalProductGetGlobalItemInfoGlobalItemVideo `json:"video"`
	// category_id is Shopee's unique identifier for a category.
	CategoryID int `json:"category_id,omitempty"`
	// brand is
	Brand GlobalProductGetGlobalItemInfoGlobalItemBrand `json:"brand"`
	// attribute_list is
	AttributeList []GlobalProductGetGlobalItemInfoGlobalItemAttribute `json:"attribute_list"`
	// description_info is New description field.New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfo `json:"description_info"`
	// description_type is Type of description : values: See Data Definition- description_type (normal , extended).
	DescriptionType map[string]interface{} `json:"description_type,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItem =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemAttribute added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemAttribute struct {
	// attribute_id is The Identify of each category.
	AttributeID int `json:"attribute_id,omitempty"`
	// original_attribute_name is The name of each attribute.
	OriginalAttributeName string `json:"original_attribute_name,omitempty"`
	// attribute_value_list is
	AttributeValueList []GlobalProductGetGlobalItemInfoGlobalItemAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemAttribute =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemAttributeAttributeValue added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemAttributeAttributeValue struct {
	// value_id is Unique identifier for value of this item attribute.
	ValueID int `json:"value_id,omitempty"`
	// original_value_name is Value name of this item attribute.
	OriginalValueName string `json:"original_value_name,omitempty"`
	// value_unit is Value unit of this item attribute.
	ValueUnit string `json:"value_unit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemAttributeAttributeValue =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemBrand added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemBrand struct {
	// brand_id is Id of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is Original name of brand.
	OriginalBrandName string `json:"original_brand_name,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemBrand =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfo added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfo struct {
	// extended_description is If description_type is extended , Description information will be returned through this field.
	ExtendedDescription GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescription `json:"extended_description"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfo =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescription added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescription struct {
	// field_list is Field of extended description
	FieldList []GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionField `json:"field_list"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescription =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionField added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field: values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be returned through this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image, image url will be returned through this field.
	ImageInfo GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionField =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
	// image_url is Image url.
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemDescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemDimension added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemDimension struct {
	// package_length is The length of package for this single item.
	PackageLength int `json:"package_length,omitempty"`
	// package_width is The width of package for this single item.
	PackageWidth int `json:"package_width,omitempty"`
	// package_height is The height of package for this single item.
	PackageHeight int `json:"package_height,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemDimension =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemImage added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemImage struct {
	// image_id_list is List of image url.
	ImageIdList []string `json:"image_id_list,omitempty"`
	// image_url_list is List of image id.
	ImageUrlList []string `json:"image_url_list,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemImage =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemPreOrder added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemPreOrder struct {
	// days_to_ship is Days to ship.
	DaysToShip int `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemPreOrder =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemPriceInfo added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemPriceInfo struct {
	// currency is The three-digit code representing the currency unit used for the item in Shopee Listings.
	Currency string `json:"currency,omitempty"`
	// original_price is The original price of the item in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// sip_item_price is SIP item price.
	SipItemPrice float64 `json:"sip_item_price,omitempty,string"`
	// sip_item_price_source is source of sip' price. ( auto or manual).
	SipItemPriceSource string `json:"sip_item_price_source,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemPriceInfo =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemStockInfo added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemStockInfo struct {
	// stock_type is The stock type.
	StockType int `json:"stock_type,omitempty"`
	// stock_location_id is location_id of the stock.
	StockLocationID string `json:"stock_location_id,omitempty"`
	// normal_stock is The normal stock quantity of the variation in the listing currency.
	NormalStock int `json:"normal_stock,omitempty"`
	// reserved_stock is The reserved stock quantity of the variation in the listing currency.
	ReservedStock int `json:"reserved_stock,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemStockInfo =======================================================

type GlobalProductGetGlobalItemInfoGlobalItemVideo added in v1.5.5

type GlobalProductGetGlobalItemInfoGlobalItemVideo struct {
	// video_url is Url of video.
	VideoUrl string `json:"video_url,omitempty"`
	// thumbnail_url is Thumbnail of video.
	ThumbnailUrl string `json:"thumbnail_url,omitempty"`
	// duration is Duration of video.
	Duration int `json:"duration,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemInfoGlobalItemVideo =======================================================

type GlobalProductGetGlobalItemInfoRequest added in v1.5.0

type GlobalProductGetGlobalItemInfoRequest struct {
	V2RequestAuthenticationParams

	// global_item_id_list is Global item id list. Length limit is [1,20].
	GlobalItemIdList []int `json:"global_item_id_list"`
}

======================================================= GlobalProductGetGlobalItemInfoRequest =======================================================

type GlobalProductGetGlobalItemInfoResponse added in v1.5.0

type GlobalProductGetGlobalItemInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetGlobalItemInfo `json:"response"`
}

======================================================= GlobalProductGetGlobalItemInfoResponse =======================================================

type GlobalProductGetGlobalItemLimit added in v1.5.1

type GlobalProductGetGlobalItemLimit struct {
	// price_limit is
	PriceLimit GlobalProductGetGlobalItemLimitPriceLimit `json:"price_limit"`
	// stock_limit is
	StockLimit GlobalProductGetGlobalItemLimitStockLimit `json:"stock_limit"`
	// global_item_name_length_limit is
	GlobalItemNameLengthLimit GlobalProductGetGlobalItemLimitGlobalItemNameLengthLimit `json:"global_item_name_length_limit"`
	// global_item_image_count_limit is
	GlobalItemImageCountLimit GlobalProductGetGlobalItemLimitGlobalItemImageCountLimit `json:"global_item_image_count_limit"`
	// global_item_description_length_limit is
	GlobalItemDescriptionLengthLimit GlobalProductGetGlobalItemLimitGlobalItemDescriptionLengthLimit `json:"global_item_description_length_limit"`
	// tier_variation_name_length_limit is
	TierVariationNameLengthLimit GlobalProductGetGlobalItemLimitTierVariationNameLengthLimit `json:"tier_variation_name_length_limit"`
	// tier_variation_option_length_limit is
	TierVariationOptionLengthLimit GlobalProductGetGlobalItemLimitTierVariationOptionLengthLimit `json:"tier_variation_option_length_limit"`
	// text_length_multiplier is Length ratio of Chinese characters to English characters in parameter verification. len(text)=len(Chinese characters)*text_length_multiplier+len(English characters )
	TextLengthMultiplier float64 `json:"text_length_multiplier,omitempty,string"`
	// extended_description_limit is
	ExtendedDescriptionLimit GlobalProductGetGlobalItemLimitExtendedDescriptionLimit `json:"extended_description_limit"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimit =======================================================

type GlobalProductGetGlobalItemLimitExtendedDescriptionLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitExtendedDescriptionLimit struct {
	// description_text_length_min is length min limit for item extended description text part, when one of the minimum limits for image and text is reached, the item can be added or updated successfully.
	DescriptionTextLengthMin int `json:"description_text_length_min,omitempty"`
	// description_text_length_max is length max limit for item extended description text part
	DescriptionTextLengthMax int `json:"description_text_length_max,omitempty"`
	// description_image_num_min is length min limit for item extended description image num, when one of the minimum limits for image and text is reached, the item can be added or updated successfully.
	DescriptionImageNumMin int `json:"description_image_num_min,omitempty"`
	// description_image_num_max is length max limit for item extended description image num
	DescriptionImageNumMax int `json:"description_image_num_max,omitempty"`
	// description_image_width_min is length min limit for item extended description image width
	DescriptionImageWidthMin int `json:"description_image_width_min,omitempty"`
	// description_image_height_min is length min limit for item extended description image hight
	DescriptionImageHeightMin int `json:"description_image_height_min,omitempty"`
	// description_image_aspect_ratio_min is length min limit for item extended description image aspect (image width / image hight )
	DescriptionImageAspectRatioMin float64 `json:"description_image_aspect_ratio_min,omitempty,string"`
	// description_image_aspect_ratio_max is length max limit for item extended description image aspect (image width / image hight )
	DescriptionImageAspectRatioMax float64 `json:"description_image_aspect_ratio_max,omitempty,string"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitExtendedDescriptionLimit =======================================================

type GlobalProductGetGlobalItemLimitGlobalItemDescriptionLengthLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitGlobalItemDescriptionLengthLimit struct {
	// min_limit is Global item description length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item description length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitGlobalItemDescriptionLengthLimit =======================================================

type GlobalProductGetGlobalItemLimitGlobalItemImageCountLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitGlobalItemImageCountLimit struct {
	// min_limit is Global item image count min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item image count max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitGlobalItemImageCountLimit =======================================================

type GlobalProductGetGlobalItemLimitGlobalItemNameLengthLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitGlobalItemNameLengthLimit struct {
	// min_limit is Global item name length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item name length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitGlobalItemNameLengthLimit =======================================================

type GlobalProductGetGlobalItemLimitPriceLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitPriceLimit struct {
	// min_limit is Global item price min limit.
	MinLimit float64 `json:"min_limit,omitempty,string"`
	// max_limit is Global item price max limit.
	MaxLimit float64 `json:"max_limit,omitempty,string"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitPriceLimit =======================================================

type GlobalProductGetGlobalItemLimitRequest added in v1.5.0

type GlobalProductGetGlobalItemLimitRequest struct {
	V2RequestAuthenticationParams
}

======================================================= GlobalProductGetGlobalItemLimitRequest =======================================================

type GlobalProductGetGlobalItemLimitResponse added in v1.5.0

type GlobalProductGetGlobalItemLimitResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetGlobalItemLimit `json:"response"`
}

======================================================= GlobalProductGetGlobalItemLimitResponse =======================================================

type GlobalProductGetGlobalItemLimitStockLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitStockLimit struct {
	// min_limit is Global item stock min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item stock max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitStockLimit =======================================================

type GlobalProductGetGlobalItemLimitTierVariationNameLengthLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitTierVariationNameLengthLimit struct {
	// min_limit is Global item tier variation name length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item tier variation name length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitTierVariationNameLengthLimit =======================================================

type GlobalProductGetGlobalItemLimitTierVariationOptionLengthLimit added in v1.5.4

type GlobalProductGetGlobalItemLimitTierVariationOptionLengthLimit struct {
	// min_limit is Global item tier variation option length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Global item tier variation option length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemLimitTierVariationOptionLengthLimit =======================================================

type GlobalProductGetGlobalItemList added in v1.5.1

type GlobalProductGetGlobalItemList struct {
	// global_item_list is
	GlobalItemList []GlobalProductGetGlobalItemListGlobalItem `json:"global_item_list"`
	// total_count is Total global item count.
	TotalCount int `json:"total_count,omitempty"`
	// has_next_page is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	HasNextPage bool `json:"has_next_page,omitempty"`
	// offset is If has_next_page is true, this value need set to next request.offset.
	Offset string `json:"offset,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemList =======================================================

type GlobalProductGetGlobalItemListGlobalItem added in v1.5.5

type GlobalProductGetGlobalItemListGlobalItem struct {
	// global_item_id is Shopee's unique identifier for an global item.
	GlobalItemID int `json:"global_item_id,omitempty"`
	// update_time is Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalItemListGlobalItem =======================================================

type GlobalProductGetGlobalItemListRequest added in v1.5.0

type GlobalProductGetGlobalItemListRequest struct {
	V2RequestAuthenticationParams

	// offset is Specifies the starting entry of data to return in the current call. Default is null. if data is more than one page, the offset can be some entry to start next call.
	Offset string `json:"offset,omitempty"`
	// page_size is The size of one page. Limit is [1,50].
	PageSize int `json:"page_size"`
	// update_time_from is The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_from field is the starting date range.
	UpdateTimeFrom int `json:"update_time_from,omitempty"`
	// update_time_to is The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_to field is the ending date range
	UpdateTimeTo int `json:"update_time_to,omitempty"`
}

======================================================= GlobalProductGetGlobalItemListRequest =======================================================

type GlobalProductGetGlobalItemListResponse added in v1.5.0

type GlobalProductGetGlobalItemListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetGlobalItemList `json:"response,omitempty"`
}

======================================================= GlobalProductGetGlobalItemListResponse =======================================================

type GlobalProductGetGlobalModelList added in v1.5.1

type GlobalProductGetGlobalModelList struct {
	// tier_variation is Tier variation information of global item.
	TierVariation []GlobalProductGetGlobalModelListTierVariation `json:"tier_variation"`
	// global_model is Global models.
	GlobalModel []GlobalProductGetGlobalModelListGlobalModel `json:"global_model"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelList =======================================================

type GlobalProductGetGlobalModelListGlobalModel added in v1.5.4

type GlobalProductGetGlobalModelListGlobalModel struct {
	// global_model_id is Id of global model.
	GlobalModelID int `json:"global_model_id,omitempty"`
	// global_model_sku is Sku of global model.
	GlobalModelSku string `json:"global_model_sku,omitempty"`
	// price_info is Price info of global model.
	PriceInfo GlobalProductGetGlobalModelListGlobalModelPriceInfo `json:"price_info"`
	// stock_info is Stock info of global model.
	StockInfo []GlobalProductGetGlobalModelListGlobalModelStockInfo `json:"stock_info"`
	// tier_index is Tier index of global model.
	TierIndex []int `json:"tier_index,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListGlobalModel =======================================================

type GlobalProductGetGlobalModelListGlobalModelPriceInfo added in v1.5.4

type GlobalProductGetGlobalModelListGlobalModelPriceInfo struct {
	// original_price is Original price of global model.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListGlobalModelPriceInfo =======================================================

type GlobalProductGetGlobalModelListGlobalModelStockInfo added in v1.5.4

type GlobalProductGetGlobalModelListGlobalModelStockInfo struct {
	// stock_type is Stock type. "1" means wms on hand, "2" means seller on hand.
	StockType int `json:"stock_type,omitempty"`
	// stock_location_id is Stock location id.
	StockLocationID string `json:"stock_location_id,omitempty"`
	// current_stock is Current stock.
	CurrentStock int `json:"current_stock,omitempty"`
	// normal_stock is Normal stock.
	NormalStock int `json:"normal_stock,omitempty"`
	// reserved_stock is Reserved stock.
	ReservedStock int `json:"reserved_stock,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListGlobalModelStockInfo =======================================================

type GlobalProductGetGlobalModelListRequest added in v1.5.0

type GlobalProductGetGlobalModelListRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is The id of global item.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductGetGlobalModelListRequest =======================================================

type GlobalProductGetGlobalModelListResponse added in v1.5.0

type GlobalProductGetGlobalModelListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetGlobalModelList `json:"response"`
}

======================================================= GlobalProductGetGlobalModelListResponse =======================================================

type GlobalProductGetGlobalModelListTierVariation added in v1.5.4

type GlobalProductGetGlobalModelListTierVariation struct {
	// name is Tier name.
	Name string `json:"name,omitempty"`
	// option_list is Tier option list for corresponding tier name.
	OptionList []GlobalProductGetGlobalModelListTierVariationOption `json:"option_list"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListTierVariation =======================================================

type GlobalProductGetGlobalModelListTierVariationOption added in v1.5.5

type GlobalProductGetGlobalModelListTierVariationOption struct {
	// option is Tier option.
	Option string `json:"option,omitempty"`
	// image is Image information of tier.
	Image GlobalProductGetGlobalModelListTierVariationOptionImage `json:"image"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListTierVariationOption =======================================================

type GlobalProductGetGlobalModelListTierVariationOptionImage added in v1.5.5

type GlobalProductGetGlobalModelListTierVariationOptionImage struct {
	// image_url is Image url.
	ImageUrl string `json:"image_url,omitempty"`
	// image_id is Id of image.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetGlobalModelListTierVariationOptionImage =======================================================

type GlobalProductGetPublishTaskResult added in v1.5.1

type GlobalProductGetPublishTaskResult struct {
	// publish_status is Status of publish task.
	PublishStatus string `json:"publish_status,omitempty"`
	// success is If publish task is successful, this field shows the published results.
	Success GlobalProductGetPublishTaskResultSucces `json:"success"`
	// failed is If publish task is failed, this field shows the failed reason.
	Failed GlobalProductGetPublishTaskResultFailed `json:"failed"`
}

======================================================= Object Raw Type - GlobalProductGetPublishTaskResult =======================================================

type GlobalProductGetPublishTaskResultFailed added in v1.5.4

type GlobalProductGetPublishTaskResultFailed struct {
	// failed_reason is Failed reason.
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetPublishTaskResultFailed =======================================================

type GlobalProductGetPublishTaskResultRequest added in v1.5.0

type GlobalProductGetPublishTaskResultRequest struct {
	V2RequestAuthenticationParams

	// publish_task_id is Id of publish task.
	PublishTaskID int `json:"publish_task_id"`
}

======================================================= GlobalProductGetPublishTaskResultRequest =======================================================

type GlobalProductGetPublishTaskResultResponse added in v1.5.0

type GlobalProductGetPublishTaskResultResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetPublishTaskResult `json:"response"`
}

======================================================= GlobalProductGetPublishTaskResultResponse =======================================================

type GlobalProductGetPublishTaskResultSucces added in v1.5.5

type GlobalProductGetPublishTaskResultSucces struct {
	// region is The region of published item.
	Region string `json:"region,omitempty"`
	// shop_id is The shop id of published item.
	ShopID string `json:"shop_id,omitempty"`
	// item_id is The id of published item.
	ItemID string `json:"item_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetPublishTaskResultSucces =======================================================

type GlobalProductGetPublishableShop added in v1.5.1

type GlobalProductGetPublishableShop struct {
	// publishable_shop is Detail of publishable shops.
	PublishableShop []GlobalProductGetPublishableShopPublishableShop `json:"publishable_shop"`
}

======================================================= Object Raw Type - GlobalProductGetPublishableShop =======================================================

type GlobalProductGetPublishableShopPublishableShop added in v1.5.4

type GlobalProductGetPublishableShopPublishableShop struct {
	// shop_id is Id of publishable shop.
	ShopID int `json:"shop_id,omitempty"`
	// shop_region is Region of published shop.
	ShopRegion string `json:"shop_region,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetPublishableShopPublishableShop =======================================================

type GlobalProductGetPublishableShopRequest added in v1.5.0

type GlobalProductGetPublishableShopRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductGetPublishableShopRequest =======================================================

type GlobalProductGetPublishableShopResponse added in v1.5.0

type GlobalProductGetPublishableShopResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetPublishableShop `json:"response"`
}

======================================================= GlobalProductGetPublishableShopResponse =======================================================

type GlobalProductGetPublishedList added in v1.5.1

type GlobalProductGetPublishedList struct {
	// published_item is Detail of published items.
	PublishedItem []GlobalProductGetPublishedListPublishedItem `json:"published_item"`
}

======================================================= Object Raw Type - GlobalProductGetPublishedList =======================================================

type GlobalProductGetPublishedListPublishedItem added in v1.5.4

type GlobalProductGetPublishedListPublishedItem struct {
	// shop_id is Shop id corresponding to the published item.
	ShopID int `json:"shop_id,omitempty"`
	// shop_region is Region of shop.
	ShopRegion string `json:"shop_region,omitempty"`
	// item_id is Id of published item.
	ItemID int `json:"item_id,omitempty"`
	// item_status is <p>Status of published item.Applicable values: 0.DELETED(Item is deleted by seller himself),1.NORMAL, 2.BANNED,3.REVIEWING,4.INVALID(Shopee Admin deleted),5.INVALID_HIDE(Shopee Admin delete confirmed),6.BLACKLISTED(Offensive_hide),8.NORMAL_UNLIST</p>
	ItemStatus int `json:"item_status,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetPublishedListPublishedItem =======================================================

type GlobalProductGetPublishedListRequest added in v1.5.0

type GlobalProductGetPublishedListRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductGetPublishedListRequest =======================================================

type GlobalProductGetPublishedListResponse added in v1.5.0

type GlobalProductGetPublishedListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetPublishedList `json:"response"`
}

======================================================= GlobalProductGetPublishedListResponse =======================================================

type GlobalProductGetRecommendAttribute added in v1.5.1

type GlobalProductGetRecommendAttribute struct {
	// attribute_list is Attribute info list.
	AttributeList []GlobalProductGetRecommendAttributeAttribute `json:"attribute_list"`
}

======================================================= Object Raw Type - GlobalProductGetRecommendAttribute =======================================================

type GlobalProductGetRecommendAttributeAttribute added in v1.5.5

type GlobalProductGetRecommendAttributeAttribute struct {
	// attribute_id is ID of attribute.
	AttributeID int `json:"attribute_id,omitempty"`
	// attribute_value_list is Value list of this attribute.
	AttributeValueList []GlobalProductGetRecommendAttributeAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - GlobalProductGetRecommendAttributeAttribute =======================================================

type GlobalProductGetRecommendAttributeAttributeAttributeValue added in v1.5.5

type GlobalProductGetRecommendAttributeAttributeAttributeValue struct {
	// value_id is ID of attribute value.
	ValueID int `json:"value_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductGetRecommendAttributeAttributeAttributeValue =======================================================

type GlobalProductGetRecommendAttributeRequest added in v1.5.0

type GlobalProductGetRecommendAttributeRequest struct {
	V2RequestAuthenticationParams

	// global_item_name is Name of item.
	GlobalItemName string `json:"global_item_name"`
	// category_id is ID of category.
	CategoryID int `json:"category_id"`
	// cover_image_id is ID of image.
	CoverImageID string `json:"cover_image_id,omitempty"`
}

======================================================= GlobalProductGetRecommendAttributeRequest =======================================================

type GlobalProductGetRecommendAttributeResponse added in v1.5.0

type GlobalProductGetRecommendAttributeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductGetRecommendAttribute `json:"response,omitempty"`
}

======================================================= GlobalProductGetRecommendAttributeResponse =======================================================

type GlobalProductInitTierVariationRequest added in v1.5.0

type GlobalProductInitTierVariationRequest struct {
	V2RequestAuthenticationParams

	// tier_variation is  Tier variation info list.If you define a one-tier structure, the maximum number of options cannot exceed 50. If you define a two-tier structure, the number of options multiplied by the two tiers cannot exceed 50.
	TierVariation []TierVariation `json:"tier_variation"`
	// global_model is Model info list, model number at most 50
	GlobalModel []GlobalModel `json:"global_model"`
	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductInitTierVariationRequest =======================================================

type GlobalProductInitTierVariationResponse added in v1.5.0

type GlobalProductInitTierVariationResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductInitTierVariationResponse =======================================================

type GlobalProductSetSyncFieldRequest added in v1.5.0

type GlobalProductSetSyncFieldRequest struct {
	V2RequestAuthenticationParams

	// shop_sync_list is Length limit is [1,50].
	ShopSyncList []ShopSyncList `json:"shop_sync_list"`
}

======================================================= GlobalProductSetSyncFieldRequest =======================================================

type GlobalProductSetSyncFieldResponse added in v1.5.0

type GlobalProductSetSyncFieldResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductSetSyncFieldResponse =======================================================

type GlobalProductSupportSizeChart added in v1.5.1

type GlobalProductSupportSizeChart struct {
	// support_size_chart is If category support size chart.
	SupportSizeChart bool `json:"support_size_chart,omitempty"`
}

======================================================= Object Raw Type - GlobalProductSupportSizeChart =======================================================

type GlobalProductSupportSizeChartRequest added in v1.5.0

type GlobalProductSupportSizeChartRequest struct {
	V2RequestAuthenticationParams

	// category_id is Id of category.
	CategoryID int `json:"category_id"`
}

======================================================= GlobalProductSupportSizeChartRequest =======================================================

type GlobalProductSupportSizeChartResponse added in v1.5.0

type GlobalProductSupportSizeChartResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductSupportSizeChart `json:"response"`
}

======================================================= GlobalProductSupportSizeChartResponse =======================================================

type GlobalProductUpdateGlobalItem added in v1.5.1

type GlobalProductUpdateGlobalItem struct {
	// global_item_id is Id of updated global item.
	GlobalItemID int `json:"global_item_id,omitempty"`
}

======================================================= Object Raw Type - GlobalProductUpdateGlobalItem =======================================================

type GlobalProductUpdateGlobalItemRequest added in v1.5.0

type GlobalProductUpdateGlobalItemRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id"`
	// category_id is Category id of global item.
	CategoryID int `json:"category_id,omitempty"`
	// global_item_name is Name of global item.
	GlobalItemName string `json:"global_item_name,omitempty"`
	// description is Description of global item.
	Description string `json:"description,omitempty"`
	// global_item_sku is Sku of global item.
	GlobalItemSku string `json:"global_item_sku,omitempty"`
	// weight is Weight of global item.
	Weight float64 `json:"weight,omitempty,string"`
	// dimension is Dimension information of global item.
	Dimension Dimension `json:"dimension,omitempty"`
	// pre_order is Preorder information of global item.
	PreOrder PreOrder `json:"pre_order,omitempty"`
	// condition is Condition of global item, "NEW" or "USED" is available.
	Condition string `json:"condition,omitempty"`
	// image is Image information of global item.
	Image Image `json:"image,omitempty"`
	// video_upload_id is Video upload id of global item.
	VideoUploadID []string `json:"video_upload_id,omitempty"`
	// brand is
	Brand Brand `json:"brand,omitempty"`
	// attribute_list is Item attributes.
	AttributeList []AttributeList `json:"attribute_list,omitempty"`
	// description_info is New description field. New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo DescriptionInfo `json:"description_info,omitempty"`
	// description_type is Values: See Data Definition- description_type (normal , extended). If you want to use extended_description or change description type ,this field must be inputed
	DescriptionType string `json:"description_type,omitempty"`
}

======================================================= GlobalProductUpdateGlobalItemRequest =======================================================

type GlobalProductUpdateGlobalItemResponse added in v1.5.0

type GlobalProductUpdateGlobalItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response GlobalProductUpdateGlobalItem `json:"response,omitempty"`
}

======================================================= GlobalProductUpdateGlobalItemResponse =======================================================

type GlobalProductUpdateGlobalModelRequest added in v1.5.0

type GlobalProductUpdateGlobalModelRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
	// global_model is Sku setting for global model. Limit is [1,50].
	GlobalModel []GlobalModel `json:"global_model"`
}

======================================================= GlobalProductUpdateGlobalModelRequest =======================================================

type GlobalProductUpdateGlobalModelResponse added in v1.5.0

type GlobalProductUpdateGlobalModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductUpdateGlobalModelResponse =======================================================

type GlobalProductUpdatePriceRequest added in v1.5.0

type GlobalProductUpdatePriceRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
	// price_list is Price setting for global model. Limit is [1,50].
	PriceList []PriceList `json:"price_list"`
}

======================================================= GlobalProductUpdatePriceRequest =======================================================

type GlobalProductUpdatePriceResponse added in v1.5.0

type GlobalProductUpdatePriceResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductUpdatePriceResponse =======================================================

type GlobalProductUpdateSizeChartRequest added in v1.5.0

type GlobalProductUpdateSizeChartRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is Id of global item.
	GlobalItemID int `json:"global_item_id"`
	// size_chart is Image id of size chart.
	SizeChart string `json:"size_chart"`
}

======================================================= GlobalProductUpdateSizeChartRequest =======================================================

type GlobalProductUpdateSizeChartResponse added in v1.5.0

type GlobalProductUpdateSizeChartResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductUpdateSizeChartResponse =======================================================

type GlobalProductUpdateStockRequest added in v1.5.0

type GlobalProductUpdateStockRequest struct {
	V2RequestAuthenticationParams

	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
	// stock_list is Stock setting for global model. Limit is [1,50].
	StockList []StockList `json:"stock_list"`
}

======================================================= GlobalProductUpdateStockRequest =======================================================

type GlobalProductUpdateStockResponse added in v1.5.0

type GlobalProductUpdateStockResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductUpdateStockResponse =======================================================

type GlobalProductUpdateTierVariationRequest added in v1.5.0

type GlobalProductUpdateTierVariationRequest struct {
	V2RequestAuthenticationParams

	// tier_variation is Tier variation info list.If you define a one-tier structure, the maximum number of options cannot exceed 50. If you define a two-tier structure, the number of options multiplied by the two tiers cannot exceed 50.
	TierVariation []TierVariation `json:"tier_variation"`
	// global_item_id is ID of global item.
	GlobalItemID int `json:"global_item_id"`
}

======================================================= GlobalProductUpdateTierVariationRequest =======================================================

type GlobalProductUpdateTierVariationResponse added in v1.5.0

type GlobalProductUpdateTierVariationResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= GlobalProductUpdateTierVariationResponse =======================================================

type Image added in v1.5.0

type Image struct {
	// image_id_list is ID of image
	ImageIdList []string `json:"image_id_list,omitempty"`
}

======================================================= Object Raw Type - Image =======================================================

type InitRequestDropoff

type InitRequestDropoff struct {
	// The identity of branch. Retrieved from shopee.logistics.GetBranch branch.
	BranchID int64 `json:"branch_id,omitempty"`
	// The real name of sender.
	SenderRealName string `json:"sender_real_name,omitempty"`
	// Need input this field when "tracking_no" is returned from "info_need". Please note that this tracking number is assigned by third-party shipping carrier for item shipment.
	TrackingNo string `json:"tracking_no,omitempty"`
}

type InitRequestNonIntegrated

type InitRequestNonIntegrated struct {
	// Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment.
	TrackingNo string `json:"tracking_no,omitempty"`
}

type InitRequestPickup

type InitRequestPickup struct {
	// The identity of address. Retrieved from shopee.logistics.GetAddress.
	AddressID int64 `json:"address_id,omitempty"`
	// The pickup time id. Retrieved from shopee.logistics.GetTimeSlot.
	PickupItemID string `json:"pickup_item_id,omitempty"`
}

type InitTierVariationRequestTierVariation

type InitTierVariationRequestTierVariation struct {
	// Tier variation name.
	Name string `json:"name,omitempty"`
	// Tier variation value options list. Option length should be under 20. Quantity of combinations of all 2 tier options is up to 50.
	Options []string `json:"options,omitempty"`
	// Tier variation images. Can only be applied for the first level options. Urls sequence match the options sequence and urls number cannot exceed options number.
	ImagesURL []string `json:"images_url,omitempty"`
}

type InitTierVariationRequestVariation

type InitTierVariationRequestVariation struct {
	// A list of tier variation combination index, which indicates variation's option position in tier_variation['options'] list. e.g. [0,1] means tier variation 1 option 1 and tier variation 2 option 2.
	TierIndex []int `json:"tier_index,omitempty"`
	// Stock value of this variation item. The original variation stock will be override when calling this API to initialize 2-tier structure for an existed item. 0 stock will make this variation a greyout option for buyer.
	Stock int `json:"stock,omitempty"`
	// Price value of this variation item. The original variation price will be override when calling this API to initialize 2-tier structure for an existed item.
	Price float64 `json:"price,omitempty,string"`
	// SKU string of this variation.SKU length should be under 100.
	VariationSKU string `json:"variation_sku,omitempty"`
}

type InitTierVariationResponseVariation

type InitTierVariationResponseVariation struct {
	// A list of tier variation indexes, which indicate variation's options in tier_variation['options'] list.
	TierIndex []int `json:"tier_index,omitempty"`
	// The identity of the variation.
	VariationID int64 `json:"variation_id,omitempty"`
}

type InvoiceData added in v1.5.0

type InvoiceData struct {
	// number is  The number of the invoice. The number should be 9 digits. pt: número da NF-e.
	Number string `json:"number,omitempty"`
	// series_number is The series number of the invoice. The series number should be 3 digits. pt: série da NF-e.
	SeriesNumber string `json:"series_number,omitempty"`
	// access_key is The access key of the invoice. The access key should be 44 digits. pt: chave de acesso da NF-e.
	AccessKey string `json:"access_key,omitempty"`
	// issue_date is The issue date of the invoice. The issue date should be later than the order pay date. pt: data de emissão da NF-e.
	IssueDate int `json:"issue_date,omitempty"`
	// total_value is The total value of the invoice. pt: valor total da NF-e (R$).
	TotalValue float64 `json:"total_value,omitempty,string"`
	// products_total_value is The products total value of the invoice. pt: valor total dos produtos (R$) da NF-e.
	ProductsTotalValue float64 `json:"products_total_value,omitempty,string"`
	// tax_code is The tax code for the invoice. The tax code should be 4 digits. pt: Código Fiscal de Operações e Prestações (CFOP) predominante na NF-e.
	TaxCode string `json:"tax_code,omitempty"`
}

======================================================= Object Raw Type - InvoiceData =======================================================

type Item added in v1.5.0

type Item struct {
	// item_name is Name of item.
	ItemName string `json:"item_name,omitempty"`
	// description is Description of item.
	Description string `json:"description,omitempty"`
	// item_status is Status of item.
	ItemStatus string `json:"item_status,omitempty"`
	// original_price is <p>Original price of item.</p><p><b><font color="#c24f4a">For&nbsp;SG/MY/BR/MX/PL/ES/AR seller:</font></b>&nbsp;Sellers can set the price with two decimal place,&nbsp;other regions can only set the price as an integer.<br /></p>
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// image is Image information of item.
	Image ItemImage `json:"image,omitempty"`
	// tier_variation is Tier variation information of item.
	TierVariation []ItemTierVariation `json:"tier_variation,omitempty"`
	// model is Model information of item.
	Model []ItemModel `json:"model,omitempty"`
	// size_chart is Size chart of item.
	SizeChart string `json:"size_chart,omitempty"`
	// logistic is Logistic information of item.
	Logistic []ItemLogistic `json:"logistic,omitempty"`
	// pre_order is Preorder information of item.
	PreOrder ItemPreOrder `json:"pre_order,omitempty"`
	// description_info is New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo ItemDescriptionInfo `json:"description_info,omitempty"`
}

======================================================= Object Raw Type - Item =======================================================

type ItemDescriptionInfo added in v1.5.4

type ItemDescriptionInfo struct {
	// extended_description is If description_type is extended , Description information should be set by this field.
	ExtendedDescription ItemDescriptionInfoExtendedDescription `json:"extended_description,omitempty"`
}

======================================================= Object Raw Type - ItemDescriptionInfo =======================================================

type ItemDescriptionInfoExtendedDescription added in v1.5.4

type ItemDescriptionInfoExtendedDescription struct {
	// field_list is Field of extended description.
	FieldList []ItemDescriptionInfoExtendedDescriptionField `json:"field_list,omitempty"`
}

======================================================= Object Raw Type - ItemDescriptionInfoExtendedDescription =======================================================

type ItemDescriptionInfoExtendedDescriptionField added in v1.5.5

type ItemDescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field :values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be set by this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image,image url will be set by this field.
	ImageInfo ItemDescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info,omitempty"`
}

======================================================= Object Raw Type - ItemDescriptionInfoExtendedDescriptionField =======================================================

type ItemDescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type ItemDescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - ItemDescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type ItemImage added in v1.5.4

type ItemImage struct {
	// image_id_list is Image id list of item.
	ImageIdList []string `json:"image_id_list,omitempty"`
}

======================================================= Object Raw Type - ItemImage =======================================================

type ItemList added in v1.5.1

type ItemList struct {
	// item_id is Shopee's unique identifier for an item
	ItemID int `json:"item_id,omitempty"`
	// unlist is Unlist or not
	Unlist bool `json:"unlist,omitempty"`
}

======================================================= Object Raw Type - ItemList =======================================================

type ItemLogistic added in v1.5.4

type ItemLogistic struct {
	// logistic_id is Logistic id.
	LogisticID int `json:"logistic_id,omitempty"`
	// enabled is If this logistic channel is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// shipping_fee is Shipping fee.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// size_id is Size id.
	SizeID int `json:"size_id,omitempty"`
	// is_free is If this logistic channel is free.
	IsFree bool `json:"is_free,omitempty"`
}

======================================================= Object Raw Type - ItemLogistic =======================================================

type ItemModel added in v1.5.4

type ItemModel struct {
	// tier_index is Tier index of model.
	TierIndex []int `json:"tier_index,omitempty"`
	// original_price is Original price of model.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - ItemModel =======================================================

type ItemPreOrder added in v1.5.4

type ItemPreOrder struct {
	// is_pre_order is If this item is preorder.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
	// days_to_ship is Days to ship, it's mandatory if is_pre_order is true.
	DaysToShip int `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - ItemPreOrder =======================================================

type ItemTierVariation added in v1.5.4

type ItemTierVariation struct {
	// name is Tier name.
	Name string `json:"name,omitempty"`
	// option_list is Tier option list.
	OptionList []ItemTierVariationOption `json:"option_list"`
}

======================================================= Object Raw Type - ItemTierVariation =======================================================

type ItemTierVariationOption added in v1.5.5

type ItemTierVariationOption struct {
	// option is Tier option.
	Option string `json:"option,omitempty"`
	// image is Image information for tier.
	Image ItemTierVariationOptionImage `json:"image,omitempty"`
}

======================================================= Object Raw Type - ItemTierVariationOption =======================================================

type ItemTierVariationOptionImage added in v1.5.5

type ItemTierVariationOptionImage struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - ItemTierVariationOptionImage =======================================================

type LogisticInfo added in v1.5.1

type LogisticInfo struct {
	// size_id is Size ID, If specify logistic fee_type is SIZE_SELECTION size_id is required.
	SizeID int `json:"size_id,omitempty"`
	// shipping_fee is Shipping fee, Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// enabled is Whether channel is enabled for this item
	Enabled bool `json:"enabled,omitempty"`
	// logistic_id is ID of the channel
	LogisticID int `json:"logistic_id,omitempty"`
	// is_free is Whether cover shipping fee for buyer
	IsFree bool `json:"is_free,omitempty"`
}

======================================================= Object Raw Type - LogisticInfo =======================================================

type LogisticsBatchShipOrder added in v1.5.1

type LogisticsBatchShipOrder struct {
	// result_list is
	ResultList []LogisticsBatchShipOrderResult `json:"result_list"`
}

======================================================= Object Raw Type - LogisticsBatchShipOrder =======================================================

type LogisticsBatchShipOrderRequest added in v1.5.0

type LogisticsBatchShipOrderRequest struct {
	V2RequestAuthenticationParams

	// order_list is The list of order.
	OrderList []OrderList `json:"order_list"`
	// pickup is Required parameter ONLY if GetParameterForInit returns "pickup" or if GetLogisticsInfo returns "pickup" under "info_needed" for the same order. Developer should still include "pickup" field in the call even if "pickup" has empty value.
	Pickup *Pickup `json:"pickup,omitempty"`
	// dropoff is Required parameter ONLY if GetParameterForInit returns "dropoff" or if GetLogisticsInfo returns "dropoff" under "info_needed" for the same order. Developer should still include "dropoff" field in the call even if "dropoff" has empty value. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use "tracking_no" to call Init API. If you choose JOB shipping method, please use "sender_real_name" to call Init API. Note that only one of "tracking_no" and "sender_real_name" can be selected.
	Dropoff *Dropoff `json:"dropoff,omitempty"`
	// non_integrated is Optional parameter when GetParameterForInit returns "non-integrated" or GetLogisticsInfo returns "non-integrated" under "info_needed".
	NonIntegrated *NonIntegrated `json:"non_integrated,omitempty"`
}

======================================================= LogisticsBatchShipOrderRequest =======================================================

type LogisticsBatchShipOrderResponse added in v1.5.0

type LogisticsBatchShipOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response LogisticsBatchShipOrder `json:"response,omitempty"`
}

======================================================= LogisticsBatchShipOrderResponse =======================================================

type LogisticsBatchShipOrderResult added in v1.5.5

type LogisticsBatchShipOrderResult struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - LogisticsBatchShipOrderResult =======================================================

type LogisticsCreateShippingDocument added in v1.5.1

type LogisticsCreateShippingDocument struct {
	// result_list is The list of the result data.
	ResultList []LogisticsCreateShippingDocumentResult `json:"result_list"`
}

======================================================= Object Raw Type - LogisticsCreateShippingDocument =======================================================

type LogisticsCreateShippingDocumentOrderList added in v1.6.10

type LogisticsCreateShippingDocumentOrderList struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
	PackageNumber string `json:"package_number,omitempty"`
	// The tracking number of order. Required except for the channel allow print before arrange shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// The type of shipping document. Available values: NORMAL_AIR_WAYBILL,THERMAL_AIR_WAYBILL,NORMAL_JOB_AIR_WAYBILL,THERMAL_JOB_AIR_WAYBILL
	ShippingDocumentType string `json:"shipping_document_type,omitempty"`
}

type LogisticsCreateShippingDocumentRequest added in v1.5.0

type LogisticsCreateShippingDocumentRequest struct {
	V2RequestAuthenticationParams

	// order_list is The list of order you want to create shipping document. limit [1, 50]
	OrderList []LogisticsCreateShippingDocumentOrderList `json:"order_list"`
}

======================================================= LogisticsCreateShippingDocumentRequest =======================================================

type LogisticsCreateShippingDocumentResponse added in v1.5.0

type LogisticsCreateShippingDocumentResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsCreateShippingDocument `json:"response"`
}

======================================================= LogisticsCreateShippingDocumentResponse =======================================================

type LogisticsCreateShippingDocumentResult added in v1.5.5

type LogisticsCreateShippingDocumentResult struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - LogisticsCreateShippingDocumentResult =======================================================

type LogisticsDeleteAddressRequest added in v1.5.0

type LogisticsDeleteAddressRequest struct {
	V2RequestAuthenticationParams

	// address_id is The identity of address you want to delete.
	AddressID int `json:"address_id"`
}

======================================================= LogisticsDeleteAddressRequest =======================================================

type LogisticsDeleteAddressResponse added in v1.5.0

type LogisticsDeleteAddressResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= LogisticsDeleteAddressResponse =======================================================

type LogisticsDownloadShippingDocumentRequest added in v1.5.0

type LogisticsDownloadShippingDocumentRequest struct {
	V2RequestAuthenticationParams

	// shipping_document_type is The type of shipping document. Available values: NORMAL_AIR_WAYBILL,THERMAL_AIR_WAYBILL,NORMAL_JOB_AIR_WAYBILL,THERMAL_JOB_AIR_WAYBILL
	ShippingDocumentType string `json:"shipping_document_type,omitempty"`
	// order_list is The list of orders you need to download it's shipping document.
	OrderList []OrderList `json:"order_list"`
}

======================================================= LogisticsDownloadShippingDocumentRequest =======================================================

type LogisticsDownloadShippingDocumentResponse added in v1.5.0

type LogisticsDownloadShippingDocumentResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= LogisticsDownloadShippingDocumentResponse =======================================================

type LogisticsGetAddressList added in v1.5.1

type LogisticsGetAddressList struct {
	// show_pickup_address is Show pickup address or not.
	ShowPickupAddress bool `json:"show_pickup_address,omitempty"`
	// address_list is The address list of you shop
	AddressList []LogisticsGetAddressListAddress `json:"address_list"`
}

======================================================= Object Raw Type - LogisticsGetAddressList =======================================================

type LogisticsGetAddressListAddress added in v1.5.5

type LogisticsGetAddressListAddress struct {
	// address_id is The identity of address.
	AddressID int `json:"address_id,omitempty"`
	// region is The region of specify address.
	Region string `json:"region,omitempty"`
	// state is The state of specify address.
	State string `json:"state,omitempty"`
	// city is The city of specify address.
	City string `json:"city,omitempty"`
	// address is The address description of specify address.
	Address string `json:"address,omitempty"`
	// zipcode is The zipcode of specify address.
	Zipcode string `json:"zipcode,omitempty"`
	// district is The district of specify address.
	District string `json:"district,omitempty"`
	// town is The town of specify address.
	Town string `json:"town,omitempty"`
	// address_type is The flag of shop address.Available values: DEFAULT_ADDRESS, PICK_UP_ADDRESS, RETURN_ADDRESS.
	AddressType []string `json:"address_type,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetAddressListAddress =======================================================

type LogisticsGetAddressListRequest added in v1.5.0

type LogisticsGetAddressListRequest struct {
	V2RequestAuthenticationParams
}

======================================================= LogisticsGetAddressListRequest =======================================================

type LogisticsGetAddressListResponse added in v1.5.0

type LogisticsGetAddressListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetAddressList `json:"response,omitempty"`
}

======================================================= LogisticsGetAddressListResponse =======================================================

type LogisticsGetChannelList added in v1.5.1

type LogisticsGetChannelList struct {
	// logistics_channel_list is The list of logistics channel.
	LogisticsChannelList []LogisticsGetChannelListLogisticsChannel `json:"logistics_channel_list"`
}

======================================================= Object Raw Type - LogisticsGetChannelList =======================================================

type LogisticsGetChannelListLogisticsChannel added in v1.5.5

type LogisticsGetChannelListLogisticsChannel struct {
	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id,omitempty"`
	// preferred is Whether to make this logistic channel preferred. Indonestia logistics channel are not applicable.
	Preferred bool `json:"preferred,omitempty"`
	// logistics_channel_name is The name of logistic channel.
	LogisticsChannelName string `json:"logistics_channel_name,omitempty"`
	// cod_enabled is This is to indicate whether this logistic channel supports COD
	CodEnabled bool `json:"cod_enabled,omitempty"`
	// enabled is Whether this logistic channel is enabled on shop level.
	Enabled bool `json:"enabled,omitempty"`
	// fee_type is See define FeeType, related to FeeType Value
	FeeType string `json:"fee_type,omitempty"`
	// size_list is Only for fee_type is SIZE_SELECTION
	SizeList []LogisticsGetChannelListLogisticsChannelSize `json:"size_list"`
	// weight_limit is The weight limit for this logistic channel.
	WeightLimit LogisticsGetChannelListLogisticsChannelWeightLimit `json:"weight_limit"`
	// item_max_dimension is The dimension limit for this logistic channel.
	ItemMaxDimension LogisticsGetChannelListLogisticsChannelItemMaxDimension `json:"item_max_dimension"`
	// volume_limit is The limit of item volume.
	VolumeLimit LogisticsGetChannelListLogisticsChannelVolumeLimit `json:"volume_limit"`
	// logistics_description is For checkout channels, this field indicates its corresponding fulfillment channels.
	LogisticsDescription string `json:"logistics_description,omitempty"`
	// force_enable is Indicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel.
	ForceEnable bool `json:"force_enable,omitempty"`
	// mask_channel_id is Indicate the parent logistic channel ID. If it’s 0, it indicates the channel is a checkout(masked) channel; if it’s not 0, indicate the channel is a fulfillment channel and has a checkout channel(checkout channel’s channel_id equals this mask_channel_id) on top of it. Multiple channels may share the same mask_channel_id.
	MaskChannelID int `json:"mask_channel_id,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetChannelListLogisticsChannel =======================================================

type LogisticsGetChannelListLogisticsChannelItemMaxDimension added in v1.5.5

type LogisticsGetChannelListLogisticsChannelItemMaxDimension struct {
	// height is The max height limit.
	Height float64 `json:"height,omitempty,string"`
	// width is The max width limit.
	Width float64 `json:"width,omitempty,string"`
	// length is The max length limit.
	Length float64 `json:"length,omitempty,string"`
	// unit is The unit for the limit.
	Unit string `json:"unit,omitempty"`
	// dimension_sum is The sum of the item's dimension
	DimensionSum float64 `json:"dimension_sum,omitempty,string"`
}

======================================================= Object Raw Type - LogisticsGetChannelListLogisticsChannelItemMaxDimension =======================================================

type LogisticsGetChannelListLogisticsChannelSize added in v1.5.5

type LogisticsGetChannelListLogisticsChannelSize struct {
	// size_id is The identity of size.
	SizeID string `json:"size_id,omitempty"`
	// name is The name of size.
	Name string `json:"name,omitempty"`
	// default_price is The pre-defined shipping fee for the specific size.
	DefaultPrice float64 `json:"default_price,omitempty,string"`
}

======================================================= Object Raw Type - LogisticsGetChannelListLogisticsChannelSize =======================================================

type LogisticsGetChannelListLogisticsChannelVolumeLimit added in v1.5.5

type LogisticsGetChannelListLogisticsChannelVolumeLimit struct {
	// item_max_volume is The max volume for an item on this logistic channel.If the value is 0 or null, that means there is no limit for the item weight.
	ItemMaxVolume float64 `json:"item_max_volume,omitempty,string"`
	// item_min_volume is The min volume for an item on this logistic channel. If the value is 0 or null, that means there is no limit for the item weight.
	ItemMinVolume float64 `json:"item_min_volume,omitempty,string"`
}

======================================================= Object Raw Type - LogisticsGetChannelListLogisticsChannelVolumeLimit =======================================================

type LogisticsGetChannelListLogisticsChannelWeightLimit added in v1.5.5

type LogisticsGetChannelListLogisticsChannelWeightLimit struct {
	// item_max_weight is The max weight for an item on this logistic channel.If the value is 0 or null, that means there is no limit.
	ItemMaxWeight float64 `json:"item_max_weight,omitempty,string"`
	// item_min_weight is The min weight for an item on this logistic channel. If the value is 0 or null, that means there is no limit.
	ItemMinWeight float64 `json:"item_min_weight,omitempty,string"`
}

======================================================= Object Raw Type - LogisticsGetChannelListLogisticsChannelWeightLimit =======================================================

type LogisticsGetChannelListRequest added in v1.5.0

type LogisticsGetChannelListRequest struct {
	V2RequestAuthenticationParams
}

======================================================= LogisticsGetChannelListRequest =======================================================

type LogisticsGetChannelListResponse added in v1.5.0

type LogisticsGetChannelListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetChannelList `json:"response"`
}

======================================================= LogisticsGetChannelListResponse =======================================================

type LogisticsGetShippingDocumentInfo added in v1.5.1

type LogisticsGetShippingDocumentInfo struct {
	// shipping_document_info is The shipping document info of this order.
	ShippingDocumentInfo LogisticsGetShippingDocumentInfoShippingDocumentInfo `json:"shipping_document_info"`
	// cod_amount is Use this field to indicate cod amount.
	CodAmount string `json:"cod_amount,omitempty"`
	// order_weight is Use this field to indicate order weight when calculate the shipping fee. The unit of weigh is gram.
	OrderWeight string `json:"order_weight,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfo =======================================================

type LogisticsGetShippingDocumentInfoRequest added in v1.5.0

type LogisticsGetShippingDocumentInfoRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_number is Shopee's unique identifier for the package under an order. You shouldn't fill the field with empty string when there isn't a package number.
	PackageNumber string `json:"package_number,omitempty"`
}

======================================================= LogisticsGetShippingDocumentInfoRequest =======================================================

type LogisticsGetShippingDocumentInfoResponse added in v1.5.0

type LogisticsGetShippingDocumentInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetShippingDocumentInfo `json:"response,omitempty"`
}

======================================================= LogisticsGetShippingDocumentInfoResponse =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfo added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfo struct {
	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id,omitempty"`
	// shipping_carrier is The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// service_code is Only work for cross-border order. This code is required at some sorting hub. Please ensure the service_code is INCLUDED on your shipping label, otherwise the parcel cannot be processed by the warehouse. If you didn't retrieve service_code after you first called this API, please try few more times within 30 minutes.
	ServiceCode string `json:"service_code,omitempty"`
	// first_mile_name is Only work for cross-border order.The name of the carrier ships cross countries.
	FirstMileName string `json:"first_mile_name,omitempty"`
	// last_mile_name is Only work for cross-border order.The name of the carrier delivers the parcels in local country.
	LastMileName string `json:"last_mile_name,omitempty"`
	// goods_to_declare is Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
	GoodsToDeclare bool `json:"goods_to_declare,omitempty"`
	// tracking_number is The tracking number assigned by the shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// zone is The zone of this order.
	Zone string `json:"zone,omitempty"`
	// lane_code is Only work for cross-border order. The string use for waybill printing. The format is "S - country_code and lane_number". For example, S-TH01, S-TH02
	LaneCode string `json:"lane_code,omitempty"`
	// warehouse_address is Only work for cross-border order in some special shop. The address info of the warehouse.
	WarehouseAddress string `json:"warehouse_address,omitempty"`
	// warehouse_id is Only work for cross-border order in some special shop. The ID of the warehouse.
	WarehouseID string `json:"warehouse_id,omitempty"`
	// recipient_address is This object contains detailed breakdown for the recipient address.
	RecipientAddress LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientAddres `json:"recipient_address"`
	// cod is This value indicates whether the order was a COD (cash on delivery) order.
	Cod bool `json:"cod,omitempty"`
	// recipient_sort_code is The sort_code of recipient.
	RecipientSortCode LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientSortCode `json:"recipient_sort_code"`
	// sender_sort_code is The sort_code of sender.
	SenderSortCode LogisticsGetShippingDocumentInfoShippingDocumentInfoSenderSortCode `json:"sender_sort_code"`
	// third_party_logistic_info is Only used for local TW sellers.
	ThirdPartyLogisticInfo LogisticsGetShippingDocumentInfoShippingDocumentInfoThirdPartyLogisticInfo `json:"third_party_logistic_info"`
	// buyer_cpf_id is Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
	BuyerCpfID string `json:"buyer_cpf_id,omitempty"`
	// shopee_tracking_number is First mile tracking NO. for CrossBoard BR seller can be used to self-design CB Brazil AWB.
	ShopeeTrackingNumber string `json:"shopee_tracking_number,omitempty"`
	// last_mile_tracking_number is The last-mile tracking number. Only for Cross Board BR seller.
	LastMileTrackingNumber string `json:"last_mile_tracking_number,omitempty"`
	// pickup_hub is The name of pickup hub.
	PickupHub string `json:"pickup_hub,omitempty"`
	// delivery_hub is The name of delivery hub.
	DeliveryHub string `json:"delivery_hub,omitempty"`
	// ec_order_no is The name of ec order.
	EcOrderNo string `json:"ec_order_no,omitempty"`
	// create_date_ymd_sl is The date of create shipment order.
	CreateDateYmdSl string `json:"create_date_ymd_sl,omitempty"`
	// manufacturers_name is The name of manufacturer.
	ManufacturersName string `json:"manufacturers_name,omitempty"`
	// manufacturers_website is The website of manufacturer.
	ManufacturersWebsite string `json:"manufacturers_website,omitempty"`
	// is_lm_dg_bool is Use this field to indicate order contains dangerous goods or not.
	IsLmDgBool string `json:"is_lm_dg_bool,omitempty"`
	// preferred_delivery_option is Use this field to indicate delivery address is residential or office address. if "preferred_delivery_option":2, it's Home,  ”preferred_delivery_option“:1, it's Office
	PreferredDeliveryOption string `json:"preferred_delivery_option,omitempty"`
	// return_sort_code is The sort code for 3PL doing RTS.
	ReturnSortCode LogisticsGetShippingDocumentInfoShippingDocumentInfoReturnSortCode `json:"return_sort_code"`
	// spx_sub_district is The sub-district of recipient's address.
	SpxSubDistrict string `json:"spx_sub_district,omitempty"`
	// recipient_addr is Full address of recipient.
	RecipientAddr string `json:"recipient_addr,omitempty"`
	// deliver_area is Zone name.
	DeliverArea string `json:"deliver_area,omitempty"`
	// spx_receive_station is The spx receive station.
	SpxReceiveStation LogisticsGetShippingDocumentInfoShippingDocumentInfoSpxReceiveStation `json:"spx_receive_station"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfo =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientAddres added in v1.5.5

type LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientAddres struct {
	// name is Recipient's name for the address.
	Name string `json:"name,omitempty"`
	// phone is Recipient's phone number input when order was placed.
	Phone string `json:"phone,omitempty"`
	// town is The town of the recipient's address. Whether there is a town will depend on the region and/or country.
	Town string `json:"town,omitempty"`
	// district is The district of the recipient's address. Whether there is a town will depend on the region and/or country.
	District string `json:"district,omitempty"`
	// city is The city of the recipient's address. Whether there is a town will depend on the region and/or country.
	City string `json:"city,omitempty"`
	// state is The state/province of the recipient's address. Whether there is a town will depend on the region and/or country.
	State string `json:"state,omitempty"`
	// region is The two-digit code representing the country of the Recipient.
	Region string `json:"region,omitempty"`
	// zipcode is Recipient's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// full_address is The full address of the recipient, including country, state, even street, and etc.
	FullAddress string `json:"full_address,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientAddres =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientSortCode added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientSortCode struct {
	// first_recipient_sort_code is The first-level sort_code of recipient.
	FirstRecipientSortCode string `json:"first_recipient_sort_code,omitempty"`
	// second_recipient_sort_code is The second-level sort_code of recipient.
	SecondRecipientSortCode string `json:"second_recipient_sort_code,omitempty"`
	// third_recipient_sort_code is The third-level sort_code of recipient.
	ThirdRecipientSortCode string `json:"third_recipient_sort_code,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoRecipientSortCode =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoReturnSortCode added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfoReturnSortCode struct {
	// return_first_sort_code is The first-level sort code for 3PL doing RTS.
	ReturnFirstSortCode string `json:"return_first_sort_code,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoReturnSortCode =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoSenderSortCode added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfoSenderSortCode struct {
	// first_sender_sort_code is The first-level sort_code of sender.
	FirstSenderSortCode string `json:"first_sender_sort_code,omitempty"`
	// second_sender_sort_code is The second-level sort_code of sender.
	SecondSenderSortCode string `json:"second_sender_sort_code,omitempty"`
	// third_sender_sort_code is The third-level sort_code of sender.
	ThirdSenderSortCode string `json:"third_sender_sort_code,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoSenderSortCode =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoSpxReceiveStation added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfoSpxReceiveStation struct {
	// spx_first_receive_station is The first pickup station.
	SpxFirstReceiveStation string `json:"spx_first_receive_station,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoSpxReceiveStation =======================================================

type LogisticsGetShippingDocumentInfoShippingDocumentInfoThirdPartyLogisticInfo added in v1.5.4

type LogisticsGetShippingDocumentInfoShippingDocumentInfoThirdPartyLogisticInfo struct {
	// service_description is Use this field to indicate the order category.
	ServiceDescription string `json:"service_description,omitempty"`
	// barcode is The manufacturer barcode.
	Barcode string `json:"barcode,omitempty"`
	// purchase_time is The purchase_time of the store.
	PurchaseTime string `json:"purchase_time,omitempty"`
	// return_time is The return_time of the store.
	ReturnTime string `json:"return_time,omitempty"`
	// manufacturers_name is The name of manufacturers.
	ManufacturersName string `json:"manufacturers_name,omitempty"`
	// manufacturers_website is The website of manufacturers.
	ManufacturersWebsite string `json:"manufacturers_website,omitempty"`
	// recipient_area is The identification of recipient area.
	RecipientArea string `json:"recipient_area,omitempty"`
	// route_step is The route code of the waybill.
	RouteStep string `json:"route_step,omitempty"`
	// suda5_code is The tally code of the waybill.
	Suda5Code string `json:"suda5_code,omitempty"`
	// large_logistics_id is The code of large logistics.
	LargeLogisticsID string `json:"large_logistics_id,omitempty"`
	// parent_id is The parent code of the waybill.
	ParentID string `json:"parent_id,omitempty"`
	// return_cycle is Use this field to indicate the return cycle.
	ReturnCycle string `json:"return_cycle,omitempty"`
	// return_mode is Use this field to indicate the return mode.
	ReturnMode string `json:"return_mode,omitempty"`
	// prompt is The reminder of stork work.
	Prompt string `json:"prompt,omitempty"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// qrcode is The QR code of the waybill.
	Qrcode string `json:"qrcode,omitempty"`
	// ec_supplier_name is The supplier name of channel.
	EcSupplierName string `json:"ec_supplier_name,omitempty"`
	// ec_bar_code16 is Use this field to indicate the first barcode.
	EcBarCode16 string `json:"ec_bar_code16,omitempty"`
	// equipment_id is The device code.
	EquipmentID string `json:"equipment_id,omitempty"`
	// eshop_id is The child code for B2C Family-mart.
	EshopID string `json:"eshop_id,omitempty"`
	// ec_bar_code9 is Use this field to indicate the pick barcode.
	EcBarCode9 string `json:"ec_bar_code9,omitempty"`
	// pelican_tracking_no is The tracking number of Shopee Delivery.
	PelicanTrackingNo string `json:"pelican_tracking_no,omitempty"`
	// print_date is The date of printing the wayBill.
	PrintDate string `json:"print_date,omitempty"`
	// pzip is The sort code of the order.
	Pzip string `json:"pzip,omitempty"`
	// pzip_c is The barcode of the sort code.
	PzipC string `json:"pzip_c,omitempty"`
	// deliver_area_txt is The code of the delivery area.
	DeliverAreaTxt string `json:"deliver_area_txt,omitempty"`
	// deliver_date_ymd is Expected delivery date of the order.
	DeliverDateYmd string `json:"deliver_date_ymd,omitempty"`
	// sd_driver_code is Lorry driver code of the order.
	SdDriverCode string `json:"sd_driver_code,omitempty"`
	// md_driver_code is Motorcycle driver code of the order.
	MdDriverCode string `json:"md_driver_code,omitempty"`
	// putorder_stackzone_code is Stacking area of the order.
	PutorderStackzoneCode string `json:"putorder_stackzone_code,omitempty"`
	// customer_code is  The cutomer code of Shopee.
	CustomerCode string `json:"customer_code,omitempty"`
	// deliver_router is Use this field to indicate the delivery router.
	DeliverRouter string `json:"deliver_router,omitempty"`
	// store_type is Use this field to indicate the store type.
	StoreType string `json:"store_type,omitempty"`
	// pick_router is Use this field to indicate the pick router.
	PickRouter string `json:"pick_router,omitempty"`
	// barcode_dc is The main logistic barcode of the waybill.
	BarcodeDc string `json:"barcode_dc,omitempty"`
	// ec_order_number is Use this field to indicate the logistics order number.
	EcOrderNumber string `json:"ec_order_number,omitempty"`
	// barcode_pr is The sorting barcode of the waybill.
	BarcodePr string `json:"barcode_pr,omitempty"`
	// first_pick_barcode is The first pick barcode of the waybill.
	FirstPickBarcode string `json:"first_pick_barcode,omitempty"`
	// second_pick_barcode is The second pick barcode of the waybill.
	SecondPickBarcode string `json:"second_pick_barcode,omitempty"`
	// is_cod_bool is Use this field to indicate the service type.
	IsCodBool string `json:"is_cod_bool,omitempty"`
	// receiver_name is Use this field to indicate the receiver name.
	ReceiverName string `json:"receiver_name,omitempty"`
	// rcv_store_name is Use this field to indicate the receiver store name.
	RcvStoreName string `json:"rcv_store_name,omitempty"`
	// branch_code is Use this field indicates destination service point code.
	BranchCode string `json:"branch_code,omitempty"`
	// branch_name is Use this field indicates destination service point name.
	BranchName string `json:"branch_name,omitempty"`
	// last_third_digits_recipient_phone is Use this field indicates buyer phone number (last 3 digits).
	LastThirdDigitsRecipientPhone string `json:"last_third_digits_recipient_phone,omitempty"`
	// last_third_digits_sender_phone is Use this field indicates seller phone number (last 3 digits).
	LastThirdDigitsSenderPhone string `json:"last_third_digits_sender_phone,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentInfoShippingDocumentInfoThirdPartyLogisticInfo =======================================================

type LogisticsGetShippingDocumentParameter added in v1.5.1

type LogisticsGetShippingDocumentParameter struct {
	// result_list is The list of the result data.
	ResultList []LogisticsGetShippingDocumentParameterResult `json:"result_list"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentParameter =======================================================

type LogisticsGetShippingDocumentParameterRequest added in v1.5.0

type LogisticsGetShippingDocumentParameterRequest struct {
	V2RequestAuthenticationParams

	// order_list is The list of orders you want to get. limit [1,50]
	OrderList []OrderList `json:"order_list"`
}

======================================================= LogisticsGetShippingDocumentParameterRequest =======================================================

type LogisticsGetShippingDocumentParameterResponse added in v1.5.0

type LogisticsGetShippingDocumentParameterResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetShippingDocumentParameter `json:"response"`
}

======================================================= LogisticsGetShippingDocumentParameterResponse =======================================================

type LogisticsGetShippingDocumentParameterResult added in v1.5.5

type LogisticsGetShippingDocumentParameterResult struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// suggest_shipping_document_type is The shipping document type Shopee suggests. If you don't select any shipping document type, Shopee will use this as default shipping document type.
	SuggestShippingDocumentType string `json:"suggest_shipping_document_type,omitempty"`
	// selectable_shipping_document_type is The shipping document type you can select of this order.
	SelectableShippingDocumentType []string `json:"selectable_shipping_document_type,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentParameterResult =======================================================

type LogisticsGetShippingDocumentResult added in v1.5.1

type LogisticsGetShippingDocumentResult struct {
	// result_list is The result data list of the API response.
	ResultList []LogisticsGetShippingDocumentResultResult `json:"result_list"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentResult =======================================================

type LogisticsGetShippingDocumentResultRequest added in v1.5.0

type LogisticsGetShippingDocumentResultRequest struct {
	V2RequestAuthenticationParams

	// order_list is The list of orders, limit [1,50]
	OrderList []OrderList `json:"order_list"`
}

======================================================= LogisticsGetShippingDocumentResultRequest =======================================================

type LogisticsGetShippingDocumentResultResponse added in v1.5.0

type LogisticsGetShippingDocumentResultResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetShippingDocumentResult `json:"response"`
}

======================================================= LogisticsGetShippingDocumentResultResponse =======================================================

type LogisticsGetShippingDocumentResultResult added in v1.5.5

type LogisticsGetShippingDocumentResultResult struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// status is The status of the shipping document task you querying with order_sn. Available values: READY, FAILED, PROCESSING
	Status string `json:"status,omitempty"`
	// fail_error is Indicate error type if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error details if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingDocumentResultResult =======================================================

type LogisticsGetShippingParameter added in v1.5.1

type LogisticsGetShippingParameter struct {
	// info_needed is The parameters required based on each specific order to Init. Must use the fields included under info_needed to call Init. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use "tracking_no" to call Init API. If you choose JOB shipping method, please use "sender_real_name" to call Init API. Note that only one of "tracking_no" and "sender_real_name" can be selected.
	InfoNeeded LogisticsGetShippingParameterInfoNeeded `json:"info_needed"`
	// dropoff is Logistics information for dropoff mode order.
	Dropoff LogisticsGetShippingParameterDropoff `json:"dropoff"`
	// pickup is Logistics information for pickup mode order.
	Pickup LogisticsGetShippingParameterPickup `json:"pickup"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameter =======================================================

type LogisticsGetShippingParameterDropoff added in v1.5.4

type LogisticsGetShippingParameterDropoff struct {
	// branch_list is List of available dropoff branches info.
	BranchList []LogisticsGetShippingParameterDropoffBranch `json:"branch_list"`
	// slug_list is  List of available TW 3PL drop-off partners.
	SlugList []LogisticsGetShippingParameterDropoffSlug `json:"slug_list"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterDropoff =======================================================

type LogisticsGetShippingParameterDropoffBranch added in v1.5.5

type LogisticsGetShippingParameterDropoffBranch struct {
	// branch_id is The identity of logistics branch.
	BranchID int `json:"branch_id,omitempty"`
	// region is The region of specify address.
	Region string `json:"region,omitempty"`
	// state is The state of specify address.
	State string `json:"state,omitempty"`
	// city is The city of specify address.
	City string `json:"city,omitempty"`
	// address is The address description of specify address.
	Address string `json:"address,omitempty"`
	// zipcode is The zipcode of specify address.
	Zipcode string `json:"zipcode,omitempty"`
	// district is The district of specify address.
	District string `json:"district,omitempty"`
	// town is The town of specify address.
	Town string `json:"town,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterDropoffBranch =======================================================

type LogisticsGetShippingParameterDropoffSlug added in v1.5.5

type LogisticsGetShippingParameterDropoffSlug struct {
	// slug is  The identity of slug.
	Slug string `json:"slug,omitempty"`
	// slug_name is  The name of slug.
	SlugName string `json:"slug_name,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterDropoffSlug =======================================================

type LogisticsGetShippingParameterInfoNeeded added in v1.5.4

type LogisticsGetShippingParameterInfoNeeded struct {
	// dropoff is Could contain 'branch_id', 'sender_real_name' or 'tracking_no'. If it contains 'branch_id', choose one to Init. If it contains 'sender_real_name' or 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include "dropoff" field in Init API.Could contain 'slug'.If it contains 'slug', to return selected 3PL partner only for TW C2C sellers to drop-off parcels with.
	Dropoff []string `json:"dropoff,omitempty"`
	// pickup is Could contain 'address_id' and 'pickup_time_id'. Choose one address_id and its corresponding pickup_time_id to Init. If it has empty value, developer should still include "pickup" field in Init API.
	Pickup []string `json:"pickup,omitempty"`
	// non_integrated is Could contain 'tracking_no'. If it contains 'tracking_no', should manually input these values in Init API. If it has empty value, developer should still include "non-integrated" field in Init API.
	NonIntegrated []string `json:"non_integrated,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterInfoNeeded =======================================================

type LogisticsGetShippingParameterPickup added in v1.5.4

type LogisticsGetShippingParameterPickup struct {
	// address_list is List of available pickup address info.
	AddressList []LogisticsGetShippingParameterPickupAddress `json:"address_list"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterPickup =======================================================

type LogisticsGetShippingParameterPickupAddress added in v1.5.5

type LogisticsGetShippingParameterPickupAddress struct {
	// address_id is The identity of address.
	AddressID int `json:"address_id,omitempty"`
	// region is The region of specify address.
	Region string `json:"region,omitempty"`
	// state is The state of specify address.
	State string `json:"state,omitempty"`
	// city is The city of specify address.
	City string `json:"city,omitempty"`
	// district is The district of specify address.
	District string `json:"district,omitempty"`
	// town is The town of specify address.
	Town string `json:"town,omitempty"`
	// address is The address description of specify address.
	Address string `json:"address,omitempty"`
	// zipcode is The zipcode of specify address.
	Zipcode string `json:"zipcode,omitempty"`
	// address_flag is The flag of shop address, applicable values: default_address, pickup_address, return_address
	AddressFlag []string `json:"address_flag,omitempty"`
	// time_slot_list is List of pickup_time information corresponding to the address_id.
	TimeSlotList []LogisticsGetShippingParameterPickupAddressTimeSlot `json:"time_slot_list"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterPickupAddress =======================================================

type LogisticsGetShippingParameterPickupAddressTimeSlot added in v1.5.5

type LogisticsGetShippingParameterPickupAddressTimeSlot struct {
	// date is The date of pickup time. In timestamp.
	Date int `json:"date,omitempty"`
	// time_text is The text description of pickup time. Only applicable for certain channels.
	TimeText string `json:"time_text,omitempty"`
	// pickup_time_id is The identity of pickuptime.
	PickupTimeID string `json:"pickup_time_id,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetShippingParameterPickupAddressTimeSlot =======================================================

type LogisticsGetShippingParameterRequest added in v1.5.0

type LogisticsGetShippingParameterRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
}

======================================================= LogisticsGetShippingParameterRequest =======================================================

type LogisticsGetShippingParameterResponse added in v1.5.0

type LogisticsGetShippingParameterResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetShippingParameter `json:"response"`
}

======================================================= LogisticsGetShippingParameterResponse =======================================================

type LogisticsGetTrackingInfo added in v1.5.1

type LogisticsGetTrackingInfo struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// logistics_status is The Shopee logistics status for the order. Applicable values: See Data Definition- LogisticsStatus.
	LogisticsStatus string `json:"logistics_status,omitempty"`
	// tracking_info is The tracking info of the order.
	TrackingInfo []LogisticsGetTrackingInfoTrackingInfo `json:"tracking_info"`
}

======================================================= Object Raw Type - LogisticsGetTrackingInfo =======================================================

type LogisticsGetTrackingInfoRequest added in v1.5.0

type LogisticsGetTrackingInfoRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
	PackageNumber string `json:"package_number,omitempty"`
}

======================================================= LogisticsGetTrackingInfoRequest =======================================================

type LogisticsGetTrackingInfoResponse added in v1.5.0

type LogisticsGetTrackingInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetTrackingInfo `json:"response,omitempty"`
}

======================================================= LogisticsGetTrackingInfoResponse =======================================================

type LogisticsGetTrackingInfoTrackingInfo added in v1.5.4

type LogisticsGetTrackingInfoTrackingInfo struct {
	// update_time is The time when logistics info has been updated.
	UpdateTime int `json:"update_time,omitempty"`
	// description is The description of order logistics tracking info.
	Description string `json:"description,omitempty"`
	// logistics_status is The Shopee logistics status for the order. Applicable values: See Data Definition- TrackingLogisticsStatus.
	LogisticsStatus string `json:"logistics_status,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetTrackingInfoTrackingInfo =======================================================

type LogisticsGetTrackingNumber added in v1.5.1

type LogisticsGetTrackingNumber struct {
	// tracking_number is The tracking number of this order.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// plp_number is The unique identifier for package of BR correios.
	PlpNumber string `json:"plp_number,omitempty"`
	// first_mile_tracking_number is The first mile tracking number of the order. Only for Cross Border Seller
	FirstMileTrackingNumber string `json:"first_mile_tracking_number,omitempty"`
	// last_mile_tracking_number is The last mile tracking number of the order. Only for Cross Border BR seller.
	LastMileTrackingNumber string `json:"last_mile_tracking_number,omitempty"`
	// hint is Indicate hint information if cannot get some fields under special scenarios. For example, cannot get tracking_number when cvs store is closed.
	Hint string `json:"hint,omitempty"`
}

======================================================= Object Raw Type - LogisticsGetTrackingNumber =======================================================

type LogisticsGetTrackingNumberRequest added in v1.5.0

type LogisticsGetTrackingNumberRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there isn't a package number.
	PackageNumber string `json:"package_number,omitempty"`
	// response_optional_fields is Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them. Available values: plp_number, first_mile_tracking_number,last_mile_tracking_number
	ResponseOptionalFields string `json:"response_optional_fields,omitempty"`
}

======================================================= LogisticsGetTrackingNumberRequest =======================================================

type LogisticsGetTrackingNumberResponse added in v1.5.0

type LogisticsGetTrackingNumberResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsGetTrackingNumber `json:"response,omitempty"`
}

======================================================= LogisticsGetTrackingNumberResponse =======================================================

type LogisticsSetAddressConfigRequest added in v1.5.0

type LogisticsSetAddressConfigRequest struct {
	V2RequestAuthenticationParams

	// show_pickup_address is Definite show pickup address or not.
	ShowPickupAddress bool `json:"show_pickup_address,omitempty"`
	// address_type_config is The config of your shop addres.
	AddressTypeConfig AddressTypeConfig `json:"address_type_config,omitempty"`
}

======================================================= LogisticsSetAddressConfigRequest =======================================================

type LogisticsSetAddressConfigResponse added in v1.5.0

type LogisticsSetAddressConfigResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= LogisticsSetAddressConfigResponse =======================================================

type LogisticsShipOrderRequest added in v1.5.0

type LogisticsShipOrderRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
	PackageNumber string `json:"package_number,omitempty"`
	// pickup is Required parameter ONLY if get_shipping_parameter returns "pickup" under "info_needed". Developer should still include "pickup" field in the call even if "pickup" has empty value.
	Pickup *Pickup `json:"pickup,omitempty"`
	// dropoff is Required parameter ONLY if get_shipping_parameter returns "dropoff" under "info_needed". Developer should still include "dropoff" field in the call even if "dropoff" has empty value. For logistic_id 80003 and 80004, both Regular and JOB shipping methods are supported. If you choose Regular shipping method, please use "tracking_no" to call Init API. If you choose JOB shipping method, please use "sender_real_name" to call Init API. Note that only one of "tracking_no" and "sender_real_name" can be selected.
	Dropoff *Dropoff `json:"dropoff,omitempty"`
	// non_integrated is Optional parameter when get_shipping_parameter returns "non-integrated" under "info_needed".
	NonIntegrated *NonIntegrated `json:"non_integrated,omitempty"`
}

======================================================= LogisticsShipOrderRequest =======================================================

type LogisticsShipOrderResponse added in v1.5.0

type LogisticsShipOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= LogisticsShipOrderResponse =======================================================

type LogisticsStatus added in v1.5.7

type LogisticsStatus string
const (
	// Initial status, order not ready for fulfilment
	LogisticsStatusLogisticsNotStarted LogisticsStatus = "LOGISTICS_NOT_STARTED"
	// order arranged shipment
	LogisticsStatusLogisticsRequestCreated LogisticsStatus = "LOGISTICS_REQUEST_CREATED"
	// order handed over to 3PL
	LogisticsStatusPickupDone LogisticsStatus = "LOGISTICS_PICKUP_DONE"
	// order pending 3PL retry pickup
	LogisticsStatusPickupRetry LogisticsStatus = "LOGISTICS_PICKUP_RETRY"
	// order cancelled by 3PL due to failed pickup or picked up but not able to proceed with delivery
	LogisticsStatusPickupFailed LogisticsStatus = "LOGISTICS_PICKUP_FAILED"
	// order successfully delivered
	LogisticsStatusDeliveryDone LogisticsStatus = "LOGISTICS_DELIVERY_DONE"
	// order cancelled due to 3PL delivery failed
	LogisticsStatusDeliveryFailed LogisticsStatus = "LOGISTICS_DELIVERY_FAILED"
	// order cancelled when order at LOGISTICS_REQUEST_CREATED
	LogisticsStatusRequestCanceled LogisticsStatus = "LOGISTICS_REQUEST_CANCELED"
	// Integrated logistics COD: Order rejected for COD.
	LogisticsStatusLogisticsCODRejected LogisticsStatus = "LOGISTICS_COD_REJECTED"
	// order ready for fulfilment from payment perspective: non-COD: order paid; COD: order passed COD screening
	LogisticsStatusLogisticsReady LogisticsStatus = "LOGISTICS_READY"
	// order cancelled when order at LOGISTICS_READY
	LogisticsStatusLogisticsInvalid LogisticsStatus = "LOGISTICS_INVALID"
	// order cancelled due to 3PL lost the order
	LogisticsStatusLogisticsLost LogisticsStatus = "LOGISTICS_LOST"
	// order logistics pending arrangement
	LogisticsStatusLogisticsPenddingArrange LogisticsStatus = "LOGISTICS_PENDING_ARRANGE"
)

type LogisticsUpdateChannel added in v1.5.1

type LogisticsUpdateChannel struct {
	// shop_id is Shopee's unique identifier for a shop.
	ShopID int `json:"shop_id,omitempty"`
	// enabled is Whether this logistic channel is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// preferred is Whether this logistic channel is preferred.
	Preferred bool `json:"preferred,omitempty"`
	// cod_enabled is Whether COD is enabled for this channel.
	CodEnabled bool `json:"cod_enabled,omitempty"`
	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id,omitempty"`
	// updated_channels is <p>List of channels that are updated in the operation (inclusive of dependent logistics channels)<br /></p>
	UpdatedChannels []LogisticsUpdateChannelUpdatedChannel `json:"updated_channels"`
	// is_multi_warehouse is
	IsMultiWarehouse bool `json:"is_multi_warehouse,omitempty"`
}

======================================================= Object Raw Type - LogisticsUpdateChannel =======================================================

type LogisticsUpdateChannelRequest added in v1.5.0

type LogisticsUpdateChannelRequest struct {
	V2RequestAuthenticationParams

	// logistics_channel_id is The identity of logistic channel.
	LogisticsChannelID int `json:"logistics_channel_id"`
	// enabled is Whether to enable this logistic channel.
	Enabled bool `json:"enabled,omitempty"`
	// preferred is Whether to make this logistic channel preferred. Indonestia logistics channel are not applicable.
	Preferred bool `json:"preferred,omitempty"`
	// cod_enabled is Whether to enable COD for this logistic channel. Only COD supported channels are applicable.
	CodEnabled bool `json:"cod_enabled,omitempty"`
}

======================================================= LogisticsUpdateChannelRequest =======================================================

type LogisticsUpdateChannelResponse added in v1.5.0

type LogisticsUpdateChannelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response LogisticsUpdateChannel `json:"response,omitempty"`
}

======================================================= LogisticsUpdateChannelResponse =======================================================

type LogisticsUpdateChannelUpdatedChannel added in v1.5.5

type LogisticsUpdateChannelUpdatedChannel struct {
	// channel_id is <p>Logistics channel ID<br /></p>
	ChannelID int `json:"channel_id,omitempty"`
	// channel_display_name is <p>Logistics channel name<br /></p>
	ChannelDisplayName string `json:"channel_display_name,omitempty"`
	// unsupport_warehouse is <p>List details of unsupported warehouses<br /></p>
	UnsupportWarehouse []LogisticsUpdateChannelUpdatedChannelUnsupportWarehouse `json:"unsupport_warehouse"`
}

======================================================= Object Raw Type - LogisticsUpdateChannelUpdatedChannel =======================================================

type LogisticsUpdateChannelUpdatedChannelUnsupportWarehouse added in v1.5.5

type LogisticsUpdateChannelUpdatedChannelUnsupportWarehouse struct {
	// warehouse_id is <p>Unsupported warehouse ID<br /></p>
	WarehouseID int `json:"warehouse_id,omitempty"`
	// warehouse_name is <p>Unsupported warehouse name<br /></p>
	WarehouseName string `json:"warehouse_name,omitempty"`
}

======================================================= Object Raw Type - LogisticsUpdateChannelUpdatedChannelUnsupportWarehouse =======================================================

type LogisticsUpdateShippingOrderRequest added in v1.5.0

type LogisticsUpdateShippingOrderRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
	PackageNumber string `json:"package_number,omitempty"`
	// pickup is Required parameter ONLY if GetParameterForInit returns "pickup" or if GetLogisticsInfo returns "pickup" under "info_needed" for the same order. Developer should still include "pickup" field in the call even if "pickup" has empty value.
	Pickup Pickup `json:"pickup"`
}

======================================================= LogisticsUpdateShippingOrderRequest =======================================================

type LogisticsUpdateShippingOrderResponse added in v1.5.0

type LogisticsUpdateShippingOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= LogisticsUpdateShippingOrderResponse =======================================================

type MainItemList added in v1.5.1

type MainItemList struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
}

======================================================= Object Raw Type - MainItemList =======================================================

type MediaSpaceCancelVideoUploadRequest added in v1.5.0

type MediaSpaceCancelVideoUploadRequest struct {
	V2RequestAuthenticationParams

	// video_upload_id is The ID of this upload session, returned in init_video_upload.
	VideoUploadID string `json:"video_upload_id"`
}

======================================================= MediaSpaceCancelVideoUploadRequest =======================================================

type MediaSpaceCancelVideoUploadResponse added in v1.5.0

type MediaSpaceCancelVideoUploadResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= MediaSpaceCancelVideoUploadResponse =======================================================

type MediaSpaceCompleteVideoUploadRequest added in v1.5.0

type MediaSpaceCompleteVideoUploadRequest struct {
	V2RequestAuthenticationParams

	// video_upload_id is The ID of this upload session, returned in init_video_upload.
	VideoUploadID string `json:"video_upload_id"`
	// part_seq_list is All uploaded sequence number.
	PartSeqList []int `json:"part_seq_list"`
	// report_data is
	ReportData ReportData `json:"report_data"`
}

======================================================= MediaSpaceCompleteVideoUploadRequest =======================================================

type MediaSpaceCompleteVideoUploadResponse added in v1.5.0

type MediaSpaceCompleteVideoUploadResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= MediaSpaceCompleteVideoUploadResponse =======================================================

type MediaSpaceGetVideoUploadResult added in v1.5.1

type MediaSpaceGetVideoUploadResult struct {
	// status is Current status of this video upload session. could be: INITIATED(waiting for part uploading and/or the complete_video_upload API call), TRANSCODING(has received all video parts, and is transcoding the video file), SUCCEEDED(transcoding completed, and this upload_id can now be used for item adding/updating), FAILED(this upload failed, see the message filed for some info), CANCELLED(this upload is cancelled)
	Status string `json:"status,omitempty"`
	// video_info is Transcoded video info, will be present if status is SUCCEEDED.
	VideoInfo MediaSpaceGetVideoUploadResultVideoInfo `json:"video_info"`
	// message is Detail error message if video uploading/transcoding failed.
	Message string `json:"message,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceGetVideoUploadResult =======================================================

type MediaSpaceGetVideoUploadResultRequest added in v1.5.0

type MediaSpaceGetVideoUploadResultRequest struct {
	V2RequestAuthenticationParams

	// video_upload_id is
	VideoUploadID string `json:"video_upload_id"`
}

======================================================= MediaSpaceGetVideoUploadResultRequest =======================================================

type MediaSpaceGetVideoUploadResultResponse added in v1.5.0

type MediaSpaceGetVideoUploadResultResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response MediaSpaceGetVideoUploadResult `json:"response"`
}

======================================================= MediaSpaceGetVideoUploadResultResponse =======================================================

type MediaSpaceGetVideoUploadResultVideoInfo added in v1.5.4

type MediaSpaceGetVideoUploadResultVideoInfo struct {
	// video_url_list is Video playback URL list.
	VideoUrlList []MediaSpaceGetVideoUploadResultVideoInfoVideoUrl `json:"video_url_list"`
	// thumbnail_url_list is Video thumbnail image URL list.
	ThumbnailUrlList []MediaSpaceGetVideoUploadResultVideoInfoThumbnailUrl `json:"thumbnail_url_list"`
	// duration is Duration of this video, in seconds.
	Duration int `json:"duration,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceGetVideoUploadResultVideoInfo =======================================================

type MediaSpaceGetVideoUploadResultVideoInfoThumbnailUrl added in v1.5.5

type MediaSpaceGetVideoUploadResultVideoInfoThumbnailUrl struct {
	// image_url_region is The region of this image URL.
	ImageUrlRegion string `json:"image_url_region,omitempty"`
	// image_url is Image display URL.
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceGetVideoUploadResultVideoInfoThumbnailUrl =======================================================

type MediaSpaceGetVideoUploadResultVideoInfoVideoUrl added in v1.5.5

type MediaSpaceGetVideoUploadResultVideoInfoVideoUrl struct {
	// video_url_region is The region of this video URL.
	VideoUrlRegion string `json:"video_url_region,omitempty"`
	// video_url is Video playback URL.
	VideoUrl string `json:"video_url,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceGetVideoUploadResultVideoInfoVideoUrl =======================================================

type MediaSpaceInitVideoUpload added in v1.5.1

type MediaSpaceInitVideoUpload struct {
	// video_upload_id is The identifier of this upload session, used in following video upload request and item creating and/or updating
	VideoUploadID string `json:"video_upload_id,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceInitVideoUpload =======================================================

type MediaSpaceInitVideoUploadRequest added in v1.5.0

type MediaSpaceInitVideoUploadRequest struct {
	V2RequestAuthenticationParams

	// file_md5 is md5 of video file
	FileMd5 string `json:"file_md5"`
	// file_size is size of video file, in bytes, maximum is 30MB
	FileSize int `json:"file_size"`
}

======================================================= MediaSpaceInitVideoUploadRequest =======================================================

type MediaSpaceInitVideoUploadResponse added in v1.5.0

type MediaSpaceInitVideoUploadResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response MediaSpaceInitVideoUpload `json:"response"`
}

======================================================= MediaSpaceInitVideoUploadResponse =======================================================

type MediaSpaceUploadImage added in v1.5.1

type MediaSpaceUploadImage struct {
	// image_info is
	ImageInfo MediaSpaceUploadImageImageInfo `json:"image_info"`
}

======================================================= Object Raw Type - MediaSpaceUploadImage =======================================================

type MediaSpaceUploadImageImageInfo added in v1.5.4

type MediaSpaceUploadImageImageInfo struct {
	// image_id is Id of image
	ImageID string `json:"image_id,omitempty"`
	// image_url_list is Image URL of each region
	ImageUrlList []MediaSpaceUploadImageImageInfoImageUrl `json:"image_url_list"`
}

======================================================= Object Raw Type - MediaSpaceUploadImageImageInfo =======================================================

type MediaSpaceUploadImageImageInfoImageUrl added in v1.5.5

type MediaSpaceUploadImageImageInfoImageUrl struct {
	// image_url_region is Region of image url
	ImageUrlRegion string `json:"image_url_region,omitempty"`
	// image_url is image url
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - MediaSpaceUploadImageImageInfoImageUrl =======================================================

type MediaSpaceUploadImageRequest added in v1.5.0

type MediaSpaceUploadImageRequest struct {
	V2RequestAuthenticationParams

	// scene is The scene where the picture is used, The value range is normal or desc; normal: we will process the image as a square image, it is recommended to use when uploading item image; desc: we will not process the image, it is recommended to use when uploading the image of extend_description, if you do not upload this field, it will be normal.
	Scene string `json:"scene,omitempty"`
}

======================================================= MediaSpaceUploadImageRequest =======================================================

type MediaSpaceUploadImageResponse added in v1.5.0

type MediaSpaceUploadImageResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response MediaSpaceUploadImage `json:"response,omitempty"`
}

======================================================= MediaSpaceUploadImageResponse =======================================================

type MediaSpaceUploadVideoPartRequest added in v1.5.0

type MediaSpaceUploadVideoPartRequest struct {
	V2RequestAuthenticationParams

	// video_upload_id is The video_upload_id in the response of initiate_video_upload
	VideoUploadID string `json:"video_upload_id"`
	// part_seq is Sequence of the current part, starts from 0
	PartSeq int `json:"part_seq"`
	// content_md5 is md5 of this part
	ContentMd5 string `json:"content_md5"`
}

======================================================= MediaSpaceUploadVideoPartRequest =======================================================

type MediaSpaceUploadVideoPartResponse added in v1.5.0

type MediaSpaceUploadVideoPartResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= MediaSpaceUploadVideoPartResponse =======================================================

type MerchantGetMerchantInfoRequest added in v1.5.0

type MerchantGetMerchantInfoRequest struct {
	V2RequestAuthenticationParams
}

======================================================= MerchantGetMerchantInfoRequest =======================================================

type MerchantGetMerchantInfoResponse added in v1.5.0

type MerchantGetMerchantInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= MerchantGetMerchantInfoResponse =======================================================

type MerchantGetShopListByMerchantRequest added in v1.5.0

type MerchantGetShopListByMerchantRequest struct {
	V2RequestAuthenticationParams

	// page_no is Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
	PageNo int `json:"page_no"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.No more than 500.
	PageSize int `json:"page_size"`
}

======================================================= MerchantGetShopListByMerchantRequest =======================================================

type MerchantGetShopListByMerchantResponse added in v1.5.0

type MerchantGetShopListByMerchantResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= MerchantGetShopListByMerchantResponse =======================================================

type Model added in v1.5.1

type Model struct {
	// tier_index is Tier index of this model
	TierIndex []int `json:"tier_index,omitempty"`
	// normal_stock is Normal stock of this model
	NormalStock int `json:"normal_stock,omitempty"`
	// original_price is <p>Original price of this model.</p><p><b><font color="#c24f4a">For CO local VAT responsible seller:</font></b>Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)<br /></p>
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// model_sku is Seller SKU of this model, model_sku length information needs to be no more than 100 characters.
	ModelSku string `json:"model_sku,omitempty"`
	// seller_stock is <p>new stock info(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)<br /></p>
	SellerStock []ModelSellerStock `json:"seller_stock,omitempty"`
}

======================================================= Object Raw Type - Model =======================================================

type ModelList added in v1.5.1

type ModelList struct {
	// tier_index is Tier index of model
	TierIndex []int `json:"tier_index,omitempty"`
	// normal_stock is Normal stock for model
	NormalStock int `json:"normal_stock,omitempty"`
	// original_price is Normal stock for price
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// model_sku is Seller sku, model_sku length information needs to be no more than 100 characters.
	ModelSku string `json:"model_sku,omitempty"`
	// seller_stock is <p>new stock info for model(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)<br /></p>
	SellerStock []ModelListSellerStock `json:"seller_stock,omitempty"`
}

======================================================= Object Raw Type - ModelList =======================================================

type ModelListSellerStock added in v1.5.4

type ModelListSellerStock struct {
	// location_id is <p>location id,&nbsp;you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field.<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ModelListSellerStock =======================================================

type ModelSellerStock added in v1.5.4

type ModelSellerStock struct {
	// location_id is <p>location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field.<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock</p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ModelSellerStock =======================================================

type MyIncomeResponseOrderIncome

type MyIncomeResponseOrderIncome struct {
	// The total amount that the seller is expected to receive for the order and will change before order completed. escrow_amount=buyer_total_amount+shopee_discount+voucher_from_shopee+coins+payment_promotion-buyer_transaction_fee-cross_border_tax-commission_fee-service_fee-seller_transaction_fee-seller_coin_cash_back-escrow_tax-drc_adjustable_refund+final_shipping_fee(could be positive/negative)
	EscrowAmount float64 `json:"escrow_amount,omitempty,string"`
	// The total amount that paid by buyer.buyer_total_amount= original price -seller_discount -shopee_discount -voucher_from_seller -voucher_from_shopee -coin -payment_promotion +buyer_paid_shipping_fee +buyer_transaction_fee +cross_border_tax
	BuyerTotalAmount float64 `json:"buyer_total_amount,omitempty,string"`
	// The original price of the item before ANY promotion/discount in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// Final sum of each item seller discount of a specific order.
	SellerDiscount float64 `json:"seller_discount,omitempty,string"`
	// Final sum of each item Shopee discount of a specific order. This amount will rebate to seller.
	ShopeeDiscount float64 `json:"shopee_discount,omitempty,string"`
	// Final value of voucher provided by Seller for the order.
	VoucherFromSeller float64 `json:"voucher_from_seller,omitempty,string"`
	// Final value of voucher provided by Shopee for the order.
	VoucherFromShopee float64 `json:"voucher_from_shopee,omitempty,string"`
	// Final value of coins used by seller for the order.
	Coins float64 `json:"coins,omitempty,string"`
	// The shipping fee paid by buyer.
	BuyerPaidShippingFee float64 `json:"buyer_paid_shipping_fee,omitempty,string"`
	// Tansaction fee paid by buyer for the order.
	BuyerTransactionFee float64 `json:"buyer_transaction_fee,omitempty,string"`
	// Amount incurred by Buyer for purchasing items outside of home country. Amount may change after Return Refund.
	CrossBorderTax float64 `json:"cross_border_tax,omitempty,string"`
	// The amount offset via payment promotion.
	PaymentPromotion float64 `json:"payment_promotion,omitempty,string"`
	// The commission fee charged by Shopee platform if applicable.
	CommissionFee float64 `json:"commission_fee,omitempty,string"`
	// Amount charged by Shopee to seller for additional services.
	ServiceFee float64 `json:"service_fee,omitempty,string"`
	// Tansaction fee paid by seller for the order.
	SellerTransactionFee float64 `json:"seller_transaction_fee,omitempty,string"`
	// Compensation to seller in case of lost parcel
	SellerLostCompensation float64 `json:"seller_lost_compensation,omitempty,string"`
	// Value of coins provided by Seller for purchasing with his or her store for the order.
	SellerCoinCashBack float64 `json:"seller_coin_cash_back,omitempty,string"`
	// Cross-border tax imposed by the Indonesian government on sellers.
	EscrowTax float64 `json:"escrow_tax,omitempty,string"`
	// Final adjusted amount that seller has to bear as part of escrow. This amount could be negative or positive. = min(actual_shipping_fee, shopee_shipping_rebate) + shipping_discount_from_3pl - actual_shipping_fee
	FinalShippingFee float64 `json:"final_shipping_fee,omitempty,string"`
	// The final shipping cost of order and it is negative. For Non-integrated logistics channel is 0.
	ActualShippingFee float64 `json:"actual_shipping_fee,omitempty,string"`
	// The platform shipping subsidy to the seller.
	ShopeeShippingRebate float64 `json:"shopee_shipping_rebate,omitempty,string"`
	// The discount of shipping fee from 3PL. Currently only applicable to ID
	ShippingFeeDiscountFrom3PL float64 `json:"shipping_fee_discount_from_3pl,omitempty,string"`
	// The shipping discount defined by seller.
	SellerShippinhDiscount float64 `json:"seller_shipping_discount,omitempty,string"`
	// The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
	// The list of voucher code provided by seller.
	SellerVoucherCode []string `json:"seller_voucher_code,omitempty,string"`
	// The adjustable refund amount from Shopee Dispute Resolution Center.
	DRCAdjustableRefund float64 `json:"drc_adjustable_refund,omitempty,string"`
	// Final amount paid by the buyer for the items in a specific order.
	CostOfGoodsSold float64 `json:"cost_of_goods_sold,omitempty,string"`
	// Amount paid by the buyer for the items in a specific order.
	OriginalCostOfGoodsSold float64 `json:"original_cost_of_goods_sold,omitempty,string"`
	// Sum of each item Shopee discount of a specific order
	OriginalShopeeDiscount float64 `json:"original_shopee_discount,omitempty,string"`
	// Amount returned to Seller in the event of Partial Return.
	SellerReturnRefund float64 `json:"seller_return_refund,omitempty,string"`
	// The identifier for an API request for error tracking.
	RequestID string `json:"request_id,omitempty,string"`
	// The list of the serial number of refund.
	RefundIDList []string `json:"refund_id_list,omitempty,string"`
}

type NonIntegrated added in v1.5.0

type NonIntegrated struct {
	// tracking_number is Optional parameter for non-integrated channel order. The tracking number assigned by the shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
}

======================================================= Object Raw Type - NonIntegrated =======================================================

type OrderAddInvoiceDataRequest added in v1.5.0

type OrderAddInvoiceDataRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// invoice_data is The invoice data of the order. pt: Nota Fiscal eletrônica (NF-e) do pedido.
	InvoiceData InvoiceData `json:"invoice_data"`
}

======================================================= OrderAddInvoiceDataRequest =======================================================

type OrderAddInvoiceDataResponse added in v1.5.0

type OrderAddInvoiceDataResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderAddInvoiceDataResponse =======================================================

type OrderCancelOrder added in v1.5.1

type OrderCancelOrder struct {
	// update_time is The time when the order is updated.
	UpdateTime int `json:"update_time,omitempty"`
}

======================================================= Object Raw Type - OrderCancelOrder =======================================================

type OrderCancelOrderRequest added in v1.5.0

type OrderCancelOrderRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// cancel_reason is The reason seller want to cancel this order. Applicable values: OUT_OF_STOCK, CUSTOMER_REQUEST, UNDELIVERABLE_AREA, COD_NOT_SUPPORTED.
	CancelReason string `json:"cancel_reason"`
	// item_list is Required when cancel_reason is OUT_OF_STOCK.
	ItemList []ItemList `json:"item_list,omitempty"`
}

======================================================= OrderCancelOrderRequest =======================================================

type OrderCancelOrderResponse added in v1.5.0

type OrderCancelOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderCancelOrder `json:"response,omitempty"`
}

======================================================= OrderCancelOrderResponse =======================================================

type OrderDownloadInvoiceDocRequest added in v1.5.0

type OrderDownloadInvoiceDocRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
}

======================================================= OrderDownloadInvoiceDocRequest =======================================================

type OrderDownloadInvoiceDocResponse added in v1.5.0

type OrderDownloadInvoiceDocResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderDownloadInvoiceDocResponse =======================================================

type OrderGetBuyerInvoiceInfoRequest added in v1.5.0

type OrderGetBuyerInvoiceInfoRequest struct {
	V2RequestAuthenticationParams

	// queries is
	Queries []Queries `json:"queries"`
}

======================================================= OrderGetBuyerInvoiceInfoRequest =======================================================

type OrderGetBuyerInvoiceInfoResponse added in v1.5.0

type OrderGetBuyerInvoiceInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderGetBuyerInvoiceInfoResponse =======================================================

type OrderGetOrderDetail added in v1.5.1

type OrderGetOrderDetail struct {
	// order_list is The list of orders.
	OrderList []OrderGetOrderDetailOrder `json:"order_list"`
}

======================================================= Object Raw Type - OrderGetOrderDetail =======================================================

type OrderGetOrderDetailOrder added in v1.5.5

type OrderGetOrderDetailOrder struct {
	// order_sn is Return by default. Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// region is Return by default. The two-digit code representing the region where the order was made.
	Region string `json:"region,omitempty"`
	// currency is Return by default. The three-digit code representing the currency unit for which the order was paid.
	Currency string `json:"currency,omitempty"`
	// cod is Return by default. This value indicates whether the order was a COD (cash on delivery) order.
	Cod bool `json:"cod,omitempty"`
	// total_amount is The total amount paid by the buyer for the order. This amount includes the total sale price of items, shipping cost beared by buyer; and offset by Shopee promotions if applicable. This value will only return after the buyer has completed payment for the order.
	TotalAmount float64 `json:"total_amount,omitempty,string"`
	// order_status is Return by default. Enumerated type that defines the current status of the order.
	OrderStatus string `json:"order_status,omitempty"`
	// shipping_carrier is The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// payment_method is The payment method that the buyer selected to pay for the order.
	PaymentMethod string `json:"payment_method,omitempty"`
	// estimated_shipping_fee is The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
	// message_to_seller is Return by default. Message to seller.
	MessageToSeller string `json:"message_to_seller,omitempty"`
	// create_time is Return by default. Timestamp that indicates the date and time that the order was created.
	CreateTime int `json:"create_time,omitempty"`
	// update_time is Return by default. Timestamp that indicates the last time that there was a change in value of order, such as order status changed from 'Paid' to 'Completed'.
	UpdateTime int `json:"update_time,omitempty"`
	// days_to_ship is Return by default. Shipping preparation time set by the seller when listing item on Shopee.
	DaysToShip int `json:"days_to_ship,omitempty"`
	// ship_by_date is Return by default. The deadline to ship out the parcel.
	ShipByDate int `json:"ship_by_date,omitempty"`
	// buyer_user_id is The user id of buyer of this order
	BuyerUserID int `json:"buyer_user_id,omitempty"`
	// buyer_username is The name of buyer
	BuyerUsername string `json:"buyer_username,omitempty"`
	// recipient_address is This object contains detailed breakdown for the recipient address.
	RecipientAddress OrderGetOrderDetailOrderRecipientAddres `json:"recipient_address"`
	// actual_shipping_fee is The actual shipping fee of the order if available from external logistics partners.
	ActualShippingFee float64 `json:"actual_shipping_fee,omitempty,string"`
	// goods_to_declare is Only work for cross-border order.This value indicates whether the order contains goods that are required to declare at customs. "T" means true and it will mark as "T" on the shipping label; "F" means false and it will mark as "P" on the shipping label. This value is accurate ONLY AFTER the order trackingNo is generated, please capture this value AFTER your retrieve the trackingNo.
	GoodsToDeclare bool `json:"goods_to_declare,omitempty"`
	// note is The note seller made for own reference.
	Note string `json:"note,omitempty"`
	// note_update_time is Update time for the note.
	NoteUpdateTime int `json:"note_update_time,omitempty"`
	// item_list is This object contains the detailed breakdown for the result of this API call.
	ItemList []OrderGetOrderDetailOrderItem `json:"item_list"`
	// pay_time is The time when the order status is updated from UNPAID to PAID. This value is NULL when order is not paid yet.
	PayTime int `json:"pay_time,omitempty"`
	// dropshipper is For Indonesia orders only. The name of the dropshipper.
	Dropshipper string `json:"dropshipper,omitempty"`
	// dropshipper_phone is The phone number of dropshipper, could be empty.
	DropshipperPhone string `json:"dropshipper_phone,omitempty"`
	// split_up is <p>To indicate whether this order is split to fullfil order(forder) level. Call&nbsp;v2.order.split_order if it's "true".</p>
	SplitUp bool `json:"split_up,omitempty"`
	// buyer_cancel_reason is Cancel reason from buyer, could be empty.
	BuyerCancelReason string `json:"buyer_cancel_reason,omitempty"`
	// cancel_by is Could be one of buyer, seller, system or Ops.
	CancelBy string `json:"cancel_by,omitempty"`
	// cancel_reason is Use this field to get reason for buyer, seller, and system cancellation.
	CancelReason string `json:"cancel_reason,omitempty"`
	// actual_shipping_fee_confirmed is Use this filed to judge whether the actual_shipping_fee is confirmed.
	ActualShippingFeeConfirmed bool `json:"actual_shipping_fee_confirmed,omitempty"`
	// buyer_cpf_id is Buyer's CPF number for taxation and invoice purposes. Only for Brazil order.
	BuyerCpfID string `json:"buyer_cpf_id,omitempty"`
	// fulfillment_flag is Use this field to indicate the order is fulfilled by shopee or seller. Applicable values: fulfilled_by_shopee, fulfilled_by_cb_seller, fulfilled_by_local_seller.
	FulfillmentFlag string `json:"fulfillment_flag,omitempty"`
	// pickup_done_time is The timestamp when pickup is done.
	PickupDoneTime int `json:"pickup_done_time,omitempty"`
	// package_list is The list of package under an order
	PackageList []OrderGetOrderDetailOrderPackage `json:"package_list"`
	// invoice_data is The invoice data of the order. pt: Nota Fiscal eletrônica (NF-e) do pedido.
	InvoiceData OrderGetOrderDetailOrderInvoiceData `json:"invoice_data"`
	// checkout_shipping_carrier is For non masking order, the logistics service provider that the buyer selected for the order to deliver items. For masking order, the logistics service type that the buyer selected for the order to deliver items.
	CheckoutShippingCarrier string `json:"checkout_shipping_carrier,omitempty"`
	// reverse_shipping_fee is Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.
	ReverseShippingFee float64 `json:"reverse_shipping_fee,omitempty,string"`
	// order_chargeable_weight_gram is <p>For CB shop, display weight used to calculate actual_shipping_fee for this order.<br /></p>
	OrderChargeableWeightGram int `json:"order_chargeable_weight_gram,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrder =======================================================

type OrderGetOrderDetailOrderInvoiceData added in v1.5.5

type OrderGetOrderDetailOrderInvoiceData struct {
	// number is The number of the invoice. The number should be 9 digits. pt: número da NF-e.
	Number string `json:"number,omitempty"`
	// series_number is The series number of the invoice. The series number should be 3 digits. pt: série da NF-e.
	SeriesNumber string `json:"series_number,omitempty"`
	// access_key is The access key of the invoice. The access key should be 44 digits. pt: chave de acesso da NF-e.
	AccessKey string `json:"access_key,omitempty"`
	// issue_date is The issue date of the invoice. The issue date should be later than the order pay date. pt: data de emissão da NF-e.
	IssueDate int `json:"issue_date,omitempty"`
	// total_value is The total value of the invoice. pt: valor total da NF-e (R$).
	TotalValue float64 `json:"total_value,omitempty,string"`
	// products_total_value is The products total value of the invoice. pt: valor total dos produtos (R$) da NF-e.
	ProductsTotalValue float64 `json:"products_total_value,omitempty,string"`
	// tax_code is The tax code for the invoice. The tax code should be 4 digits. pt: Código Fiscal de Operações e Prestações (CFOP) predominante na NF-e.
	TaxCode string `json:"tax_code,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderInvoiceData =======================================================

type OrderGetOrderDetailOrderItem added in v1.5.5

type OrderGetOrderDetailOrderItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// item_name is The name of the item.
	ItemName string `json:"item_name,omitempty"`
	// item_sku is  A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSku string `json:"item_sku,omitempty"`
	// model_id is ID of the model that belongs to the same item.
	ModelID int `json:"model_id,omitempty"`
	// model_name is Name of the model that belongs to the same item. A seller can offer models of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate model. Each model can have a different quantity and price.
	ModelName string `json:"model_name,omitempty"`
	// model_sku is A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are models of one item in Shopee Listings.
	ModelSku string `json:"model_sku,omitempty"`
	// model_quantity_purchased is The number of identical items purchased at the same time by the same buyer from one listing/item.
	ModelQuantityPurchased int `json:"model_quantity_purchased,omitempty"`
	// model_original_price is The original price of the item in the listing currency.
	ModelOriginalPrice float64 `json:"model_original_price,omitempty,string"`
	// model_discounted_price is The after-discount price of the item in the listing currency. If there is no discount, this value will be same as that of model_original_price. In case of bundle deal item, this value will return 0 as by design bundle deal discount will not be breakdown to item/model level. Due to technical restriction, the value will return the price before bundle deal if we don't configure it to 0. Please call GetEscrowDetails if you want to calculate item-level discounted price for bundle deal item.
	ModelDiscountedPrice float64 `json:"model_discounted_price,omitempty,string"`
	// wholesale is This value indicates whether buyer buy the order item in wholesale price.
	Wholesale bool `json:"wholesale,omitempty"`
	// weight is The weight of the item
	Weight float64 `json:"weight,omitempty,string"`
	// add_on_deal is To indicate if this item belongs to an addon deal.
	AddOnDeal bool `json:"add_on_deal,omitempty"`
	// main_item is To indicate if this item is main item or sub item. True means main item, false means sub item.
	MainItem bool `json:"main_item,omitempty"`
	// add_on_deal_id is A unique ID to distinguish groups of items in Cart, and Order. (e.g. AddOnDeal)
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// promotion_type is <p>Available type:product_promotion, flash_sale, group_by, bundle_deal, add_on_deal_main, add_on_deal_sub, add_on_free_gift_main,&nbsp;add_on_free_gift_sub</p>
	PromotionType string `json:"promotion_type,omitempty"`
	// promotion_id is The ID of the promotion.
	PromotionID int `json:"promotion_id,omitempty"`
	// order_item_id is The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id.
	OrderItemID int `json:"order_item_id,omitempty"`
	// promotion_group_id is The identify of product promotion.
	PromotionGroupID int `json:"promotion_group_id,omitempty"`
	// image_info is  Image info of the product.
	ImageInfo OrderGetOrderDetailOrderItemImageInfo `json:"image_info"`
	// product_location_id is The list of warehouse IDs of the item.
	ProductLocationID []string `json:"product_location_id,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderItem =======================================================

type OrderGetOrderDetailOrderItemImageInfo added in v1.5.5

type OrderGetOrderDetailOrderItemImageInfo struct {
	// image_url is The image url of the product. Default to be variation image, if the model does not have a variation image, will use an item main image instead.
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderItemImageInfo =======================================================

type OrderGetOrderDetailOrderPackage added in v1.5.5

type OrderGetOrderDetailOrderPackage struct {
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// logistics_status is The Shopee logistics status for the order. Applicable values: See Data Definition-LogisticsStatus.
	LogisticsStatus string `json:"logistics_status,omitempty"`
	// shipping_carrier is The logistics service provider that the buyer selected for the order to deliver items.
	ShippingCarrier string `json:"shipping_carrier,omitempty"`
	// item_list is The lis of items.
	ItemList []OrderGetOrderDetailOrderPackageItem `json:"item_list"`
	// parcel_chargeable_weight_gram is <p>For CB shop, display weight used to calculate actual_shipping_fee for this parcel.<br /></p>
	ParcelChargeableWeightGram int `json:"parcel_chargeable_weight_gram,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderPackage =======================================================

type OrderGetOrderDetailOrderPackageItem added in v1.5.5

type OrderGetOrderDetailOrderPackageItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderPackageItem =======================================================

type OrderGetOrderDetailOrderRecipientAddres added in v1.5.5

type OrderGetOrderDetailOrderRecipientAddres struct {
	// name is Recipient's name for the address.
	Name string `json:"name,omitempty"`
	// phone is Recipient's phone number input when order was placed.
	Phone string `json:"phone,omitempty"`
	// town is  The town of the recipient's address. Whether there is a town will depend on the region and/or country.
	Town string `json:"town,omitempty"`
	// district is The district of the recipient's address. Whether there is a district will depend on the region and/or country.
	District string `json:"district,omitempty"`
	// city is The city of the recipient's address. Whether there is a city will depend on the region and/or country.
	City string `json:"city,omitempty"`
	// state is The state/province of the recipient's address. Whether there is a state/province will depend on the region and/or country.
	State string `json:"state,omitempty"`
	// region is The two-digit code representing the region of the Recipient.
	Region string `json:"region,omitempty"`
	// zipcode is Recipient's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// full_address is The full address of the recipient, including country, state, even street, and etc.
	FullAddress string `json:"full_address,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderDetailOrderRecipientAddres =======================================================

type OrderGetOrderDetailRequest added in v1.5.0

type OrderGetOrderDetailRequest struct {
	V2RequestAuthenticationParams

	// order_sn_list is The set of order_sn. If there are multiple order_sn, you need to use English comma to connect them. limit [1,50]
	OrderSnList []string `json:"order_sn_list"`
	// response_optional_fields is <p>Indicate response fields you want to get. Please select from the below response parameters. If you input an object field, all the params under it will be included automatically in the response. If there are multiple response fields you want to get, you need to use English comma to connect them.  Available values: buyer_user_id,buyer_username,estimated_shipping_fee,recipient_address,actual_shipping_fee ,goods_to_declare,note,note_update_time,item_list,pay_time,dropshipper,dropshipper_phone,split_up,buyer_cancel_reason,cancel_by,cancel_reason,actual_shipping_fee_confirmed,buyer_cpf_id,fulfillment_flag,pickup_done_time,package_list,shipping_carrier,payment_method,total_amount,buyer_username,invoice_data, checkout_shipping_carrier, reverse_shipping_fee, order_chargeable_weight_gram etc.</p>
	ResponseOptionalFields []string `json:"response_optional_fields,omitempty"`
}

======================================================= OrderGetOrderDetailRequest =======================================================

type OrderGetOrderDetailResponse added in v1.5.0

type OrderGetOrderDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderGetOrderDetail `json:"response,omitempty"`
}

======================================================= OrderGetOrderDetailResponse =======================================================

type OrderGetOrderList added in v1.5.1

type OrderGetOrderList struct {
	// more is This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders.
	More bool `json:"more,omitempty"`
	// order_list is
	OrderList []OrderGetOrderListOrder `json:"order_list"`
	// next_cursor is If  more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderList =======================================================

type OrderGetOrderListOrder added in v1.5.5

type OrderGetOrderListOrder struct {
	// order_sn is  Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// order_status is The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED
	OrderStatus string `json:"order_status,omitempty"`
}

======================================================= Object Raw Type - OrderGetOrderListOrder =======================================================

type OrderGetOrderListRequest added in v1.5.0

type OrderGetOrderListRequest struct {
	V2RequestAuthenticationParams

	// time_range_field is The kind of time_from and time_to. Available value: create_time, update_time.
	TimeRangeField string `json:"time_range_field"`
	// time_from is The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.
	TimeFrom int `json:"time_from"`
	// time_to is The time_from and time_to fields specify a date range for retrieving orders (based on the time_range_field). The time_from field is the starting date range. The maximum date range that may be specified with the time_from and time_to fields is 15 days.
	TimeTo int `json:"time_to"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.
	PageSize int `json:"page_size"`
	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
	// order_status is The order_status filter for retriveing orders and each one only every request. Available value: UNPAID/READY_TO_SHIP/PROCESSED/SHIPPED/COMPLETED/IN_CANCEL/CANCELLED/INVOICE_PENDING
	OrderStatus string `json:"order_status,omitempty"`
	// response_optional_fields is Optional fields in response. Available value: order_status.
	ResponseOptionalFields string `json:"response_optional_fields,omitempty"`
}

======================================================= OrderGetOrderListRequest =======================================================

type OrderGetOrderListResponse added in v1.5.0

type OrderGetOrderListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderGetOrderList `json:"response,omitempty"`
}

======================================================= OrderGetOrderListResponse =======================================================

type OrderGetPendingBuyerInvoiceOrderList added in v1.5.1

type OrderGetPendingBuyerInvoiceOrderList struct {
	// more is This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders.
	More bool `json:"more,omitempty"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
	// order_list is
	OrderList []OrderGetPendingBuyerInvoiceOrderListOrder `json:"order_list"`
}

======================================================= Object Raw Type - OrderGetPendingBuyerInvoiceOrderList =======================================================

type OrderGetPendingBuyerInvoiceOrderListOrder added in v1.5.5

type OrderGetPendingBuyerInvoiceOrderListOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
}

======================================================= Object Raw Type - OrderGetPendingBuyerInvoiceOrderListOrder =======================================================

type OrderGetPendingBuyerInvoiceOrderListRequest added in v1.5.0

type OrderGetPendingBuyerInvoiceOrderListRequest struct {
	V2RequestAuthenticationParams

	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.
	PageSize int `json:"page_size"`
}

======================================================= OrderGetPendingBuyerInvoiceOrderListRequest =======================================================

type OrderGetPendingBuyerInvoiceOrderListResponse added in v1.5.0

type OrderGetPendingBuyerInvoiceOrderListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderGetPendingBuyerInvoiceOrderList `json:"response"`
}

======================================================= OrderGetPendingBuyerInvoiceOrderListResponse =======================================================

type OrderGetShipmentList added in v1.5.1

type OrderGetShipmentList struct {
	// order_list is The list of  shipment orders
	OrderList []OrderGetShipmentListOrder `json:"order_list"`
	// more is This is to indicate whether the order list is more than one page. If this value is true, you may want to continue to check next page to retrieve orders.
	More bool `json:"more,omitempty"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - OrderGetShipmentList =======================================================

type OrderGetShipmentListOrder added in v1.5.5

type OrderGetShipmentListOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order
	PackageNumber string `json:"package_number,omitempty"`
}

======================================================= Object Raw Type - OrderGetShipmentListOrder =======================================================

type OrderGetShipmentListRequest added in v1.5.0

type OrderGetShipmentListRequest struct {
	V2RequestAuthenticationParams

	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor,omitempty"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data.The limit of page_size if between 1 and 100.
	PageSize int `json:"page_size"`
}

======================================================= OrderGetShipmentListRequest =======================================================

type OrderGetShipmentListResponse added in v1.5.0

type OrderGetShipmentListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderGetShipmentList `json:"response"`
}

======================================================= OrderGetShipmentListResponse =======================================================

type OrderHandleBuyerCancellation added in v1.5.1

type OrderHandleBuyerCancellation struct {
	// update_time is The time when the order is updated.
	UpdateTime int `json:"update_time,omitempty"`
}

======================================================= Object Raw Type - OrderHandleBuyerCancellation =======================================================

type OrderHandleBuyerCancellationRequest added in v1.5.0

type OrderHandleBuyerCancellationRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// operation is The operation you want to handle.Avaiable value: ACCEPT, REJECT
	Operation string `json:"operation"`
}

======================================================= OrderHandleBuyerCancellationRequest =======================================================

type OrderHandleBuyerCancellationResponse added in v1.5.0

type OrderHandleBuyerCancellationResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderHandleBuyerCancellation `json:"response"`
}

======================================================= OrderHandleBuyerCancellationResponse =======================================================

type OrderList added in v1.5.1

type OrderList struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_number is Shopee's unique identifier for the package under an order. You should't fill the field with empty string when there is't a package number.
	PackageNumber string `json:"package_number,omitempty"`
}

======================================================= Object Raw Type - OrderList =======================================================

type OrderSetNoteRequest added in v1.5.0

type OrderSetNoteRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// note is The note seller add for reference.
	Note string `json:"note"`
}

======================================================= OrderSetNoteRequest =======================================================

type OrderSetNoteResponse added in v1.5.0

type OrderSetNoteResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderSetNoteResponse =======================================================

type OrderSplitOrder added in v1.5.1

type OrderSplitOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// package_list is The list of package under this order you have split.
	PackageList []OrderSplitOrderPackage `json:"package_list"`
}

======================================================= Object Raw Type - OrderSplitOrder =======================================================

type OrderSplitOrderPackage added in v1.5.5

type OrderSplitOrderPackage struct {
	// package_number is Shopee's unique identifier for the package under an order.
	PackageNumber string `json:"package_number,omitempty"`
	// item_list is The list of items under this package.
	ItemList []OrderSplitOrderPackageItem `json:"item_list"`
}

======================================================= Object Raw Type - OrderSplitOrderPackage =======================================================

type OrderSplitOrderPackageItem added in v1.5.5

type OrderSplitOrderPackageItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// order_item_id is The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id.
	OrderItemID int `json:"order_item_id,omitempty"`
	// promotion_group_id is The identify of product promotion. For items in one same add on deal promotion, the promotion_group_id should share the same id. For items not in add on deal promotion, the promotion_group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails.
	PromotionGroupID int `json:"promotion_group_id,omitempty"`
}

======================================================= Object Raw Type - OrderSplitOrderPackageItem =======================================================

type OrderSplitOrderRequest added in v1.5.0

type OrderSplitOrderRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// package_list is The list of packages that you want to split
	PackageList []PackageList `json:"package_list"`
}

======================================================= OrderSplitOrderRequest =======================================================

type OrderSplitOrderResponse added in v1.5.0

type OrderSplitOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response OrderSplitOrder `json:"response"`
}

======================================================= OrderSplitOrderResponse =======================================================

type OrderStatus added in v1.5.7

type OrderStatus string
const (
	// UNPAID:Order is created, buyer has not paid yet.
	OrderStatusUnpaid OrderStatus = "UNPAID"
	// READY_TO_SHIP:Seller can arrange shipment.
	OrderStatusReadyToShip OrderStatus = "READY_TO_SHIP"
	// PROCESSED:Seller has arranged shipment online and got tracking number from 3PL.
	OrderStatusProcessed OrderStatus = "PROCESSED"
	// RETRY_SHIP:3PL pickup parcel fail. Need to re arrange shipment.
	OrderStatusRetryShip OrderStatus = "RETRY_SHIP"
	// SHIPPED:The parcel has been drop to 3PL or picked up by 3PL.
	OrderStatusShipped OrderStatus = "SHIPPED"
	// TO_CONFIRM_RECEIVE:The order has been received by buyer.
	OrderStatusToConfirmReceive OrderStatus = "TO_CONFIRM_RECEIVE"
	// IN_CANCEL:The order's cancelation is under processing.
	OrderStatusInCancel OrderStatus = "IN_CANCEL"
	// CANCELLED:The order has been canceled.
	OrderStatusCancelled OrderStatus = "CANCELLED"
	// TO_RETURN:The buyer requested to return the order and order's return is processing.
	OrderStatusToReturn OrderStatus = "TO_RETURN"
	// COMPLETED:The order has been completed.
	OrderStatusCompleted OrderStatus = "COMPLETED"
)

type OrderUnsplitOrderRequest added in v1.5.0

type OrderUnsplitOrderRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
}

======================================================= OrderUnsplitOrderRequest =======================================================

type OrderUnsplitOrderResponse added in v1.5.0

type OrderUnsplitOrderResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderUnsplitOrderResponse =======================================================

type OrderUploadInvoiceDocRequest added in v1.5.0

type OrderUploadInvoiceDocRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
	// file_type is <p>the type of invoice file. 1:pdf 2.jpeg 3.png.&nbsp;For CO only accepts 1:pdf</p>
	FileType string `json:"file_type"`
}

======================================================= OrderUploadInvoiceDocRequest =======================================================

type OrderUploadInvoiceDocResponse added in v1.5.0

type OrderUploadInvoiceDocResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= OrderUploadInvoiceDocResponse =======================================================

type PackageList added in v1.5.1

type PackageList struct {
	// item_list is The list of items under the same package.
	ItemList []PackageListItem `json:"item_list"`
}

======================================================= Object Raw Type - PackageList =======================================================

type PackageListItem added in v1.5.5

type PackageListItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a model of an item.
	ModelID int `json:"model_id,omitempty"`
	// order_item_id is The identify of order item. For items in one same bundle deal promotion, the order_item_id should share the same id, such as 1,2. For items not in bundle deal promotion, the order_item_id should be the same as item_id.
	OrderItemID int `json:"order_item_id,omitempty"`
	// promotion_group_id is The identify of product promotion. For items in one same add on deal promotion, the promotion_group_id should share the same id. For items not in add on deal promotion, the promotion_group_id should be 0. And the data is from group_id of shopee.orders.GetOrderDetails.
	PromotionGroupID int `json:"promotion_group_id,omitempty"`
}

======================================================= Object Raw Type - PackageListItem =======================================================

type PaymentGetEscrowDetail added in v1.5.1

type PaymentGetEscrowDetail struct {
	// order_sn is  Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// buyer_user_name is The username of buyer.
	BuyerUserName string `json:"buyer_user_name,omitempty"`
	// return_order_sn_list is The list of the serial number of return.
	ReturnOrderSnList []string `json:"return_order_sn_list,omitempty"`
	// order_income is
	OrderIncome PaymentGetEscrowDetailOrderIncome `json:"order_income"`
}

======================================================= Object Raw Type - PaymentGetEscrowDetail =======================================================

type PaymentGetEscrowDetailOrderIncome added in v1.5.4

type PaymentGetEscrowDetailOrderIncome struct {
	// escrow_amount is <p>The total amount that the seller is expected to receive for the order and will change before order completed.&nbsp;</p><p>For non cb sip affiliate shop: escrow_amount=buyer_total_amount+shopee_discount+voucher_from_shopee+coins+payment_promotion-buyer_transaction_fee-cross_border_tax-commission_fee-service_fee-seller_transaction_fee-seller_coin_cash_back-escrow_tax-final_product_vat_tax-drc_adjustable_refund+final_shipping_fee(could be postitive/negtive).&nbsp;</p><p>For cb sip affiliate shop:&nbsp;</p><p>escrow_amount=sum of all Asku's settlement price - service_fee - commission_fee -seller_return_refund - drc_adjustable_refund.</p>
	EscrowAmount float64 `json:"escrow_amount,omitempty,string"`
	// buyer_total_amount is The total amount that paid by buyer.
	BuyerTotalAmount float64 `json:"buyer_total_amount,omitempty,string"`
	// original_price is The original price of the item before ANY promotion/discount in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// seller_discount is Final sum of each item seller discount of a specific order. (Only display for non cb sip affiliate shop. )
	SellerDiscount float64 `json:"seller_discount,omitempty,string"`
	// shopee_discount is Final sum of each item Shopee discount of a specific order. This amount will rebate to seller. (Only display for non cb sip affiliate order. )
	ShopeeDiscount float64 `json:"shopee_discount,omitempty,string"`
	// voucher_from_seller is Final value of voucher provided by Seller for the order. (Only display for non cb sip affiliate shop. )
	VoucherFromSeller float64 `json:"voucher_from_seller,omitempty,string"`
	// voucher_from_shopee is Final value of voucher provided by Shopee for the order. (Only display for non cb sip affiliate shop. )
	VoucherFromShopee float64 `json:"voucher_from_shopee,omitempty,string"`
	// coins is This value indicates the total amount offset when the buyer consumed Shopee Coins upon checkout. (Only display for non cb sip affiliate shop. )
	Coins float64 `json:"coins,omitempty,string"`
	// buyer_paid_shipping_fee is The shipping fee paid by buyer. (Only display for non cb sip affiliate shop. )
	BuyerPaidShippingFee float64 `json:"buyer_paid_shipping_fee,omitempty,string"`
	// buyer_transaction_fee is Tansaction fee paid by buyer for the order. (Only display for non cb sip affiliate shop. )
	BuyerTransactionFee float64 `json:"buyer_transaction_fee,omitempty,string"`
	// cross_border_tax is Amount incurred by Buyer for purchasing items outside of home country. Amount may change after Return Refund. (Only display for non cb sip affiliate shop. )
	CrossBorderTax float64 `json:"cross_border_tax,omitempty,string"`
	// payment_promotion is The amount offset via payment promotion. (Only display for non cb sip affiliate shop. )
	PaymentPromotion float64 `json:"payment_promotion,omitempty,string"`
	// commission_fee is The commission fee charged by Shopee platform if applicable.
	CommissionFee float64 `json:"commission_fee,omitempty,string"`
	// service_fee is Amount charged by Shopee to seller for additional services.
	ServiceFee float64 `json:"service_fee,omitempty,string"`
	// seller_transaction_fee is Tansaction fee paid by seller for the order. (Only display for non cb sip affiliate shop. )
	SellerTransactionFee float64 `json:"seller_transaction_fee,omitempty,string"`
	// seller_lost_compensation is Compensation to seller in case of lost parcel. (Only display for non cb sip affiliate shop. )
	SellerLostCompensation float64 `json:"seller_lost_compensation,omitempty,string"`
	// seller_coin_cash_back is Value of coins provided by Seller for purchasing with his or her store for the order. (Only display for non cb sip affiliate shop. )
	SellerCoinCashBack float64 `json:"seller_coin_cash_back,omitempty,string"`
	// escrow_tax is Cross-border tax imposed by the Indonesian government on sellers. (Only display for non cb sip affiliate shop. )
	EscrowTax float64 `json:"escrow_tax,omitempty,string"`
	// final_shipping_fee is Final adjusted amount that seller has to bear as part of escrow. This amount could be negative or positive. (Only display for non cb sip affiliate shop. )
	FinalShippingFee float64 `json:"final_shipping_fee,omitempty,string"`
	// actual_shipping_fee is The final shipping cost of order and it is positive. For Non-integrated logistics channel is 0. (Only display for non cb sip affiliate shop. )
	ActualShippingFee float64 `json:"actual_shipping_fee,omitempty,string"`
	// order_chargeable_weight is <p>For CB shop, display weight used to calculate actual_shipping_fee for this order.<br /></p>
	OrderChargeableWeight int `json:"order_chargeable_weight,omitempty"`
	// shopee_shipping_rebate is The platform shipping subsidy to the seller. (Only display for non cb sip affiliate shop. )
	ShopeeShippingRebate float64 `json:"shopee_shipping_rebate,omitempty,string"`
	// shipping_fee_discount_from_3pl is The discount of shipping fee from 3PL. Currently only applicable to ID. (Only display for non cb sip affiliate shop. )
	ShippingFeeDiscountFrom3Pl float64 `json:"shipping_fee_discount_from_3pl,omitempty,string"`
	// seller_shipping_discount is The shipping discount defined by seller. (Only display for non cb sip affiliate shop. )
	SellerShippingDiscount float64 `json:"seller_shipping_discount,omitempty,string"`
	// estimated_shipping_fee is The estimated shipping fee is an estimation calculated by Shopee based on specific logistics courier's standard. (Only display for non cb sip affiliate shop. )
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
	// seller_voucher_code is The list of voucher code provided by seller. (Only display for non cb sip affiliate shop. )
	SellerVoucherCode []string `json:"seller_voucher_code,omitempty"`
	// drc_adjustable_refund is The adjustable refund amount from Shopee Dispute Resolution Center.
	DrcAdjustableRefund float64 `json:"drc_adjustable_refund,omitempty,string"`
	// cost_of_goods_sold is Final amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. )
	CostOfGoodsSold float64 `json:"cost_of_goods_sold,omitempty,string"`
	// original_cost_of_goods_sold is Amount paid by the buyer for the items in a specific order. (Only display for non cb sip affiliate shop. )
	OriginalCostOfGoodsSold float64 `json:"original_cost_of_goods_sold,omitempty,string"`
	// original_shopee_discount is Sum of each item Shopee discount of a specific order. (Only display for non cb sip affiliate shop. )
	OriginalShopeeDiscount float64 `json:"original_shopee_discount,omitempty,string"`
	// seller_return_refund is Amount returned to Seller in the event of Partial Return.
	SellerReturnRefund float64 `json:"seller_return_refund,omitempty,string"`
	// items is This object contains the detailed breakdown for all the items in this order, including regular items(non-activity) and activity items.
	Items []PaymentGetEscrowDetailOrderIncomeItem `json:"items"`
	// escrow_amount_pri is The total amount in the prim currency that the seller is expected to receive for the order and will change before order completed . escrow_amount_pri=original_price_pri-seller_return_refund_pri-commission_fee_pri-service_fee_pri-drc_adjustable_refund_pri. (Only display for non cb sip order.)
	EscrowAmountPri float64 `json:"escrow_amount_pri,omitempty,string"`
	// buyer_total_amount_pri is The total amount that paid by buyer in the primary currency. (Only display for cb sip affiliate order. )
	BuyerTotalAmountPri float64 `json:"buyer_total_amount_pri,omitempty,string"`
	// original_price_pri is The original price of the item before ANY promotion/discount in the primary currency. It returns the subtotal of that specific item if quantity exceeds 1. (Only display for non cb sip affiliate order. )
	OriginalPricePri float64 `json:"original_price_pri,omitempty,string"`
	// seller_return_refund_pri is Amount returned to Seller in the event of Partial Return in the primary currency. (Only display for cb sip affiliate shop. )
	SellerReturnRefundPri float64 `json:"seller_return_refund_pri,omitempty,string"`
	// commission_fee_pri is The commission fee charged by Shopee platform if applicable in the primary currency. (Only display for cb sip affiliate shop. )
	CommissionFeePri float64 `json:"commission_fee_pri,omitempty,string"`
	// service_fee_pri is Amount charged by Shopee to seller for additional services in the primary currency. (Only display for cb sip affiliate shop. )
	ServiceFeePri float64 `json:"service_fee_pri,omitempty,string"`
	// drc_adjustable_refund_pri is The adjustable refund amount from Shopee Dispute Resolution Center in the primary currency. (Only display for cb sip affiliate shop. )
	DrcAdjustableRefundPri float64 `json:"drc_adjustable_refund_pri,omitempty,string"`
	// pri_currency is The currency of the country where the shop that real seller operates. (Only display for cb sip affiliate shop. )
	PriCurrency string `json:"pri_currency,omitempty"`
	// aff_currency is The currency of the country where shop opened in. (Only display for cb sip affiliate shop. )
	AffCurrency string `json:"aff_currency,omitempty"`
	// exchange_rate is Exchange rate from primary shop currency to affiliate shop currency.
	ExchangeRate float64 `json:"exchange_rate,omitempty,string"`
	// reverse_shipping_fee is Shopee charges the reverse shipping fee for the returned order.The value of this field will be non-negative.
	ReverseShippingFee float64 `json:"reverse_shipping_fee,omitempty,string"`
	// final_product_protection is The total amount of product protection purchased during placing an order. (Only display for cb normal and cb sip primary shop)
	FinalProductProtection float64 `json:"final_product_protection,omitempty,string"`
	// credit_card_promotion is This value indicate the offset via credit card promotion.
	CreditCardPromotion float64 `json:"credit_card_promotion,omitempty,string"`
	// credit_card_transaction_fee is This value indicate the credit card transaction fee.
	CreditCardTransactionFee float64 `json:"credit_card_transaction_fee,omitempty,string"`
	// final_product_vat_tax is Value-added Tax is required for online purchases based on EU Value-added Tax regulations . (Only display for non cb sip affiliate shop. )
	FinalProductVatTax float64 `json:"final_product_vat_tax,omitempty,string"`
}

======================================================= Object Raw Type - PaymentGetEscrowDetailOrderIncome =======================================================

type PaymentGetEscrowDetailOrderIncomeItem added in v1.5.5

type PaymentGetEscrowDetailOrderIncomeItem struct {
	// item_id is ID of item
	ItemID int `json:"item_id,omitempty"`
	// item_name is Name of item
	ItemName string `json:"item_name,omitempty"`
	// item_sku is A item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSku string `json:"item_sku,omitempty"`
	// model_id is ID of the model that belongs to the same item.
	ModelID int `json:"model_id,omitempty"`
	// model_name is Name of the model that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	ModelName string `json:"model_name,omitempty"`
	// model_sku is A model SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	ModelSku string `json:"model_sku,omitempty"`
	// original_price is The original price of the item before ANY promotion/discount in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// discounted_price is The after-discount price of the item in the listing currency. It returns the subtotal of that specific item if quantity exceeds 1. If there is no discount, this value will be the same as that of original_price.
	DiscountedPrice float64 `json:"discounted_price,omitempty,string"`
	// seller_discount is <p>The discount provided by seller for this item<br /></p>
	SellerDiscount float64 `json:"seller_discount,omitempty,string"`
	// shopee_discount is <p>The discount provided by Shopee for this item<br /></p>
	ShopeeDiscount float64 `json:"shopee_discount,omitempty,string"`
	// discount_from_coin is  The offset of this item when the buyer consumed Shopee Coins upon checkout. In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0.
	DiscountFromCoin float64 `json:"discount_from_coin,omitempty,string"`
	// discount_from_voucher_shopee is The offset of this item when the buyer use Shopee voucher. In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0.
	DiscountFromVoucherShopee float64 `json:"discount_from_voucher_shopee,omitempty,string"`
	// discount_from_voucher_seller is The offset of this item when the buyer use seller-specific voucher. In case of bundle deal item, this value will return 0. Due to technical restriction, this field will return incorrect value under bundle deal case if we don’t configure it to 0.
	DiscountFromVoucherSeller float64 `json:"discount_from_voucher_seller,omitempty,string"`
	// activity_type is The type of the item, default is "". If the item is a bundle item the value is "bundle_deal", and if a add on deal item, the value is "add_on_deal"
	ActivityType string `json:"activity_type,omitempty"`
	// activity_id is If bundle_deal the is id of bundle deal, if add_on_deal this is id of add on deal.
	ActivityID int `json:"activity_id,omitempty"`
	// is_main_item is Meaning a main or sub item for add_on_deal.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// quantity_purchased is This value indicates the number of identical items purchased at the same time by the same buyer from one listing/item.
	QuantityPurchased int `json:"quantity_purchased,omitempty"`
}

======================================================= Object Raw Type - PaymentGetEscrowDetailOrderIncomeItem =======================================================

type PaymentGetEscrowDetailRequest added in v1.5.0

type PaymentGetEscrowDetailRequest struct {
	V2RequestAuthenticationParams

	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn"`
}

======================================================= PaymentGetEscrowDetailRequest =======================================================

type PaymentGetEscrowDetailResponse added in v1.5.0

type PaymentGetEscrowDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response PaymentGetEscrowDetail `json:"response"`
}

======================================================= PaymentGetEscrowDetailResponse =======================================================

type PaymentGetEscrowList added in v1.5.1

type PaymentGetEscrowList struct {
	// escrow_list is
	EscrowList []PaymentGetEscrowListEscrow `json:"escrow_list"`
	// more is
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - PaymentGetEscrowList =======================================================

type PaymentGetEscrowListEscrow added in v1.5.5

type PaymentGetEscrowListEscrow struct {
	// order_sn is
	OrderSN string `json:"order_sn,omitempty"`
	// payout_amount is The settlement amount
	PayoutAmount float64 `json:"payout_amount,omitempty,string"`
	// escrow_release_time is The release time
	EscrowReleaseTime int `json:"escrow_release_time,omitempty"`
}

======================================================= Object Raw Type - PaymentGetEscrowListEscrow =======================================================

type PaymentGetEscrowListRequest added in v1.5.0

type PaymentGetEscrowListRequest struct {
	V2RequestAuthenticationParams

	// release_time_from is Query start time
	ReleaseTimeFrom int `json:"release_time_from"`
	// release_time_to is Query end time
	ReleaseTimeTo int `json:"release_time_to"`
	// page_size is Number of pages returned  max:100  default:40
	PageSize int `json:"page_size,omitempty"`
	// page_no is The page number  min:1  default:1
	PageNo int `json:"page_no,omitempty"`
}

======================================================= PaymentGetEscrowListRequest =======================================================

type PaymentGetEscrowListResponse added in v1.5.0

type PaymentGetEscrowListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The business content of the response
	Response PaymentGetEscrowList `json:"response,omitempty"`
}

======================================================= PaymentGetEscrowListResponse =======================================================

type PaymentGetItemInstallmentStatus added in v1.5.1

type PaymentGetItemInstallmentStatus struct {
	// item_installment_list is
	ItemInstallmentList []PaymentGetItemInstallmentStatusItemInstallment `json:"item_installment_list"`
	// item_plan_ahora_list is Only applicable for local AR sellers.
	ItemPlanAhoraList []PaymentGetItemInstallmentStatusItemPlanAhora `json:"item_plan_ahora_list"`
}

======================================================= Object Raw Type - PaymentGetItemInstallmentStatus =======================================================

type PaymentGetItemInstallmentStatusItemInstallment added in v1.5.5

type PaymentGetItemInstallmentStatusItemInstallment struct {
	// item_id is Item unique id
	ItemID int `json:"item_id,omitempty"`
	// tenure_list is The tenures of item support installment. [] represents with no installment
	TenureList []int `json:"tenure_list,omitempty"`
}

======================================================= Object Raw Type - PaymentGetItemInstallmentStatusItemInstallment =======================================================

type PaymentGetItemInstallmentStatusItemPlanAhora added in v1.5.5

type PaymentGetItemInstallmentStatusItemPlanAhora struct {
	// item_id is Only applicable for local AR sellers.
	ItemID int `json:"item_id,omitempty"`
	// participate_plan_ahora is Only applicable for local AR sellers.
	ParticipatePlanAhora bool `json:"participate_plan_ahora,omitempty"`
}

======================================================= Object Raw Type - PaymentGetItemInstallmentStatusItemPlanAhora =======================================================

type PaymentGetItemInstallmentStatusRequest added in v1.5.0

type PaymentGetItemInstallmentStatusRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is Item id array, Max :100
	ItemIdList []int `json:"item_id_list"`
}

======================================================= PaymentGetItemInstallmentStatusRequest =======================================================

type PaymentGetItemInstallmentStatusResponse added in v1.5.0

type PaymentGetItemInstallmentStatusResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The business content of the response
	Response PaymentGetItemInstallmentStatus `json:"response"`
}

======================================================= PaymentGetItemInstallmentStatusResponse =======================================================

type PaymentGetPaymentMethodList added in v1.5.1

type PaymentGetPaymentMethodList struct {
	// payment_method is
	PaymentMethod []string `json:"payment_method,omitempty"`
	// region is
	Region string `json:"region,omitempty"`
}

======================================================= Object Raw Type - PaymentGetPaymentMethodList =======================================================

type PaymentGetPaymentMethodListRequest added in v1.5.0

type PaymentGetPaymentMethodListRequest struct {
	V2RequestAuthenticationParams
}

======================================================= PaymentGetPaymentMethodListRequest =======================================================

type PaymentGetPaymentMethodListResponse added in v1.5.0

type PaymentGetPaymentMethodListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response []PaymentGetPaymentMethodList `json:"response"`
}

======================================================= PaymentGetPaymentMethodListResponse =======================================================

type PaymentGetPayoutDetail added in v1.5.1

type PaymentGetPayoutDetail struct {
	// more is
	More bool `json:"more,omitempty"`
	// payout_list is
	PayoutList []PaymentGetPayoutDetailPayout `json:"payout_list"`
}

======================================================= Object Raw Type - PaymentGetPayoutDetail =======================================================

type PaymentGetPayoutDetailPayout added in v1.5.5

type PaymentGetPayoutDetailPayout struct {
	// payout_info is The information of payout.
	PayoutInfo PaymentGetPayoutDetailPayoutPayoutInfo `json:"payout_info"`
	// escrow_list is
	EscrowList []PaymentGetPayoutDetailPayoutEscrow `json:"escrow_list"`
	// offline_adjustment_list is The list of offline adjustments.
	OfflineAdjustmentList []PaymentGetPayoutDetailPayoutOfflineAdjustment `json:"offline_adjustment_list"`
}

======================================================= Object Raw Type - PaymentGetPayoutDetailPayout =======================================================

type PaymentGetPayoutDetailPayoutEscrow added in v1.5.5

type PaymentGetPayoutDetailPayoutEscrow struct {
	// escrow_amount is The total amount that the seller is expected to receive for the order.
	EscrowAmount float64 `json:"escrow_amount,omitempty,string"`
	// currency is The currency used for calculating escrow amount.
	Currency string `json:"currency,omitempty"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
}

======================================================= Object Raw Type - PaymentGetPayoutDetailPayoutEscrow =======================================================

type PaymentGetPayoutDetailPayoutOfflineAdjustment added in v1.5.5

type PaymentGetPayoutDetailPayoutOfflineAdjustment struct {
	// adjustment_amount is The amount of offline adjustments.
	AdjustmentAmount float64 `json:"adjustment_amount,omitempty,string"`
	// module is The reason for offline adjustment.
	Module string `json:"module,omitempty"`
	// remark is The remark for the reason.
	Remark string `json:"remark,omitempty"`
	// scenario is The scenario of adjustment.
	Scenario string `json:"scenario,omitempty"`
	// adjustment_level is Dimension of offline adjustment. Available value: shop, order.
	AdjustmentLevel string `json:"adjustment_level,omitempty"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
}

======================================================= Object Raw Type - PaymentGetPayoutDetailPayoutOfflineAdjustment =======================================================

type PaymentGetPayoutDetailPayoutPayoutInfo added in v1.5.5

type PaymentGetPayoutDetailPayoutPayoutInfo struct {
	// from_currency is The settlement currency of orders.
	FromCurrency string `json:"from_currency,omitempty"`
	// payout_currency is The actual currency of payout.
	PayoutCurrency string `json:"payout_currency,omitempty"`
	// from_amount is The settlement amount.
	FromAmount float64 `json:"from_amount,omitempty,string"`
	// payout_amount is The actual amount of payout.
	PayoutAmount float64 `json:"payout_amount,omitempty,string"`
	// exchange_rate is The exchange rate.
	ExchangeRate string `json:"exchange_rate,omitempty"`
	// payout_time is The time of payout.
	PayoutTime int `json:"payout_time,omitempty"`
	// pay_service is The service provider of seller. Available value: payoneer, pingpong, lianlian.
	PayService string `json:"pay_service,omitempty"`
	// payee_id is Seller's account to receive the payout.
	PayeeID string `json:"payee_id,omitempty"`
}

======================================================= Object Raw Type - PaymentGetPayoutDetailPayoutPayoutInfo =======================================================

type PaymentGetPayoutDetailRequest added in v1.5.0

type PaymentGetPayoutDetailRequest struct {
	V2RequestAuthenticationParams

	// page_size is Number of pages returned  max:100
	PageSize int `json:"page_size"`
	// page_no is The page number  min:1  default:1
	PageNo int `json:"page_no"`
	// payout_time_from is Strat time
	PayoutTimeFrom int `json:"payout_time_from"`
	// payout_time_to is End time
	PayoutTimeTo int `json:"payout_time_to"`
}

======================================================= PaymentGetPayoutDetailRequest =======================================================

type PaymentGetPayoutDetailResponse added in v1.5.0

type PaymentGetPayoutDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The business content of the response
	Response PaymentGetPayoutDetail `json:"response"`
}

======================================================= PaymentGetPayoutDetailResponse =======================================================

type PaymentGetShopInstallmentStatus added in v1.5.1

type PaymentGetShopInstallmentStatus struct {
	// installment_status is The installment status for the shop
	InstallmentStatus int `json:"installment_status,omitempty"`
}

======================================================= Object Raw Type - PaymentGetShopInstallmentStatus =======================================================

type PaymentGetShopInstallmentStatusRequest added in v1.5.0

type PaymentGetShopInstallmentStatusRequest struct {
	V2RequestAuthenticationParams
}

======================================================= PaymentGetShopInstallmentStatusRequest =======================================================

type PaymentGetShopInstallmentStatusResponse added in v1.5.0

type PaymentGetShopInstallmentStatusResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The business content of the response.
	Response PaymentGetShopInstallmentStatus `json:"response"`
}

======================================================= PaymentGetShopInstallmentStatusResponse =======================================================

type PaymentGetWalletTransactionList added in v1.5.1

type PaymentGetWalletTransactionList struct {
	// transaction_list is
	TransactionList []PaymentGetWalletTransactionListTransaction `json:"transaction_list"`
	// more is
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - PaymentGetWalletTransactionList =======================================================

type PaymentGetWalletTransactionListRequest added in v1.5.0

type PaymentGetWalletTransactionListRequest struct {
	V2RequestAuthenticationParams

	// page_no is Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
	PageNo int `json:"page_no"`
	// page_size is If many transactions are available to retrieve, you may need to call GetTransactionList multiple times to retrieve all the data. Each result set is returned as a page of entries. Default is 40. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is usUed to specify the maximum number of entries to return in a single ""page"" of data.
	PageSize int `json:"page_size"`
	// create_time_from is The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
	CreateTimeFrom int `json:"create_time_from"`
	// create_time_to is The create_time_to field is the ending date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
	CreateTimeTo int `json:"create_time_to"`
	// wallet_type is This field indicates the wallet type.
	WalletType string `json:"wallet_type,omitempty"`
	// transaction_type is <p>This field indicates the transaction type. More detail can refer Data Definition to check.</p>
	TransactionType string `json:"transaction_type,omitempty"`
}

======================================================= PaymentGetWalletTransactionListRequest =======================================================

type PaymentGetWalletTransactionListResponse added in v1.5.0

type PaymentGetWalletTransactionListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response PaymentGetWalletTransactionList `json:"response,omitempty"`
}

======================================================= PaymentGetWalletTransactionListResponse =======================================================

type PaymentGetWalletTransactionListTransaction added in v1.5.5

type PaymentGetWalletTransactionListTransaction struct {
	// status is The status of the transaction,available values: FAILED,COMPLETED,PENDING,INITIAL.
	Status string `json:"status,omitempty"`
	// transaction_type is The type of transaction.
	TransactionType string `json:"transaction_type,omitempty"`
	// amount is The amount of transaction.
	Amount float64 `json:"amount,omitempty,string"`
	// current_balance is The current balance of this account.
	CurrentBalance float64 `json:"current_balance,omitempty,string"`
	// create_time is The create time of the transaction.
	CreateTime int `json:"create_time,omitempty"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// refund_sn is The serial number of return.
	RefundSN string `json:"refund_sn,omitempty"`
	// withdrawal_type is The type of withdrawal.
	WithdrawalType string `json:"withdrawal_type,omitempty"`
	// transaction_fee is This field indicates the transaction fee.
	TransactionFee float64 `json:"transaction_fee,omitempty,string"`
	// description is The detailed description of TOPUP SUCCESS and TOPUP FAILED.
	Description string `json:"description,omitempty"`
	// buyer_name is The name of buyer.
	BuyerName string `json:"buyer_name,omitempty"`
	// pay_order_list is
	PayOrderList []PaymentGetWalletTransactionListTransactionPayOrder `json:"pay_order_list"`
	// shop_name is Name of the shop.
	ShopName string `json:"shop_name,omitempty"`
	// withdraw_id is Withdraw ID when transaction type is withdraw_created, withdrawal_completed, withdrawal_cancelled.
	WithdrawID int `json:"withdraw_id,omitempty"`
	// reason is The reason for ADJUSTMENT_ADD and ADJUSTMENT_MINUS.
	Reason string `json:"reason,omitempty"`
	// root_withdrawal_id is Use this field to indicate the event where a withdrawal is split into several withdrawals due to the withdrawal limit.
	RootWithdrawalID int `json:"root_withdrawal_id,omitempty"`
}

======================================================= Object Raw Type - PaymentGetWalletTransactionListTransaction =======================================================

type PaymentGetWalletTransactionListTransactionPayOrder added in v1.5.5

type PaymentGetWalletTransactionListTransactionPayOrder struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// shop_name is Name of the shop.
	ShopName string `json:"shop_name,omitempty"`
}

======================================================= Object Raw Type - PaymentGetWalletTransactionListTransactionPayOrder =======================================================

type PaymentSetItemInstallmentStatus added in v1.5.1

type PaymentSetItemInstallmentStatus struct {
	// item_installment_list is
	ItemInstallmentList []PaymentSetItemInstallmentStatusItemInstallment `json:"item_installment_list"`
	// item_plan_ahora_list is Only applicable for local AR sellers.
	ItemPlanAhoraList []PaymentSetItemInstallmentStatusItemPlanAhora `json:"item_plan_ahora_list"`
}

======================================================= Object Raw Type - PaymentSetItemInstallmentStatus =======================================================

type PaymentSetItemInstallmentStatusItemInstallment added in v1.5.5

type PaymentSetItemInstallmentStatusItemInstallment struct {
	// item_id is Item unique id
	ItemID int `json:"item_id,omitempty"`
	// tenure_list is The tenures of item support installment. [] represents with no installment
	TenureList []int `json:"tenure_list,omitempty"`
}

======================================================= Object Raw Type - PaymentSetItemInstallmentStatusItemInstallment =======================================================

type PaymentSetItemInstallmentStatusItemPlanAhora added in v1.5.5

type PaymentSetItemInstallmentStatusItemPlanAhora struct {
	// item_id is Only applicable for local AR sellers.
	ItemID int `json:"item_id,omitempty"`
	// participate_plan_ahor is Only applicable for local AR sellers.
	ParticipatePlanAhor bool `json:"participate_plan_ahor,omitempty"`
}

======================================================= Object Raw Type - PaymentSetItemInstallmentStatusItemPlanAhora =======================================================

type PaymentSetItemInstallmentStatusRequest added in v1.5.0

type PaymentSetItemInstallmentStatusRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is The id array of the item, Max :100
	ItemIdList []int `json:"item_id_list"`
	// tenure_list is Staged array, TH must be [3,6,10], [] means closed
	TenureList []int `json:"tenure_list"`
	// participate_plan_ahora is Only applicable and required for local AR sellers.
	ParticipatePlanAhora bool `json:"participate_plan_ahora,omitempty"`
}

======================================================= PaymentSetItemInstallmentStatusRequest =======================================================

type PaymentSetItemInstallmentStatusResponse added in v1.5.0

type PaymentSetItemInstallmentStatusResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The business content of the response
	Response PaymentSetItemInstallmentStatus `json:"response,omitempty"`
}

======================================================= PaymentSetItemInstallmentStatusResponse =======================================================

type PaymentSetShopInstallmentStatus added in v1.5.1

type PaymentSetShopInstallmentStatus struct {
	// installment_status is
	InstallmentStatus int `json:"installment_status,omitempty"`
}

======================================================= Object Raw Type - PaymentSetShopInstallmentStatus =======================================================

type PaymentSetShopInstallmentStatusRequest added in v1.5.0

type PaymentSetShopInstallmentStatusRequest struct {
	V2RequestAuthenticationParams

	// installment_status is
	InstallmentStatus int `json:"installment_status"`
}

======================================================= PaymentSetShopInstallmentStatusRequest =======================================================

type PaymentSetShopInstallmentStatusResponse added in v1.5.0

type PaymentSetShopInstallmentStatusResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response PaymentSetShopInstallmentStatus `json:"response"`
}

======================================================= PaymentSetShopInstallmentStatusResponse =======================================================

type PerformanceRequest

type PerformanceRequest struct {
	// Partner ID is assigned upon registration is successful. Required for all requests.
	PartnerID int64 `json:"partner_id,omitempty"`
	// Shopee's unique identifier for a shop. Required for all requests.
	ShopID int64 `json:"shopid,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type PerformanceResponse

type PerformanceResponse struct {
	// To ensure that buyers can easily find what they are looking for, any attempts by sellers to manipulate search results to gain an unfair advantage will be penalized.
	SpamListingViolation PerformanceResponsePerformance `json:"spam_listing_violation,omitempty"`
	// Overall review rating is the average of all order ratings submitted by your buyers.
	OverallReviewRating PerformanceResponsePerformance `json:"overall_review_rating,omitempty"`
	// Preparation time is the number of days it takes a seller to prepare and ship out an order.
	AveragePreparationTime PerformanceResponsePerformance `json:"average_preparation_time,omitempty"`
	// Late shipment rate is the percentage of orders (out of total orders) that were shipped late in the past 30 days. You should maintain your late shipment rate at a healthy level of <5%. If your late shipment rate exceeds 15%, you will receive a penalty point under the Seller Penalty Points system.
	LateShipmentRate PerformanceResponsePerformance `json:"late_shipment_rate,omitempty"`
	// Return-refund rate is the percentage of orders (out of total orders) that were requested by buyers for a return-refund in the past 30 days.
	ReturnRefundRate PerformanceResponsePerformance `json:"return_refund_rate,omitempty"`
	// Chat response time is the average time it takes a seller to respond to a buyer's chat message.
	ResponseTime PerformanceResponsePerformance `json:"response_time,omitempty"`
	// It is the responsibility of sellers to ensure all items listed under their profiles are fully compliant with local laws, as well as Shopee’s terms and policies.
	ProhibitedListingViolation PerformanceResponsePerformance `json:"prohibited_listing_violation,omitempty"`
	// Cancellation rate is the percentage of orders (out of total orders) cancelled by a seller in the past 30 days. Buyers initiatied cancellations are not included in the calculation.
	CancellationRate PerformanceResponsePerformance `json:"cancellation_rate,omitempty"`
	// Sellers should only list authentic products. Counterfeit items are products that were made in exact imitation of an existing brand with the intention to deceive or defraud, and may include, but are not limited to: - Products that are fake or replicas of an existing official product - Products that have never been produced by a specific brand - Products that bear such similarities with other products (e.g. a replica of a branded item with or without altered logos) without the authorization of the trademark owner.
	CounterfeitListingViolation PerformanceResponsePerformance `json:"counterfeit_listing_violation,omitempty"`
	// Your shop rating.
	ShopRating PerformanceResponsePerformance `json:"shop_rating,omitempty"`
	// Chat response rate is the percentage of new chats and offers (out of total) that a seller responds to within 12 hours of receiving them. Auto replies are not included in the chat response rate computation.
	ResponseRate PerformanceResponsePerformance `json:"response_rate,omitempty"`
	// Non-fulfilment rate is the percentage of orders (out of total orders) that were either cancelled or returned in the past 30 days. Only orders cancelled by sellers are taken into consideration when computing non-fulfilment rate. Non-fulfilment rate is also the sum of your cancellation rate and return-refund rate.
	NonFullfillmentRate PerformanceResponsePerformance `json:"non_fullfillment_rate,omitempty"`
	// The identifier for an API request for error tracking.
	RequestID string `json:"request_id,omitempty"`
}

type PerformanceResponsePerformance

type PerformanceResponsePerformance struct {
	// The threshold used to compare shop's actual performance to the target performance. It has four types: lt(less than), gt(greater than), lte(less than or equal), gte(greater than or equal).
	ThresholdType string `json:"threshold_type,omitempty"`
	// Null, not applicable.
	Unit string `json:"unit,omitempty"`
	// Your target performance index.
	Target float64 `json:"target,omitempty"`
	// Your actual performance index.
	My float64 `json:"my,omitempty"`
}

type Pickup added in v1.5.0

type Pickup struct {
	// address_id is The identity of address. Retrieved from v2.logistics.get_shipping_parameter.
	AddressID int `json:"address_id,omitempty"`
	// pickup_time_id is The pickup time id. Retrieved from v2.logistics.get_shipping_parameter.
	PickupTimeID string `json:"pickup_time_id,omitempty"`
	// tracking_number is Need input this field when "tracking_number" is returned from "info_need". Please note that this tracking number is assigned by third-party shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
}

======================================================= Object Raw Type - Pickup =======================================================

type PreOrder added in v1.5.0

type PreOrder struct {
	// is_pre_order is Whether item is pre order
	IsPreOrder bool `json:"is_pre_order,omitempty"`
	// days_to_ship is The guaranteed days to ship orders. Please get the days_to_ship range from get_dts_limit api
	DaysToShip int `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - PreOrder =======================================================

type PriceList added in v1.5.1

type PriceList struct {
	// model_id is 0 for no model item.
	ModelID int `json:"model_id,omitempty"`
	// original_price is <p>Original price for this model.</p><p><b><font color="#c24f4a">For CO local VAT responsible seller:</font></b>Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)<br /></p><p><b><font color="#c24f4a">For&nbsp;SG/MY/BR/MX/PL/ES/AR seller:&nbsp;</font></b>Sellers can set the price with two decimal place,&nbsp;other regions can only set the price as an integer.<br /></p>
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - PriceList =======================================================

type ProductAddItem added in v1.5.1

type ProductAddItem struct {
	// description is Description of item
	Description string `json:"description,omitempty"`
	// weight is Item weight
	Weight int `json:"weight,omitempty"`
	// pre_order is Pre order setting
	PreOrder ProductAddItemPreOrder `json:"pre_order"`
	// item_name is Item name
	ItemName string `json:"item_name,omitempty"`
	// images is Item images
	Images ProductAddItemImage `json:"images"`
	// item_status is Item status
	ItemStatus string `json:"item_status,omitempty"`
	// price_info is Item price info
	PriceInfo ProductAddItemPriceInfo `json:"price_info"`
	// logistic_info is Logistic setting
	LogisticInfo []ProductAddItemLogisticInfo `json:"logistic_info"`
	// stock_info is Stock info
	StockInfo ProductAddItemStockInfo `json:"stock_info"`
	// item_id is Item ID
	ItemID int `json:"item_id,omitempty"`
	// attributes is Item attributes
	Attributes []ProductAddItemAttribute `json:"attributes"`
	// category_id is Category ID
	CategoryID int `json:"category_id,omitempty"`
	// dimension is Item dimension
	Dimension ProductAddItemDimension `json:"dimension"`
	// condition is Item condition, could be NEW or USED
	Condition string `json:"condition,omitempty"`
	// video_info is Item video
	VideoInfo []ProductAddItemVideoInfo `json:"video_info"`
	// wholesale is Wholesale setting
	Wholesale []ProductAddItemWholesale `json:"wholesale"`
	// brand is
	Brand ProductAddItemBrand `json:"brand"`
	// item_dangerous is This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
	ItemDangerous int `json:"item_dangerous,omitempty"`
	// description_info is New description field. Only whitelist sellers can use it. If item with extended_description this field will return, otherwise do not return.
	DescriptionInfo ProductAddItemDescriptionInfo `json:"description_info"`
	// description_type is <p>description_type (normal , extended).</p>
	DescriptionType string `json:"description_type,omitempty"`
	// complaint_policy is Complaint Policy for item. Only returned for local PL sellers.
	ComplaintPolicy ProductAddItemComplaintPolicy `json:"complaint_policy"`
	// seller_stock is <p>seller stock<br /></p>
	SellerStock []ProductAddItemSellerStock `json:"seller_stock"`
}

======================================================= Object Raw Type - ProductAddItem =======================================================

type ProductAddItemAttribute added in v1.5.5

type ProductAddItemAttribute struct {
	// attribute_id is Attribute ID
	AttributeID int `json:"attribute_id,omitempty"`
	// attribute_value_list is
	AttributeValueList []ProductAddItemAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - ProductAddItemAttribute =======================================================

type ProductAddItemAttributeAttributeValue added in v1.5.5

type ProductAddItemAttributeAttributeValue struct {
	// original_value_name is Value name
	OriginalValueName string `json:"original_value_name,omitempty"`
	// value_id is Value ID
	ValueID int `json:"value_id,omitempty"`
	// value_unit is Unit of attribute value
	ValueUnit string `json:"value_unit,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemAttributeAttributeValue =======================================================

type ProductAddItemBrand added in v1.5.4

type ProductAddItemBrand struct {
	// brand_id is Id of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is Original name of brand.
	OriginalBrandName string `json:"original_brand_name,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemBrand =======================================================

type ProductAddItemComplaintPolicy added in v1.5.4

type ProductAddItemComplaintPolicy struct {
	// warranty_time is Time for a warranty claim. Could be ONE_YEAR, TWO_YEARS, OVER_TWO_YEARS.
	WarrantyTime string `json:"warranty_time,omitempty"`
	// exclude_entrepreneur_warranty is If True means "I exclude warranty complaints for entrepreneur"
	ExcludeEntrepreneurWarranty bool `json:"exclude_entrepreneur_warranty,omitempty"`
	// complaint_address_id is The identity of complaint address.
	ComplaintAddressID int `json:"complaint_address_id,omitempty"`
	// additional_information is  Additional information for complaint policy.
	AdditionalInformation string `json:"additional_information,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemComplaintPolicy =======================================================

type ProductAddItemDescriptionInfo added in v1.5.4

type ProductAddItemDescriptionInfo struct {
	// extended_description is If description_type is extended , description information should be set by this field.
	ExtendedDescription ProductAddItemDescriptionInfoExtendedDescription `json:"extended_description"`
}

======================================================= Object Raw Type - ProductAddItemDescriptionInfo =======================================================

type ProductAddItemDescriptionInfoExtendedDescription added in v1.5.4

type ProductAddItemDescriptionInfoExtendedDescription struct {
	// field_list is Field of extended description.
	FieldList []ProductAddItemDescriptionInfoExtendedDescriptionField `json:"field_list"`
}

======================================================= Object Raw Type - ProductAddItemDescriptionInfoExtendedDescription =======================================================

type ProductAddItemDescriptionInfoExtendedDescriptionField added in v1.5.5

type ProductAddItemDescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field :values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be set by this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image, image url will be set by this field.
	ImageInfo ProductAddItemDescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info"`
}

======================================================= Object Raw Type - ProductAddItemDescriptionInfoExtendedDescriptionField =======================================================

type ProductAddItemDescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type ProductAddItemDescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemDescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type ProductAddItemDimension added in v1.5.4

type ProductAddItemDimension struct {
	// package_width is Package width, unit is cm
	PackageWidth int `json:"package_width,omitempty"`
	// package_length is Package length, unit is cm
	PackageLength int `json:"package_length,omitempty"`
	// package_height is Package height, unit is cm
	PackageHeight int `json:"package_height,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemDimension =======================================================

type ProductAddItemImage added in v1.5.5

type ProductAddItemImage struct {
	// image_id_list is ID of image
	ImageIdList []string `json:"image_id_list,omitempty"`
	// image_url_list is Display URL of image
	ImageUrlList []string `json:"image_url_list,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemImage =======================================================

type ProductAddItemLogisticInfo added in v1.5.4

type ProductAddItemLogisticInfo struct {
	// size_id is Size ID
	SizeID int `json:"size_id,omitempty"`
	// shipping_fee is Shipping fee
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// enabled is Whether this channel is enabled for this item
	Enabled bool `json:"enabled,omitempty"`
	// logistic_id is Logistic channel ID
	LogisticID int `json:"logistic_id,omitempty"`
	// is_free is Whether cover shipping fee for buyer
	IsFree bool `json:"is_free,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemLogisticInfo =======================================================

type ProductAddItemPreOrder added in v1.5.4

type ProductAddItemPreOrder struct {
	// days_to_ship is The guaranteed days to ship orders.
	DaysToShip int `json:"days_to_ship,omitempty"`
	// is_pre_order is Whether this item is pre order
	IsPreOrder bool `json:"is_pre_order,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemPreOrder =======================================================

type ProductAddItemPriceInfo added in v1.5.4

type ProductAddItemPriceInfo struct {
	// current_price is Current price of item
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// original_price is Original price of item
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductAddItemPriceInfo =======================================================

type ProductAddItemRequest added in v1.5.0

type ProductAddItemRequest struct {
	V2RequestAuthenticationParams

	// original_price is <p>Item price</p><p><b><font color="#c24f4a">For CO local VAT responsible seller:</font></b>Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)<br /></p><p><b><font color="#c24f4a">For&nbsp;SG/MY/BR/MX/PL/ES/AR seller:&nbsp;</font></b><span style="font-size:14px;"></span><span style="font-size:14px;">Sellers can set the price with two decimal place,&nbsp;</span><span style="font-size:14px;">other regions can only set the price as an integer.</span></p>
	OriginalPrice float64 `json:"original_price,string"`
	// description is if description_type is normal , Description information should be set by this field.
	Description string `json:"description"`
	// weight is Weight of item
	Weight float64 `json:"weight,omitempty,string"`
	// item_name is Item name
	ItemName string `json:"item_name"`
	// item_status is Item status, could be UNLIST or NORMAL
	ItemStatus string `json:"item_status,omitempty"`
	// dimension is Item dimension
	Dimension Dimension `json:"dimension,omitempty"`
	// normal_stock is Item stock
	NormalStock int `json:"normal_stock"`
	// logistic_info is Logistic channel setting
	LogisticInfo []LogisticInfo `json:"logistic_info"`
	// attribute_list is <p>This field is optional(expect Indonesia) depending on the specific attribute under different categories. Should call get_attribute api to get attribute first. Must contain all all mandatory attribute.</p>
	AttributeList []AttributeList `json:"attribute_list,omitempty"`
	// category_id is ID of category
	CategoryID int `json:"category_id"`
	// image is Item images
	Image Image `json:"image"`
	// pre_order is Pre order setting
	PreOrder PreOrder `json:"pre_order,omitempty"`
	// item_sku is SKU tag of item
	ItemSku string `json:"item_sku,omitempty"`
	// condition is Condition of item, could be USED or NEW
	Condition string `json:"condition,omitempty"`
	// wholesale is <p>Wholesale setting.</p>
	Wholesale []Wholesale `json:"wholesale,omitempty"`
	// video_upload_id is Video upload ID returned from video uploading API. Only accept one video_upload_id.
	VideoUploadID []string `json:"video_upload_id,omitempty"`
	// brand is
	Brand Brand `json:"brand,omitempty"`
	// item_dangerous is This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
	ItemDangerous int `json:"item_dangerous,omitempty"`
	// tax_info is Tax information
	TaxInfo TaxInfo `json:"tax_info,omitempty"`
	// complaint_policy is Complaint Policy for item. Only required for local PL sellers, ignored otherwise.
	ComplaintPolicy ComplaintPolicy `json:"complaint_policy,omitempty"`
	// description_info is New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo DescriptionInfo `json:"description_info,omitempty"`
	// description_type is <p>description_type (normal , extended). If you want to use extended_description, this field must be inputed</p>
	DescriptionType string `json:"description_type,omitempty"`
	// seller_stock is <p>seller stock(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)<br /></p>
	SellerStock []SellerStock `json:"seller_stock,omitempty"`
}

======================================================= ProductAddItemRequest =======================================================

type ProductAddItemResponse added in v1.5.0

type ProductAddItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductAddItem `json:"response,omitempty"`
}

======================================================= ProductAddItemResponse =======================================================

type ProductAddItemSellerStock added in v1.5.4

type ProductAddItemSellerStock struct {
	// location_id is <p>location id<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemSellerStock =======================================================

type ProductAddItemStockInfo added in v1.5.4

type ProductAddItemStockInfo struct {
	// normal_stock is Normal stock
	NormalStock int `json:"normal_stock,omitempty"`
	// stock_type is Stock type
	StockType int `json:"stock_type,omitempty"`
	// current_stock is Current stock
	CurrentStock int `json:"current_stock,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemStockInfo =======================================================

type ProductAddItemVideoInfo added in v1.5.4

type ProductAddItemVideoInfo struct {
	// video_url is Video playback url
	VideoUrl string `json:"video_url,omitempty"`
	// thumbnail_url is Video preview image url
	ThumbnailUrl string `json:"thumbnail_url,omitempty"`
	// duration is Video duration
	Duration int `json:"duration,omitempty"`
}

======================================================= Object Raw Type - ProductAddItemVideoInfo =======================================================

type ProductAddItemWholesale added in v1.5.4

type ProductAddItemWholesale struct {
	// min_count is Minimum count of this tier
	MinCount int `json:"min_count,omitempty"`
	// max_count is Maximum count of this tier
	MaxCount int `json:"max_count,omitempty"`
	// unit_price is Unit price of this tier
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductAddItemWholesale =======================================================

type ProductAddModel added in v1.5.1

type ProductAddModel struct {
	// model is
	Model []ProductAddModelModel `json:"model"`
}

======================================================= Object Raw Type - ProductAddModel =======================================================

type ProductAddModelModel added in v1.5.4

type ProductAddModelModel struct {
	// tier_index is model tier index
	TierIndex []int `json:"tier_index,omitempty"`
	// model_id is ID of model
	ModelID int `json:"model_id,omitempty"`
	// model_sku is Seller SKU of this model, model_sku length information needs to be no more than 100 characters.
	ModelSku string `json:"model_sku,omitempty"`
	// stock_info is
	StockInfo []ProductAddModelModelStockInfo `json:"stock_info"`
	// price_info is
	PriceInfo []ProductAddModelModelPriceInfo `json:"price_info"`
	// seller_stock is <p>new stock info</p>
	SellerStock []ProductAddModelModelSellerStock `json:"seller_stock"`
}

======================================================= Object Raw Type - ProductAddModelModel =======================================================

type ProductAddModelModelPriceInfo added in v1.5.4

type ProductAddModelModelPriceInfo struct {
	// original_price is <p>Original Price.</p><p><font color="#c24f4a"><b>For CO local VAT responsible seller:</b></font>Please remember the price you set in here must be VAT inclusive. If you have any doubts on how to calculate VAT for your product please refer to the Seller Education Hub(https://seller.shopee.com.co/edu/article/13565)<br /></p>
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductAddModelModelPriceInfo =======================================================

type ProductAddModelModelSellerStock added in v1.5.4

type ProductAddModelModelSellerStock struct {
	// location_id is <p>location id<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductAddModelModelSellerStock =======================================================

type ProductAddModelModelStockInfo added in v1.5.4

type ProductAddModelModelStockInfo struct {
	// stock_type is Stock type, could be 1: WmsOnHand, 2: SellerOnHand
	StockType int `json:"stock_type,omitempty"`
	// normal_stock is Normal stock
	NormalStock int `json:"normal_stock,omitempty"`
}

======================================================= Object Raw Type - ProductAddModelModelStockInfo =======================================================

type ProductAddModelRequest added in v1.5.0

type ProductAddModelRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item
	ItemID int `json:"item_id"`
	// model_list is Model list
	ModelList []ModelList `json:"model_list"`
}

======================================================= ProductAddModelRequest =======================================================

type ProductAddModelResponse added in v1.5.0

type ProductAddModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductAddModel `json:"response"`
}

======================================================= ProductAddModelResponse =======================================================

type ProductBoostItem added in v1.5.1

type ProductBoostItem struct {
	// failure_list is
	FailureList []ProductBoostItemFailure `json:"failure_list"`
	// success_list is
	SuccessList ProductBoostItemSuccess `json:"success_list"`
}

======================================================= Object Raw Type - ProductBoostItem =======================================================

type ProductBoostItemFailure added in v1.5.5

type ProductBoostItemFailure struct {
	// item_id is Failed item ID.
	ItemID int `json:"item_id,omitempty"`
	// failed_reason is Reason for failure.
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - ProductBoostItemFailure =======================================================

type ProductBoostItemRequest added in v1.5.0

type ProductBoostItemRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is Shopee's unique identifier for an item, limit:[1,5]
	ItemIdList []int `json:"item_id_list"`
}

======================================================= ProductBoostItemRequest =======================================================

type ProductBoostItemResponse added in v1.5.0

type ProductBoostItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductBoostItem `json:"response"`
}

======================================================= ProductBoostItemResponse =======================================================

type ProductBoostItemSuccess added in v1.5.5

type ProductBoostItemSuccess struct {
	// item_id_list is Success item ID.
	ItemIdList []int `json:"item_id_list,omitempty"`
}

======================================================= Object Raw Type - ProductBoostItemSuccess =======================================================

type ProductCategoryRecommend added in v1.5.1

type ProductCategoryRecommend struct {
	// category_id is Shopee's unique identifier for a category.
	CategoryID []int `json:"category_id,omitempty"`
}

======================================================= Object Raw Type - ProductCategoryRecommend =======================================================

type ProductCategoryRecommendRequest added in v1.5.0

type ProductCategoryRecommendRequest struct {
	V2RequestAuthenticationParams

	// item_name is name of item
	ItemName string `json:"item_name"`
}

======================================================= ProductCategoryRecommendRequest =======================================================

type ProductCategoryRecommendResponse added in v1.5.0

type ProductCategoryRecommendResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductCategoryRecommend `json:"response"`
}

======================================================= ProductCategoryRecommendResponse =======================================================

type ProductDeleteItemRequest added in v1.5.0

type ProductDeleteItemRequest struct {
	V2RequestAuthenticationParams

	// item_id is The identity of product item.
	ItemID int `json:"item_id"`
}

======================================================= ProductDeleteItemRequest =======================================================

type ProductDeleteItemResponse added in v1.5.0

type ProductDeleteItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductDeleteItemResponse =======================================================

type ProductDeleteModelRequest added in v1.5.0

type ProductDeleteModelRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// model_id is ID of model.
	ModelID int `json:"model_id"`
}

======================================================= ProductDeleteModelRequest =======================================================

type ProductDeleteModelResponse added in v1.5.0

type ProductDeleteModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductDeleteModelResponse =======================================================

type ProductGetAttributes added in v1.5.1

type ProductGetAttributes struct {
	// attribute_list is Attribute info list.
	AttributeList []ProductGetAttributesAttribute `json:"attribute_list"`
}

======================================================= Object Raw Type - ProductGetAttributes =======================================================

type ProductGetAttributesAttribute added in v1.5.5

type ProductGetAttributesAttribute struct {
	// attribute_id is ID of attribute.
	AttributeID int `json:"attribute_id,omitempty"`
	// original_attribute_name is Attribute default name.
	OriginalAttributeName string `json:"original_attribute_name,omitempty"`
	// display_attribute_name is Attribute display name.
	DisplayAttributeName string `json:"display_attribute_name,omitempty"`
	// is_mandatory is Whether is mandatory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// input_validation_type is Attribute input validation type : INT_TYPE STRING_TYPE ENUM_TYPE FLOAT_TYPE DATE_TYPE TIMESTAMP_TYPE
	InputValidationType string `json:"input_validation_type,omitempty"`
	// format_type is Attribute format type: NORMAL QUANTITATIVE .
	FormatType string `json:"format_type,omitempty"`
	// date_format_type is Attribute date format type:YEAR_MONTH_DATE YEAR_MONTH.
	DateFormatType string `json:"date_format_type,omitempty"`
	// input_type is Attribute input type: DROP_DOWN MULTIPLE_SELECT TEXT_FILED COMBO_BOX MULTIPLE_SELECT_COMBO_BOX.
	InputType string `json:"input_type,omitempty"`
	// attribute_unit is All applicable attribute units
	AttributeUnit []string `json:"attribute_unit,omitempty"`
	// attribute_value_list is Value list of this attribute.
	AttributeValueList []ProductGetAttributesAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - ProductGetAttributesAttribute =======================================================

type ProductGetAttributesAttributeAttributeValue added in v1.5.5

type ProductGetAttributesAttributeAttributeValue struct {
	// value_id is ID of attribute value.
	ValueID int `json:"value_id,omitempty"`
	// original_value_name is Original name of value.
	OriginalValueName string `json:"original_value_name,omitempty"`
	// display_value_name is Display name of value.
	DisplayValueName string `json:"display_value_name,omitempty"`
	// value_unit is Unit of value(quantitative attribute only).
	ValueUnit string `json:"value_unit,omitempty"`
	// parent_attribute_list is
	ParentAttributeList []ProductGetAttributesAttributeAttributeValueParentAttribute `json:"parent_attribute_list"`
	// parent_brand_list is
	ParentBrandList []ProductGetAttributesAttributeAttributeValueParentBrand `json:"parent_brand_list"`
}

======================================================= Object Raw Type - ProductGetAttributesAttributeAttributeValue =======================================================

type ProductGetAttributesAttributeAttributeValueParentAttribute added in v1.5.5

type ProductGetAttributesAttributeAttributeValueParentAttribute struct {
	// parent_attribute_id is ID of parent attribute.
	ParentAttributeID int `json:"parent_attribute_id,omitempty"`
	// parent_value_id is ID of parent attribute value.
	ParentValueID int `json:"parent_value_id,omitempty"`
}

======================================================= Object Raw Type - ProductGetAttributesAttributeAttributeValueParentAttribute =======================================================

type ProductGetAttributesAttributeAttributeValueParentBrand added in v1.5.5

type ProductGetAttributesAttributeAttributeValueParentBrand struct {
	// parent_brand_id is ID of parent brand.
	ParentBrandID int `json:"parent_brand_id,omitempty"`
}

======================================================= Object Raw Type - ProductGetAttributesAttributeAttributeValueParentBrand =======================================================

type ProductGetAttributesRequest added in v1.5.0

type ProductGetAttributesRequest struct {
	V2RequestAuthenticationParams

	// language is <p>If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ;  BR: en / pt-br ;  MX: en / es-mx ; PL: pl ; CO: en/es-CO ; CL: en/es-CL ; FR: en/fr ; ES: en/es-ES ; AR: en / es-ar . Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data</p>
	Language string `json:"language,omitempty"`
	// category_id is ID of category.
	CategoryID int `json:"category_id"`
}

======================================================= ProductGetAttributesRequest =======================================================

type ProductGetAttributesResponse added in v1.5.0

type ProductGetAttributesResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetAttributes `json:"response"`
}

======================================================= ProductGetAttributesResponse =======================================================

type ProductGetBoostedList added in v1.5.1

type ProductGetBoostedList struct {
	// item_list is
	ItemList []ProductGetBoostedListItem `json:"item_list"`
}

======================================================= Object Raw Type - ProductGetBoostedList =======================================================

type ProductGetBoostedListItem added in v1.5.5

type ProductGetBoostedListItem struct {
	// item_id is Shopee's unique identifier for an item
	ItemID int `json:"item_id,omitempty"`
	// cool_down_second is Remain cool down time
	CoolDownSecond int `json:"cool_down_second,omitempty"`
}

======================================================= Object Raw Type - ProductGetBoostedListItem =======================================================

type ProductGetBoostedListRequest added in v1.5.0

type ProductGetBoostedListRequest struct {
	V2RequestAuthenticationParams
}

======================================================= ProductGetBoostedListRequest =======================================================

type ProductGetBoostedListResponse added in v1.5.0

type ProductGetBoostedListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetBoostedList `json:"response"`
}

======================================================= ProductGetBoostedListResponse =======================================================

type ProductGetBrandList added in v1.5.1

type ProductGetBrandList struct {
	// brand_list is
	BrandList []ProductGetBrandListBrand `json:"brand_list"`
	// has_next_page is  This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	HasNextPage bool `json:"has_next_page,omitempty"`
	// next_offset is If has_next_page is true, this value need set to next request.offset
	NextOffset int `json:"next_offset,omitempty"`
	// is_mandatory is Whether is mandatory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// input_type is Input type: DROP_DOWN  TEXT_FILED COMBO_BOX.
	InputType string `json:"input_type,omitempty"`
}

======================================================= Object Raw Type - ProductGetBrandList =======================================================

type ProductGetBrandListBrand added in v1.5.5

type ProductGetBrandListBrand struct {
	// original_brand_name is Original name of brand
	OriginalBrandName string `json:"original_brand_name,omitempty"`
	// brand_id is
	BrandID int `json:"brand_id,omitempty"`
	// display_brand_name is Display name of brand
	DisplayBrandName string `json:"display_brand_name,omitempty"`
}

======================================================= Object Raw Type - ProductGetBrandListBrand =======================================================

type ProductGetBrandListRequest added in v1.5.0

type ProductGetBrandListRequest struct {
	V2RequestAuthenticationParams

	// offset is Specifies the starting entry of data to return in the current call. Default is 0. If data is more than one page,this field needs to be replaced with "next_offset" to request,and the offset can be some entry to start next call.
	Offset int `json:"offset,omitempty"`
	// page_size is the size of one page.Max=100
	PageSize int `json:"page_size"`
	// category_id is ID of category.
	CategoryID int `json:"category_id"`
	// status is Brand status , 1: normal brand, 2: pending brand
	Status int `json:"status"`
	// language is <p>If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ;  BR: en / pt-br ;  MX: en / es-mx ; PL: pl ; CO: en/es-CO ; CL: en/es-CL ; FR: en/fr ; ES: en/es-ES ; AR: en/ es-ar . Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data</p>
	Language string `json:"language,omitempty"`
}

======================================================= ProductGetBrandListRequest =======================================================

type ProductGetBrandListResponse added in v1.5.0

type ProductGetBrandListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetBrandList `json:"response,omitempty"`
}

======================================================= ProductGetBrandListResponse =======================================================

type ProductGetCategory added in v1.5.1

type ProductGetCategory struct {
	// category_list is
	CategoryList []ProductGetCategoryCategory `json:"category_list"`
}

======================================================= Object Raw Type - ProductGetCategory =======================================================

type ProductGetCategoryCategory added in v1.5.5

type ProductGetCategoryCategory struct {
	// category_id is ID for category.
	CategoryID int `json:"category_id,omitempty"`
	// parent_category_id is ID for parent category.
	ParentCategoryID int `json:"parent_category_id,omitempty"`
	// original_category_name is Default name for category.
	OriginalCategoryName string `json:"original_category_name,omitempty"`
	// display_category_name is Display name dependent on display name.
	DisplayCategoryName string `json:"display_category_name,omitempty"`
	// has_children is Whether this category has active children category.
	HasChildren bool `json:"has_children,omitempty"`
}

======================================================= Object Raw Type - ProductGetCategoryCategory =======================================================

type ProductGetCategoryRequest added in v1.5.0

type ProductGetCategoryRequest struct {
	V2RequestAuthenticationParams

	// language is <p>If language is not uploaded, the default language=en, the following are the languages supported by different markets SG: en ; MY: en / ms-my / zh-hans ; TH: en / th ; VN: en / vi ; PH: en ; TW: en / zh-hant ; ID: en / id ;  BR: en / pt-br ;  MX: en / es-mx ; PL: pl ; CO: en/es-CO ; CL: en/es-CL ; FR: en/fr ; ES: en/es-ES ; AR:en / es-ar Note: For markets that have already launched global tree, Crossboard shop only support returning en and zh-hans language data</p>
	Language string `json:"language,omitempty"`
}

======================================================= ProductGetCategoryRequest =======================================================

type ProductGetCategoryResponse added in v1.5.0

type ProductGetCategoryResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetCategory `json:"response,omitempty"`
}

======================================================= ProductGetCategoryResponse =======================================================

type ProductGetComment added in v1.5.1

type ProductGetComment struct {
	// more is <p>This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments. But only respond 500 comments at most through OpenAPI, if there are more than 500, this field "more" also respond "true".</p>
	More bool `json:"more,omitempty"`
	// item_comment_list is The comment data list of the items.
	ItemCommentList []ProductGetCommentItemComment `json:"item_comment_list"`
	// next_cursor is If more is true, you should pass the next_cursor in the next request as cursor. The value of next_cursor will be empty string when more is false.
	NextCursor string `json:"next_cursor,omitempty"`
}

======================================================= Object Raw Type - ProductGetComment =======================================================

type ProductGetCommentItemComment added in v1.5.5

type ProductGetCommentItemComment struct {
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// comment_id is The identity of comment.
	CommentID string `json:"comment_id,omitempty"`
	// comment is The content of the comment.
	Comment string `json:"comment,omitempty"`
	// buyer_username is The username of the buyer who posted the comment.
	BuyerUsername string `json:"buyer_username,omitempty"`
	// item_id is The commented item's id
	ItemID int `json:"item_id,omitempty"`
	// model_id is <p>Shopee's unique identifier for a model of an item.It will only return 0 now.</p>
	ModelID int `json:"model_id,omitempty"`
	// rating_star is Buyer's rating for the item.
	RatingStar int `json:"rating_star,omitempty"`
	// editable is The editable status of the comment. The value may be one of  EXPIRED/EDITABLE/HAVE_EDIT_ONCE.
	Editable string `json:"editable,omitempty"`
	// hidden is The comment is hidden or not.
	Hidden bool `json:"hidden,omitempty"`
	// create_time is The create time of the comment.
	CreateTime int `json:"create_time,omitempty"`
	// comment_reply is The reply of the comment.
	CommentReply ProductGetCommentItemCommentCommentReply `json:"comment_reply"`
}

======================================================= Object Raw Type - ProductGetCommentItemComment =======================================================

type ProductGetCommentItemCommentCommentReply added in v1.5.5

type ProductGetCommentItemCommentCommentReply struct {
	// reply is The content of reply.
	Reply string `json:"reply,omitempty"`
	// hidden is The comment reply is hidden or not.
	Hidden bool `json:"hidden,omitempty"`
}

======================================================= Object Raw Type - ProductGetCommentItemCommentCommentReply =======================================================

type ProductGetCommentRequest added in v1.5.0

type ProductGetCommentRequest struct {
	V2RequestAuthenticationParams

	// item_id is The identity of product item.
	ItemID int `json:"item_id,omitempty"`
	// comment_id is The identity of comment.
	CommentID int `json:"comment_id,omitempty"`
	// cursor is Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call.
	Cursor string `json:"cursor"`
	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call). This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100.
	PageSize int `json:"page_size"`
}

======================================================= ProductGetCommentRequest =======================================================

type ProductGetCommentResponse added in v1.5.0

type ProductGetCommentResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response ProductGetComment `json:"response"`
}

======================================================= ProductGetCommentResponse =======================================================

type ProductGetDtsLimit added in v1.5.1

type ProductGetDtsLimit struct {
	// days_to_ship_limit is
	DaysToShipLimit ProductGetDtsLimitDaysToShipLimit `json:"days_to_ship_limit"`
	// non_pre_order_days_to_ship is Non pre order days to ship
	NonPreOrderDaysToShip int `json:"non_pre_order_days_to_ship,omitempty"`
}

======================================================= Object Raw Type - ProductGetDtsLimit =======================================================

type ProductGetDtsLimitDaysToShipLimit added in v1.5.4

type ProductGetDtsLimitDaysToShipLimit struct {
	// min_limit is Days to ship min limit
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Days to ship max limit
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetDtsLimitDaysToShipLimit =======================================================

type ProductGetDtsLimitRequest added in v1.5.0

type ProductGetDtsLimitRequest struct {
	V2RequestAuthenticationParams

	// category_id is Shopee's unique identifier for an category.
	CategoryID int `json:"category_id"`
}

======================================================= ProductGetDtsLimitRequest =======================================================

type ProductGetDtsLimitResponse added in v1.5.0

type ProductGetDtsLimitResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetDtsLimit `json:"response"`
}

======================================================= ProductGetDtsLimitResponse =======================================================

type ProductGetItemBaseInfo added in v1.5.1

type ProductGetItemBaseInfo struct {
	// item_list is
	ItemList []ProductGetItemBaseInfoItem `json:"item_list"`
	// description_info is New description  field. Only whitelist sellers can use it.
	DescriptionInfo ProductGetItemBaseInfoDescriptionInfo `json:"description_info"`
	// description_type is Type of description : values: See Data Definition- description_type (normal , extended).
	DescriptionType string `json:"description_type,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfo =======================================================

type ProductGetItemBaseInfoDescriptionInfo added in v1.5.4

type ProductGetItemBaseInfoDescriptionInfo struct {
	// extended_description is  If description_type is extended , Description information will be returned through this field.
	ExtendedDescription ProductGetItemBaseInfoDescriptionInfoExtendedDescription `json:"extended_description"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoDescriptionInfo =======================================================

type ProductGetItemBaseInfoDescriptionInfoExtendedDescription added in v1.5.4

type ProductGetItemBaseInfoDescriptionInfoExtendedDescription struct {
	// field_list is Field of extended description
	FieldList []ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionField `json:"field_list"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoDescriptionInfoExtendedDescription =======================================================

type ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionField added in v1.5.5

type ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field :values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be returned through this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image, image url will be returned through this field.
	ImageInfo ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionField =======================================================

type ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id
	ImageID string `json:"image_id,omitempty"`
	// image_url is Image url.
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoDescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type ProductGetItemBaseInfoItem added in v1.5.5

type ProductGetItemBaseInfoItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// category_id is Shopee's unique identifier for a category.
	CategoryID int `json:"category_id,omitempty"`
	// item_name is Name of the item in local language.
	ItemName string `json:"item_name,omitempty"`
	// description is if description_type is normal , Description information will be returned through this field,else description will be empty
	Description string `json:"description,omitempty"`
	// item_sku is An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSku string `json:"item_sku,omitempty"`
	// create_time is Timestamp that indicates the date and time that the item was created.
	CreateTime int `json:"create_time,omitempty"`
	// update_time is Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// attribute_list is
	AttributeList []ProductGetItemBaseInfoItemAttribute `json:"attribute_list"`
	// price_info is If the item has models, price_info will not be returned. Please get the price of each model through the get_model_list api
	PriceInfo []ProductGetItemBaseInfoItemPriceInfo `json:"price_info"`
	// stock_info is <p>if the item has models, this field will not be returned, please get it through get_model_list api.</p><p><b><font color="#c24f4a">Please use the stock_info_v2 field instead, we will deprecate this field in the future.</font></b><br /></p>
	StockInfo []ProductGetItemBaseInfoItemStockInfo `json:"stock_info"`
	// image is
	Image ProductGetItemBaseInfoItemImage `json:"image"`
	// weight is The net weight of this item, the unit is KG.
	Weight string `json:"weight,omitempty"`
	// dimension is The dimension of this item.
	Dimension ProductGetItemBaseInfoItemDimension `json:"dimension"`
	// logistic_info is The logistics list.
	LogisticInfo []ProductGetItemBaseInfoItemLogisticInfo `json:"logistic_info"`
	// pre_order is
	PreOrder ProductGetItemBaseInfoItemPreOrder `json:"pre_order"`
	// wholesales is The wholesales tier list.
	Wholesales []ProductGetItemBaseInfoItemWholesale `json:"wholesales"`
	// condition is Is it second-hand.
	Condition string `json:"condition,omitempty"`
	// size_chart is Url of size chart image.
	SizeChart string `json:"size_chart,omitempty"`
	// item_status is Enumerated type that defines the current status of the item. Applicable values: NORMAL, DELETED, BANNED and UNLIST.
	ItemStatus string `json:"item_status,omitempty"`
	// has_model is Does it contain model.
	HasModel bool `json:"has_model,omitempty"`
	// promotion_id is
	PromotionID int `json:"promotion_id,omitempty"`
	// video_info is Info of video list.
	VideoInfo []ProductGetItemBaseInfoItemVideoInfo `json:"video_info"`
	// brand is
	Brand ProductGetItemBaseInfoItemBrand `json:"brand"`
	// item_dangerous is This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
	ItemDangerous int `json:"item_dangerous,omitempty"`
	// complaint_policy is <p>Time for a warranty claim.Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.<br /></p>
	ComplaintPolicy ProductGetItemBaseInfoItemComplaintPolicy `json:"complaint_policy"`
	// tax_info is <p>Tax information<br /></p>
	TaxInfo ProductGetItemBaseInfoItemTaxInfo `json:"tax_info"`
	// stock_info_v2 is <p>new stock object.<br /></p><p>Please check this FAQ for more detail:<a style="font-size:14px;">https://open.shopee.com/faq?top=162&amp;sub=166&amp;page=1&amp;faq=230</a></p><a href="https://open.shopee.com/faq?top=162&amp;sub=166&amp;page=1&amp;faq=230" target="_blank"></a>
	StockInfoV2 ProductGetItemBaseInfoItemStockInfoV2 `json:"stock_info_v2"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItem =======================================================

type ProductGetItemBaseInfoItemAttribute added in v1.5.5

type ProductGetItemBaseInfoItemAttribute struct {
	// attribute_id is The Identify of each category.
	AttributeID int `json:"attribute_id,omitempty"`
	// original_attribute_name is The name of each attribute.
	OriginalAttributeName string `json:"original_attribute_name,omitempty"`
	// is_mandatory is This is to indicate whether this attribute is mandantory.
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// attribute_value_list is
	AttributeValueList []ProductGetItemBaseInfoItemAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemAttribute =======================================================

type ProductGetItemBaseInfoItemAttributeAttributeValue added in v1.5.5

type ProductGetItemBaseInfoItemAttributeAttributeValue struct {
	// value_id is Unique identifier for value of this item attribute.
	ValueID int `json:"value_id,omitempty"`
	// original_value_name is Value name of this item attribute.
	OriginalValueName string `json:"original_value_name,omitempty"`
	// value_unit is Value unit of this item attribute.
	ValueUnit string `json:"value_unit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemAttributeAttributeValue =======================================================

type ProductGetItemBaseInfoItemBrand added in v1.5.5

type ProductGetItemBaseInfoItemBrand struct {
	// brand_id is Id of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is Original name of brand.
	OriginalBrandName string `json:"original_brand_name,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemBrand =======================================================

type ProductGetItemBaseInfoItemComplaintPolicy added in v1.5.5

type ProductGetItemBaseInfoItemComplaintPolicy struct {
	// warranty_time is <p>Time for a warranty claim.Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.<br /></p>
	WarrantyTime string `json:"warranty_time,omitempty"`
	// exclude_entrepreneur_warranty is <p>If True means "I exclude warranty complaints for entrepreneur"<br /></p>
	ExcludeEntrepreneurWarranty bool `json:"exclude_entrepreneur_warranty,omitempty"`
	// complaint_address_id is <p>The identity of complaint address.<br /></p>
	ComplaintAddressID int `json:"complaint_address_id,omitempty"`
	// additional_information is <p>Additional information for complaint policy<br /></p>
	AdditionalInformation string `json:"additional_information,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemComplaintPolicy =======================================================

type ProductGetItemBaseInfoItemDimension added in v1.5.5

type ProductGetItemBaseInfoItemDimension struct {
	// package_length is The length of package for this single item, the unit is CM.
	PackageLength int `json:"package_length,omitempty"`
	// package_width is The width of package for this single item, the unit is CM.
	PackageWidth int `json:"package_width,omitempty"`
	// package_height is The height of package for this single item, the unit is CM.
	PackageHeight int `json:"package_height,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemDimension =======================================================

type ProductGetItemBaseInfoItemImage added in v1.5.5

type ProductGetItemBaseInfoItemImage struct {
	// image_url_list is List of image url.
	ImageUrlList []string `json:"image_url_list,omitempty"`
	// image_id_list is List of image id.
	ImageIdList []string `json:"image_id_list,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemImage =======================================================

type ProductGetItemBaseInfoItemLogisticInfo added in v1.5.5

type ProductGetItemBaseInfoItemLogisticInfo struct {
	// logistic_id is The identity of logistic channel.
	LogisticID int `json:"logistic_id,omitempty"`
	// logistic_name is The name of logistic.
	LogisticName string `json:"logistic_name,omitempty"`
	// enabled is Related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item.
	Enabled bool `json:"enabled,omitempty"`
	// shipping_fee is Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// size_id is If specify logistic fee_type is SIZE_SELECTION size_id is required.
	SizeID int `json:"size_id,omitempty"`
	// is_free is when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
	// estimated_shipping_fee is Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemLogisticInfo =======================================================

type ProductGetItemBaseInfoItemPreOrder added in v1.5.5

type ProductGetItemBaseInfoItemPreOrder struct {
	// is_pre_order is  Pre-order will be set true.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
	// days_to_ship is The days to ship. Only work for pre-order, it means this value should be bigger than 7.
	DaysToShip int `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemPreOrder =======================================================

type ProductGetItemBaseInfoItemPriceInfo added in v1.5.5

type ProductGetItemBaseInfoItemPriceInfo struct {
	// currency is The three-digit code representing the currency unit used for the item in Shopee Listings.
	Currency string `json:"currency,omitempty"`
	// original_price is The original price of the item in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// current_price is The current price of the item in the listing currency. If product under a onging promotion, current_price will be the promotion price
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// inflated_price_of_original_price is The After-tax original price of the item in the listing currency.
	InflatedPriceOfOriginalPrice float64 `json:"inflated_price_of_original_price,omitempty,string"`
	// inflated_price_of_current_price is The After-tax current price of the item in the listing currency.
	InflatedPriceOfCurrentPrice float64 `json:"inflated_price_of_current_price,omitempty,string"`
	// sip_item_price is The price of the item in sip.If item is for CNSC primary shop, this field will not be returned
	SipItemPrice float64 `json:"sip_item_price,omitempty,string"`
	// sip_item_price_source is  source of sip' price. ( auto or manual).If item is for CNSC SIP primary shop, this field will not be returned
	SipItemPriceSource string `json:"sip_item_price_source,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemPriceInfo =======================================================

type ProductGetItemBaseInfoItemStockInfo added in v1.5.5

type ProductGetItemBaseInfoItemStockInfo struct {
	// stock_type is The stock type. Applicable values: See Data Definition- StockType.
	StockType int `json:"stock_type,omitempty"`
	// stock_location_id is location_id of the stock.
	StockLocationID string `json:"stock_location_id,omitempty"`
	// current_stock is  Current available inventory, if item under promotion, it will be promotion stock, if not, it will be normal_stock
	CurrentStock int `json:"current_stock,omitempty"`
	// normal_stock is  The stock set by the seller.
	NormalStock int `json:"normal_stock,omitempty"`
	// reserved_stock is Promotion stock. Sellers can set Promotion stock for some promotion, which can only be used during the event. If the item with multiple promotion, this value is the total number of locked stocks for multiple promotions
	ReservedStock int `json:"reserved_stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemStockInfo =======================================================

type ProductGetItemBaseInfoItemStockInfoV2 added in v1.5.5

type ProductGetItemBaseInfoItemStockInfoV2 struct {
	// summary_info is <p>stock summary info<br /></p>
	SummaryInfo ProductGetItemBaseInfoItemStockInfoV2SummaryInfo `json:"summary_info"`
	// seller_stock is <p>seller stock<br /></p>
	SellerStock []ProductGetItemBaseInfoItemStockInfoV2SellerStock `json:"seller_stock"`
	// shopee_stock is <p>shopee stock<br /></p>
	ShopeeStock []ProductGetItemBaseInfoItemStockInfoV2ShopeeStock `json:"shopee_stock"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemStockInfoV2 =======================================================

type ProductGetItemBaseInfoItemStockInfoV2SellerStock added in v1.5.5

type ProductGetItemBaseInfoItemStockInfoV2SellerStock struct {
	// location_id is
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock in the current warehouse<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemStockInfoV2SellerStock =======================================================

type ProductGetItemBaseInfoItemStockInfoV2ShopeeStock added in v1.5.5

type ProductGetItemBaseInfoItemStockInfoV2ShopeeStock struct {
	// location_id is
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock in the current warehouse<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemStockInfoV2ShopeeStock =======================================================

type ProductGetItemBaseInfoItemStockInfoV2SummaryInfo added in v1.5.5

type ProductGetItemBaseInfoItemStockInfoV2SummaryInfo struct {
	// total_reserved_stock is <p>total reserved stock<br /></p>
	TotalReservedStock int `json:"total_reserved_stock,omitempty"`
	// total_available_stock is <p>total available stock<br /></p>
	TotalAvailableStock int `json:"total_available_stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemStockInfoV2SummaryInfo =======================================================

type ProductGetItemBaseInfoItemTaxInfo added in v1.5.5

type ProductGetItemBaseInfoItemTaxInfo struct {
	// ncm is <p>Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves.(<b><font color="#c24f4a">only for BR region</font></b>)<br /></p>
	Ncm string `json:"ncm,omitempty"`
	// diff_state_cfop is <p>Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice. (<b><font color="#c24f4a">only for BR region</font></b>)<br /></p>
	DiffStateCfop string `json:"diff_state_cfop,omitempty"`
	// csosn is <p>Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations. (<b><font color="#c24f4a">only for BR region</font></b>)<br /></p>
	CsoSN string `json:"csosn,omitempty"`
	// origin is <p>Product source, domestic or foreig (<b><font color="#c24f4a">only for BR region)</font></b><br /></p>
	Origin string `json:"origin,omitempty"`
	// cest is <p>(<font color="#c24f4a" style><b>only for BR region</b></font>)<br /></p>
	Cest string `json:"cest,omitempty"`
	// measure_unit is <p>(<b><font color="#c24f4a">only for BR region</font></b>)<br /></p>
	MeasureUnit string `json:"measure_unit,omitempty"`
	// invoice_option is <p>Value shuold be one of <b>NO_INVOICES VAT_MARGIN_SCHEME_INVOICES</b> / <b>VAT_INVOICES /</b> <b>NON_VAT_INVOICES</b> and if value is NON_VAT_INVOICE vat_rate should be null (<b><font color="#c24f4a">only for PL region</font></b>)<br /></p>
	InvoiceOption string `json:"invoice_option,omitempty"`
	// vat_rate is <p>Value should be one of <b>0%</b> / <b>5%</b> / <b>8%</b> / <b>23%</b>&nbsp;/ <b>NO_VAT_RATE</b> (<b><font color="#c24f4a">only for PL region</font></b>)<br /></p>
	VatRate string `json:"vat_rate,omitempty"`
	// hs_code is <p>HS Code (<b><font color="#c24f4a">Only for IN region</font></b>)<br /></p>
	HsCode string `json:"hs_code,omitempty"`
	// tax_code is <p>Tax Code (<b><font color="#c24f4a">Only for IN region</font></b>)<br /></p>
	TaxCode string `json:"tax_code,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemTaxInfo =======================================================

type ProductGetItemBaseInfoItemVideoInfo added in v1.5.5

type ProductGetItemBaseInfoItemVideoInfo struct {
	// video_url is Url of video.
	VideoUrl string `json:"video_url,omitempty"`
	// thumbnail_url is Thumbnail of video.
	ThumbnailUrl string `json:"thumbnail_url,omitempty"`
	// duration is Duration of video.
	Duration int `json:"duration,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemVideoInfo =======================================================

type ProductGetItemBaseInfoItemWholesale added in v1.5.5

type ProductGetItemBaseInfoItemWholesale struct {
	// min_count is The min count of this tier wholesale.
	MinCount int `json:"min_count,omitempty"`
	// max_count is The max count of this tier wholesale.
	MaxCount int `json:"max_count,omitempty"`
	// unit_price is The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
	UnitPrice float64 `json:"unit_price,omitempty,string"`
	// inflated_price_of_unit_price is The After-tax Price of the wholesale show to buyer.
	InflatedPriceOfUnitPrice float64 `json:"inflated_price_of_unit_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductGetItemBaseInfoItemWholesale =======================================================

type ProductGetItemBaseInfoRequest added in v1.5.0

type ProductGetItemBaseInfoRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is item_id list; limit [0,50]
	ItemIdList []int `json:"item_id_list"`
	// need_tax_info is if true will response tax_info
	NeedTaxInfo bool `json:"need_tax_info,omitempty"`
	// need_complaint_policy is if true will response complaint_policy
	NeedComplaintPolicy bool `json:"need_complaint_policy,omitempty"`
}

======================================================= ProductGetItemBaseInfoRequest =======================================================

type ProductGetItemBaseInfoResponse added in v1.5.0

type ProductGetItemBaseInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetItemBaseInfo `json:"response,omitempty"`
}

======================================================= ProductGetItemBaseInfoResponse =======================================================

type ProductGetItemExtraInfo added in v1.5.1

type ProductGetItemExtraInfo struct {
	// item_list is extra info of item list.
	ItemList []ProductGetItemExtraInfoItem `json:"item_list"`
}

======================================================= Object Raw Type - ProductGetItemExtraInfo =======================================================

type ProductGetItemExtraInfoItem added in v1.5.5

type ProductGetItemExtraInfoItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// sale is The sales volume of item.
	Sale int `json:"sale,omitempty"`
	// views is The page view of item.
	Views int `json:"views,omitempty"`
	// likes is The collection number of item.
	Likes int `json:"likes,omitempty"`
	// rating_star is The rating star scores of this item.
	RatingStar float64 `json:"rating_star,omitempty,string"`
	// comment_count is Count of comments for the item.
	CommentCount int `json:"comment_count,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemExtraInfoItem =======================================================

type ProductGetItemExtraInfoRequest added in v1.5.0

type ProductGetItemExtraInfoRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is  item_id list, limit [0,50]
	ItemIdList []int `json:"item_id_list"`
}

======================================================= ProductGetItemExtraInfoRequest =======================================================

type ProductGetItemExtraInfoResponse added in v1.5.0

type ProductGetItemExtraInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetItemExtraInfo `json:"response"`
}

======================================================= ProductGetItemExtraInfoResponse =======================================================

type ProductGetItemLimit added in v1.5.1

type ProductGetItemLimit struct {
	// price_limit is
	PriceLimit ProductGetItemLimitPriceLimit `json:"price_limit"`
	// wholesale_price_threshold_percentage is
	WholesalePriceThresholdPercentage ProductGetItemLimitWholesalePriceThresholdPercentage `json:"wholesale_price_threshold_percentage"`
	// stock_limit is
	StockLimit ProductGetItemLimitStockLimit `json:"stock_limit"`
	// item_name_length_limit is
	ItemNameLengthLimit ProductGetItemLimitItemNameLengthLimit `json:"item_name_length_limit"`
	// item_image_count_limit is
	ItemImageCountLimit ProductGetItemLimitItemImageCountLimit `json:"item_image_count_limit"`
	// item_description_length_limit is
	ItemDescriptionLengthLimit ProductGetItemLimitItemDescriptionLengthLimit `json:"item_description_length_limit"`
	// tier_variation_name_length_limit is
	TierVariationNameLengthLimit ProductGetItemLimitTierVariationNameLengthLimit `json:"tier_variation_name_length_limit"`
	// tier_variation_option_length_limit is
	TierVariationOptionLengthLimit ProductGetItemLimitTierVariationOptionLengthLimit `json:"tier_variation_option_length_limit"`
	// item_count_limit is
	ItemCountLimit ProductGetItemLimitItemCountLimit `json:"item_count_limit"`
	// extended_description_limit is
	ExtendedDescriptionLimit ProductGetItemLimitExtendedDescriptionLimit `json:"extended_description_limit"`
}

======================================================= Object Raw Type - ProductGetItemLimit =======================================================

type ProductGetItemLimitExtendedDescriptionLimit added in v1.5.4

type ProductGetItemLimitExtendedDescriptionLimit struct {
	// description_text_length_min is length min limit for item extended description text part, when one of the minimum limits for image and text is reached, the item can be added or updated successfully.
	DescriptionTextLengthMin int `json:"description_text_length_min,omitempty"`
	// description_text_length_max is length max limit for item extended description text part
	DescriptionTextLengthMax int `json:"description_text_length_max,omitempty"`
	// description_image_num_min is length min limit for item extended description image num, when one of the minimum limits for image and text is reached, the item can be added or updated successfully.
	DescriptionImageNumMin int `json:"description_image_num_min,omitempty"`
	// description_image_num_max is length max limit for item extended description image num
	DescriptionImageNumMax int `json:"description_image_num_max,omitempty"`
	// description_image_width_min is length min limit for item extended description image width
	DescriptionImageWidthMin int `json:"description_image_width_min,omitempty"`
	// description_image_height_min is length min limit for item extended description image hight
	DescriptionImageHeightMin int `json:"description_image_height_min,omitempty"`
	// description_image_aspect_ratio_min is length min limit for item extended description image aspect  ( aspect_ratio= image width / image hight )
	DescriptionImageAspectRatioMin float64 `json:"description_image_aspect_ratio_min,omitempty,string"`
	// description_image_aspect_ratio_max is length max limit for item extended description image aspect ( aspect_ratio= image width / image hight )
	DescriptionImageAspectRatioMax float64 `json:"description_image_aspect_ratio_max,omitempty,string"`
}

======================================================= Object Raw Type - ProductGetItemLimitExtendedDescriptionLimit =======================================================

type ProductGetItemLimitItemCountLimit added in v1.5.4

type ProductGetItemLimitItemCountLimit struct {
	// max_limit is Item count max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitItemCountLimit =======================================================

type ProductGetItemLimitItemDescriptionLengthLimit added in v1.5.4

type ProductGetItemLimitItemDescriptionLengthLimit struct {
	// min_limit is Item description length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item description length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitItemDescriptionLengthLimit =======================================================

type ProductGetItemLimitItemImageCountLimit added in v1.5.4

type ProductGetItemLimitItemImageCountLimit struct {
	// min_limit is Item image count min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item image count max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitItemImageCountLimit =======================================================

type ProductGetItemLimitItemNameLengthLimit added in v1.5.4

type ProductGetItemLimitItemNameLengthLimit struct {
	// min_limit is Item name length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item name length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitItemNameLengthLimit =======================================================

type ProductGetItemLimitPriceLimit added in v1.5.4

type ProductGetItemLimitPriceLimit struct {
	// min_limit is Item price max limit.
	MinLimit float64 `json:"min_limit,omitempty,string"`
	// max_limit is Item price min limit.
	MaxLimit float64 `json:"max_limit,omitempty,string"`
}

======================================================= Object Raw Type - ProductGetItemLimitPriceLimit =======================================================

type ProductGetItemLimitRequest added in v1.5.0

type ProductGetItemLimitRequest struct {
	V2RequestAuthenticationParams
}

======================================================= ProductGetItemLimitRequest =======================================================

type ProductGetItemLimitResponse added in v1.5.0

type ProductGetItemLimitResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetItemLimit `json:"response"`
}

======================================================= ProductGetItemLimitResponse =======================================================

type ProductGetItemLimitStockLimit added in v1.5.4

type ProductGetItemLimitStockLimit struct {
	// min_limit is Item stock min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item stock max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitStockLimit =======================================================

type ProductGetItemLimitTierVariationNameLengthLimit added in v1.5.4

type ProductGetItemLimitTierVariationNameLengthLimit struct {
	// min_limit is Item tier variation name length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item tier variation name length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitTierVariationNameLengthLimit =======================================================

type ProductGetItemLimitTierVariationOptionLengthLimit added in v1.5.4

type ProductGetItemLimitTierVariationOptionLengthLimit struct {
	// min_limit is Item tier variation option length min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item tier variation option length max limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitTierVariationOptionLengthLimit =======================================================

type ProductGetItemLimitWholesalePriceThresholdPercentage added in v1.5.4

type ProductGetItemLimitWholesalePriceThresholdPercentage struct {
	// min_limit is Item wholesale price percentage of original price min limit.
	MinLimit int `json:"min_limit,omitempty"`
	// max_limit is Item wholesale price percentage of original price min limit.
	MaxLimit int `json:"max_limit,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemLimitWholesalePriceThresholdPercentage =======================================================

type ProductGetItemList added in v1.5.1

type ProductGetItemList struct {
	// item is list of item info with item_id/ item_status/ update_time
	Item []ProductGetItemListItem `json:"item"`
	// total_count is total count of all items
	TotalCount int `json:"total_count,omitempty"`
	// has_next_page is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	HasNextPage bool `json:"has_next_page,omitempty"`
	// next_offset is if has_next_page is true, this value need set to next request.offset
	NextOffset int `json:"next_offset,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemList =======================================================

type ProductGetItemListItem added in v1.5.4

type ProductGetItemListItem struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// item_status is Enumerated type that defines the current status of the item. Applicable values: NORMAL, DELETED, UNLIST and BANNED.
	ItemStatus string `json:"item_status,omitempty"`
	// update_time is The update time of item.
	UpdateTime int `json:"update_time,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemListItem =======================================================

type ProductGetItemListRequest added in v1.5.0

type ProductGetItemListRequest struct {
	V2RequestAuthenticationParams

	// offset is Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
	Offset int `json:"offset"`
	// page_size is the size of one page.Max=100
	PageSize int `json:"page_size"`
	// update_time_from is  The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_from field is the starting date range.
	UpdateTimeFrom int `json:"update_time_from,omitempty"`
	// update_time_to is The update_time_from and update_time_to fields specify a date range for retrieving orders (based on the item update time). The update_time_to field is the ending date range
	UpdateTimeTo int `json:"update_time_to,omitempty"`
	// item_status is <p>NORMAL/BANNED/DELETED/UNLIST</p><p>If you want to search multiple status, please upload the url like this: item_status=NORMAL&amp;item_status=BANNED</p>
	ItemStatus []string `json:"item_status"`
}

======================================================= ProductGetItemListRequest =======================================================

type ProductGetItemListResponse added in v1.5.0

type ProductGetItemListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetItemList `json:"response"`
}

======================================================= ProductGetItemListResponse =======================================================

type ProductGetItemPromotion added in v1.5.1

type ProductGetItemPromotion struct {
	// success_list is Success item promotion info.
	SuccessList []ProductGetItemPromotionSuccess `json:"success_list"`
	// failure_list is Fail item promotion info.
	FailureList []ProductGetItemPromotionFailure `json:"failure_list"`
}

======================================================= Object Raw Type - ProductGetItemPromotion =======================================================

type ProductGetItemPromotionFailure added in v1.5.5

type ProductGetItemPromotionFailure struct {
	// item_id is The identity of item.
	ItemID int `json:"item_id,omitempty"`
	// failed_reason is Fail reason.
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemPromotionFailure =======================================================

type ProductGetItemPromotionRequest added in v1.5.0

type ProductGetItemPromotionRequest struct {
	V2RequestAuthenticationParams

	// item_id_list is Item ID list, can send 1 to 50 items.
	ItemIdList []int `json:"item_id_list"`
}

======================================================= ProductGetItemPromotionRequest =======================================================

type ProductGetItemPromotionResponse added in v1.5.0

type ProductGetItemPromotionResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetItemPromotion `json:"response"`
}

======================================================= ProductGetItemPromotionResponse =======================================================

type ProductGetItemPromotionSuccess added in v1.5.5

type ProductGetItemPromotionSuccess struct {
	// item_id is The identity of product item.
	ItemID int `json:"item_id,omitempty"`
	// promotion is Item promotion info list
	Promotion []ProductGetItemPromotionSuccessPromotion `json:"promotion"`
}

======================================================= Object Raw Type - ProductGetItemPromotionSuccess =======================================================

type ProductGetItemPromotionSuccessPromotion added in v1.5.5

type ProductGetItemPromotionSuccessPromotion struct {
	// promotion_type is Promotion type, Applicable values: See Data Definition- PromotionType.
	PromotionType string `json:"promotion_type,omitempty"`
	// promotion_id is The identity of item promotion.
	PromotionID int `json:"promotion_id,omitempty"`
	// model_id is The identity of product model.
	ModelID int `json:"model_id,omitempty"`
	// start_time is Promotion start tiem.
	StartTime int `json:"start_time,omitempty"`
	// end_time is Promotion end item.
	EndTime int `json:"end_time,omitempty"`
	// promotion_price_info is Promotion price info.
	PromotionPriceInfo []ProductGetItemPromotionSuccessPromotionPromotionPriceInfo `json:"promotion_price_info"`
	// reserved_stock_info is <p>Promotion reserved stock info.</p><p><b><font color="#c24f4a">Please use the promotion_stock_info_v2 field instead, we will deprecate this field in the future.</font></b><br /></p>
	ReservedStockInfo []ProductGetItemPromotionSuccessPromotionReservedStockInfo `json:"reserved_stock_info"`
	// promotion_staging is Could be ongoing/upcoming
	PromotionStaging string `json:"promotion_staging,omitempty"`
	// promotion_stock_info_v2 is <p>new promotion stock<br /></p>
	PromotionStockInfoV2 ProductGetItemPromotionSuccessPromotionPromotionStockInfoV2 `json:"promotion_stock_info_v2"`
}

======================================================= Object Raw Type - ProductGetItemPromotionSuccessPromotion =======================================================

type ProductGetItemPromotionSuccessPromotionPromotionPriceInfo added in v1.5.5

type ProductGetItemPromotionSuccessPromotionPromotionPriceInfo struct {
	// promotion_price is Promotion price.
	PromotionPrice float64 `json:"promotion_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductGetItemPromotionSuccessPromotionPromotionPriceInfo =======================================================

type ProductGetItemPromotionSuccessPromotionPromotionStockInfoV2 added in v1.5.5

type ProductGetItemPromotionSuccessPromotionPromotionStockInfoV2 struct {
	// summary_info is <p>stock summary info<br /></p>
	SummaryInfo map[string]interface{} `json:"summary_info,omitempty"`
	// total_reserved_stock is <p>total reserved stock<br /></p>
	TotalReservedStock int `json:"total_reserved_stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemPromotionSuccessPromotionPromotionStockInfoV2 =======================================================

type ProductGetItemPromotionSuccessPromotionReservedStockInfo added in v1.5.5

type ProductGetItemPromotionSuccessPromotionReservedStockInfo struct {
	// stock_type is Stock type, could be 1: WmsOnHand;  2: SellerOnHand.
	StockType int `json:"stock_type,omitempty"`
	// stock_location_id is Stock location identity.
	StockLocationID string `json:"stock_location_id,omitempty"`
	// reserved_stock is Promotion reserved stock.
	ReservedStock int `json:"reserved_stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetItemPromotionSuccessPromotionReservedStockInfo =======================================================

type ProductGetModelList added in v1.5.1

type ProductGetModelList struct {
	// tier_variation is Variation config of item.
	TierVariation []ProductGetModelListTierVariation `json:"tier_variation"`
	// model is Model list.
	Model []ProductGetModelListModel `json:"model"`
}

======================================================= Object Raw Type - ProductGetModelList =======================================================

type ProductGetModelListModel added in v1.5.4

type ProductGetModelListModel struct {
	// price_info is Price info.
	PriceInfo []ProductGetModelListModelPriceInfo `json:"price_info"`
	// model_id is Model ID.
	ModelID int `json:"model_id,omitempty"`
	// stock_info is <p>Stock info.</p><p><b><font color="#c24f4a">Please use the stock_info_v2 field instead, we will deprecate this field in the future.</font></b><br /></p>
	StockInfo []ProductGetModelListModelStockInfo `json:"stock_info"`
	// tier_index is Tier index of this model.
	TierIndex []int `json:"tier_index,omitempty"`
	// promotion_id is Current promotion ID of this model.
	PromotionID int `json:"promotion_id,omitempty"`
	// model_sku is SKU of this model. the length should be under 100.
	ModelSku string `json:"model_sku,omitempty"`
	// pre_order is (Only whitelisted users can use)
	PreOrder ProductGetModelListModelPreOrder `json:"pre_order"`
	// stock_info_v2 is <p>new stock info.<br /></p><p>Please check this FAQ for more detail:&nbsp;<a href="https://open.shopee.com/faq?top=162&amp;sub=166&amp;page=1&amp;faq=230" target="_blank" style="font-size:14px;">https://open.shopee.com/faq?top=162&amp;sub=166&amp;page=1&amp;faq=230</a></p>
	StockInfoV2 ProductGetModelListModelStockInfoV2 `json:"stock_info_v2"`
}

======================================================= Object Raw Type - ProductGetModelListModel =======================================================

type ProductGetModelListModelPreOrder added in v1.5.4

type ProductGetModelListModelPreOrder struct {
	// is_pre_order is Pre-order.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
	// days_to_ship is The days to ship.
	DaysToShip int `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelPreOrder =======================================================

type ProductGetModelListModelPriceInfo added in v1.5.4

type ProductGetModelListModelPriceInfo struct {
	// current_price is Current price of item.
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// original_price is Original price of item.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// inflated_price_of_original_price is Original price of item after tax.
	InflatedPriceOfOriginalPrice float64 `json:"inflated_price_of_original_price,omitempty,string"`
	// inflated_price_of_current_price is Current price of item after tax.
	InflatedPriceOfCurrentPrice float64 `json:"inflated_price_of_current_price,omitempty,string"`
	// sip_item_price is SIP item price.If item is for CNSC primary shop, this field will not be returned
	SipItemPrice float64 `json:"sip_item_price,omitempty,string"`
	// sip_item_price_source is SIP item price source, could be manual or auto.If item is for CNSC primary shop, this field will not be returned
	SipItemPriceSource string `json:"sip_item_price_source,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelPriceInfo =======================================================

type ProductGetModelListModelStockInfo added in v1.5.4

type ProductGetModelListModelStockInfo struct {
	// normal_stock is Normal stock.
	NormalStock int `json:"normal_stock,omitempty"`
	// stock_type is Stock type.
	StockType int `json:"stock_type,omitempty"`
	// current_stock is Current stock.
	CurrentStock int `json:"current_stock,omitempty"`
	// reserved_stock is Stock reserved for upcoming promotion.
	ReservedStock int `json:"reserved_stock,omitempty"`
	// stock_location_id is  location_id of the stock.
	StockLocationID string `json:"stock_location_id,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelStockInfo =======================================================

type ProductGetModelListModelStockInfoV2 added in v1.5.4

type ProductGetModelListModelStockInfoV2 struct {
	// summary_info is <p>stock summary Info<br /></p>
	SummaryInfo ProductGetModelListModelStockInfoV2SummaryInfo `json:"summary_info"`
	// seller_stock is <p>seller stock<br /></p>
	SellerStock []ProductGetModelListModelStockInfoV2SellerStock `json:"seller_stock"`
	// shopee_stock is <p>shopee stock<br /></p>
	ShopeeStock []ProductGetModelListModelStockInfoV2ShopeeStock `json:"shopee_stock"`
}

======================================================= Object Raw Type - ProductGetModelListModelStockInfoV2 =======================================================

type ProductGetModelListModelStockInfoV2SellerStock added in v1.5.4

type ProductGetModelListModelStockInfoV2SellerStock struct {
	// location_id is <p>location id<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelStockInfoV2SellerStock =======================================================

type ProductGetModelListModelStockInfoV2ShopeeStock added in v1.5.4

type ProductGetModelListModelStockInfoV2ShopeeStock struct {
	// location_id is <p>location id<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock string `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelStockInfoV2ShopeeStock =======================================================

type ProductGetModelListModelStockInfoV2SummaryInfo added in v1.5.4

type ProductGetModelListModelStockInfoV2SummaryInfo struct {
	// total_reserved_stock is <p>total reserved stock<br /></p>
	TotalReservedStock int `json:"total_reserved_stock,omitempty"`
	// total_available_stock is <p>total available stock<br /></p>
	TotalAvailableStock int `json:"total_available_stock,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListModelStockInfoV2SummaryInfo =======================================================

type ProductGetModelListRequest added in v1.5.0

type ProductGetModelListRequest struct {
	V2RequestAuthenticationParams

	// item_id is The ID of the item
	ItemID int `json:"item_id"`
}

======================================================= ProductGetModelListRequest =======================================================

type ProductGetModelListResponse added in v1.5.0

type ProductGetModelListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetModelList `json:"response"`
}

======================================================= ProductGetModelListResponse =======================================================

type ProductGetModelListTierVariation added in v1.5.4

type ProductGetModelListTierVariation struct {
	// option_list is Option list.
	OptionList []ProductGetModelListTierVariationOption `json:"option_list"`
	// name is Variation name.
	Name string `json:"name,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListTierVariation =======================================================

type ProductGetModelListTierVariationOption added in v1.5.5

type ProductGetModelListTierVariationOption struct {
	// option is Option name.
	Option string `json:"option,omitempty"`
	// image is
	Image ProductGetModelListTierVariationOptionImage `json:"image"`
}

======================================================= Object Raw Type - ProductGetModelListTierVariationOption =======================================================

type ProductGetModelListTierVariationOptionImage added in v1.5.5

type ProductGetModelListTierVariationOptionImage struct {
	// image_id is Id of image
	ImageID string `json:"image_id,omitempty"`
	// image_url is Url of image.
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - ProductGetModelListTierVariationOptionImage =======================================================

type ProductGetRecommendAttribute added in v1.5.1

type ProductGetRecommendAttribute struct {
	// attribute_list is Attribute info list.
	AttributeList []ProductGetRecommendAttributeAttribute `json:"attribute_list"`
}

======================================================= Object Raw Type - ProductGetRecommendAttribute =======================================================

type ProductGetRecommendAttributeAttribute added in v1.5.5

type ProductGetRecommendAttributeAttribute struct {
	// attribute_id is ID of attribute.
	AttributeID int `json:"attribute_id,omitempty"`
	// attribute_value_list is Value list of this attribute.
	AttributeValueList []ProductGetRecommendAttributeAttributeAttributeValue `json:"attribute_value_list"`
}

======================================================= Object Raw Type - ProductGetRecommendAttributeAttribute =======================================================

type ProductGetRecommendAttributeAttributeAttributeValue added in v1.5.5

type ProductGetRecommendAttributeAttributeAttributeValue struct {
	// value_id is ID of attribute value.
	ValueID int `json:"value_id,omitempty"`
}

======================================================= Object Raw Type - ProductGetRecommendAttributeAttributeAttributeValue =======================================================

type ProductGetRecommendAttributeRequest added in v1.5.0

type ProductGetRecommendAttributeRequest struct {
	V2RequestAuthenticationParams

	// item_name is name of item
	ItemName string `json:"item_name"`
	// cover_image_id is Cover image id of item
	CoverImageID int `json:"cover_image_id,omitempty"`
	// category_id is ID of category
	CategoryID int `json:"category_id"`
}

======================================================= ProductGetRecommendAttributeRequest =======================================================

type ProductGetRecommendAttributeResponse added in v1.5.0

type ProductGetRecommendAttributeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductGetRecommendAttribute `json:"response"`
}

======================================================= ProductGetRecommendAttributeResponse =======================================================

type ProductImage added in v1.5.0

type ProductImage struct {
	// image_id_list is Image Id of product image for this brand, max input num of file = 10 ,each file's length<=498. ID market is optional.
	ImageIdList []string `json:"image_id_list,omitempty"`
}

======================================================= Object Raw Type - ProductImage =======================================================

type ProductInitTierVariation added in v1.5.1

type ProductInitTierVariation struct {
	// item_id is ID of item
	ItemID int `json:"item_id,omitempty"`
	// tier_variation is Variations of item
	TierVariation []ProductInitTierVariationTierVariation `json:"tier_variation"`
	// model is
	Model []ProductInitTierVariationModel `json:"model"`
}

======================================================= Object Raw Type - ProductInitTierVariation =======================================================

type ProductInitTierVariationModel added in v1.5.4

type ProductInitTierVariationModel struct {
	// tier_index is Tier index of model. Index starts from 0.
	TierIndex []map[string]interface{} `json:"tier_index,omitempty"`
	// model_id is ID of model
	ModelID int `json:"model_id,omitempty"`
	// model_sku is Seller SKU of this model
	ModelSku string `json:"model_sku,omitempty"`
	// stock_info is
	StockInfo []ProductInitTierVariationModelStockInfo `json:"stock_info"`
	// price_info is
	PriceInfo []ProductInitTierVariationModelPriceInfo `json:"price_info"`
	// seller_stock is <p>new stock info<br /></p>
	SellerStock []ProductInitTierVariationModelSellerStock `json:"seller_stock"`
}

======================================================= Object Raw Type - ProductInitTierVariationModel =======================================================

type ProductInitTierVariationModelPriceInfo added in v1.5.4

type ProductInitTierVariationModelPriceInfo struct {
	// original_price is Original price
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductInitTierVariationModelPriceInfo =======================================================

type ProductInitTierVariationModelSellerStock added in v1.5.4

type ProductInitTierVariationModelSellerStock struct {
	// location_id is <p>location id<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock</p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductInitTierVariationModelSellerStock =======================================================

type ProductInitTierVariationModelStockInfo added in v1.5.4

type ProductInitTierVariationModelStockInfo struct {
	// stock_type is Stock type, could be 1: WmsOnHand, 2: SellerOnHand
	StockType int `json:"stock_type,omitempty"`
	// normal_stock is Normal stock
	NormalStock int `json:"normal_stock,omitempty"`
}

======================================================= Object Raw Type - ProductInitTierVariationModelStockInfo =======================================================

type ProductInitTierVariationRequest added in v1.5.0

type ProductInitTierVariationRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item
	ItemID int `json:"item_id"`
	// tier_variation is Tier variation info list.If you define a one-tier structure, the maximum number of options cannot exceed 50. If you define a two-tier structure, the number of options multiplied by the two tiers cannot exceed 50.
	TierVariation []TierVariation `json:"tier_variation"`
	// model is Model info list, model number at most 50
	Model []Model `json:"model"`
}

======================================================= ProductInitTierVariationRequest =======================================================

type ProductInitTierVariationResponse added in v1.5.0

type ProductInitTierVariationResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductInitTierVariation `json:"response"`
}

======================================================= ProductInitTierVariationResponse =======================================================

type ProductInitTierVariationTierVariation added in v1.5.4

type ProductInitTierVariationTierVariation struct {
	// name is Variation name
	Name string `json:"name,omitempty"`
	// option_list is Options of this variation
	OptionList []ProductInitTierVariationTierVariationOption `json:"option_list"`
}

======================================================= Object Raw Type - ProductInitTierVariationTierVariation =======================================================

type ProductInitTierVariationTierVariationOption added in v1.5.5

type ProductInitTierVariationTierVariationOption struct {
	// image is Image of this option
	Image ProductInitTierVariationTierVariationOptionImage `json:"image"`
	// option is Option name
	Option string `json:"option,omitempty"`
}

======================================================= Object Raw Type - ProductInitTierVariationTierVariationOption =======================================================

type ProductInitTierVariationTierVariationOptionImage added in v1.5.5

type ProductInitTierVariationTierVariationOptionImage struct {
	// image_url is URL of image
	ImageUrl string `json:"image_url,omitempty"`
}

======================================================= Object Raw Type - ProductInitTierVariationTierVariationOptionImage =======================================================

type ProductRegisterBrand added in v1.5.1

type ProductRegisterBrand struct {
	// brand_id is The identity of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is Brand name
	OriginalBrandName string `json:"original_brand_name,omitempty"`
}

======================================================= Object Raw Type - ProductRegisterBrand =======================================================

type ProductRegisterBrandRequest added in v1.5.0

type ProductRegisterBrandRequest struct {
	V2RequestAuthenticationParams

	// original_brand_name is Brand name, length<=254.
	OriginalBrandName string `json:"original_brand_name"`
	// category_list is Category_id list for this brand, please input category in L1 or L2. Max input num of category_id is 50.
	CategoryList []int `json:"category_list"`
	// product_image is
	ProductImage ProductImage `json:"product_image"`
	// app_logo_image_id is Image_id  of logo for  app client,please input hashcode of this picture.
	AppLogoImageID string `json:"app_logo_image_id,omitempty"`
	// brand_website is Official website of brand, length<=254.
	BrandWebsite string `json:"brand_website,omitempty"`
	// brand_description is The description of this brand, can input the information, length<=254.
	BrandDescription string `json:"brand_description,omitempty"`
	// additional_information is Additional notes or comment can seller can add, length<=254.
	AdditionalInformation string `json:"additional_information,omitempty"`
	// pc_logo_image_id is Image_id  of logo for  pc client,please input hashcode of this picture.
	PcLogoImageID string `json:"pc_logo_image_id,omitempty"`
	// brand_country is origin country of brand.
	BrandCountry string `json:"brand_country"`
}

======================================================= ProductRegisterBrandRequest =======================================================

type ProductRegisterBrandResponse added in v1.5.0

type ProductRegisterBrandResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductRegisterBrand `json:"response"`
}

======================================================= ProductRegisterBrandResponse =======================================================

type ProductReplyComment added in v1.5.1

type ProductReplyComment struct {
	// result_list is The result list of the request comment list.
	ResultList []ProductReplyCommentResult `json:"result_list"`
}

======================================================= Object Raw Type - ProductReplyComment =======================================================

type ProductReplyCommentRequest added in v1.5.0

type ProductReplyCommentRequest struct {
	V2RequestAuthenticationParams

	// comment_list is The list of comment. The limit is between 1 and 100.
	CommentList []CommentList `json:"comment_list"`
}

======================================================= ProductReplyCommentRequest =======================================================

type ProductReplyCommentResponse added in v1.5.0

type ProductReplyCommentResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response ProductReplyComment `json:"response"`
}

======================================================= ProductReplyCommentResponse =======================================================

type ProductReplyCommentResult added in v1.5.5

type ProductReplyCommentResult struct {
	// comment_id is The identity of comment.
	CommentID int `json:"comment_id,omitempty"`
	// fail_error is Indicate error details if one element hit error.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is Indicate error type if one element hit error.
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - ProductReplyCommentResult =======================================================

type ProductSearchItem added in v1.5.1

type ProductSearchItem struct {
	// item_id_list is List of  item ID.
	ItemIdList []int `json:"item_id_list,omitempty"`
	// total_count is Total num of items match condation.
	TotalCount int `json:"total_count,omitempty"`
	// next_offset is If has_next_page is true, this value need set to next request.offset
	NextOffset string `json:"next_offset,omitempty"`
}

======================================================= Object Raw Type - ProductSearchItem =======================================================

type ProductSearchItemRequest added in v1.5.0

type ProductSearchItemRequest struct {
	V2RequestAuthenticationParams

	// offset is Specifies the starting entry of data to return in the current call. Default is empty. if data is more than one page, the offset can be some entry to start next call.
	Offset string `json:"offset,omitempty"`
	// page_size is the size of one page.
	PageSize int `json:"page_size"`
	// item_name is name of item.
	ItemName string `json:"item_name,omitempty"`
	// attribute_status is 1:get item lack of requires attribute.   2:get item lack of optional attribute.
	AttributeStatus int `json:"attribute_status,omitempty"`
}

======================================================= ProductSearchItemRequest =======================================================

type ProductSearchItemResponse added in v1.5.0

type ProductSearchItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductSearchItem `json:"response,omitempty"`
}

======================================================= ProductSearchItemResponse =======================================================

type ProductSupportSizeChart added in v1.5.1

type ProductSupportSizeChart struct {
	// support_size_chart is Can sizechart be set for this category.
	SupportSizeChart bool `json:"support_size_chart,omitempty"`
}

======================================================= Object Raw Type - ProductSupportSizeChart =======================================================

type ProductSupportSizeChartRequest added in v1.5.0

type ProductSupportSizeChartRequest struct {
	V2RequestAuthenticationParams

	// category_id is Category ID
	CategoryID int `json:"category_id"`
}

======================================================= ProductSupportSizeChartRequest =======================================================

type ProductSupportSizeChartResponse added in v1.5.0

type ProductSupportSizeChartResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductSupportSizeChart `json:"response"`
}

======================================================= ProductSupportSizeChartResponse =======================================================

type ProductUnlistItem added in v1.5.1

type ProductUnlistItem struct {
	// failure_list is
	FailureList []ProductUnlistItemFailure `json:"failure_list"`
	// success_list is
	SuccessList []ProductUnlistItemSuccess `json:"success_list"`
}

======================================================= Object Raw Type - ProductUnlistItem =======================================================

type ProductUnlistItemFailure added in v1.5.5

type ProductUnlistItemFailure struct {
	// item_id is Failed item id
	ItemID int `json:"item_id,omitempty"`
	// failed_reason is Failed reason
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - ProductUnlistItemFailure =======================================================

type ProductUnlistItemRequest added in v1.5.0

type ProductUnlistItemRequest struct {
	V2RequestAuthenticationParams

	// item_list is Length should be between 1 to 50.
	ItemList []ItemList `json:"item_list"`
}

======================================================= ProductUnlistItemRequest =======================================================

type ProductUnlistItemResponse added in v1.5.0

type ProductUnlistItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductUnlistItem `json:"response"`
}

======================================================= ProductUnlistItemResponse =======================================================

type ProductUnlistItemSuccess added in v1.5.5

type ProductUnlistItemSuccess struct {
	// item_id is Success item id
	ItemID int `json:"item_id,omitempty"`
	// unlist is Whether the item is unlisted
	Unlist bool `json:"unlist,omitempty"`
}

======================================================= Object Raw Type - ProductUnlistItemSuccess =======================================================

type ProductUpdateItem added in v1.5.1

type ProductUpdateItem struct {
	// description is Item description.
	Description string `json:"description,omitempty"`
	// weight is Item weight.
	Weight float64 `json:"weight,omitempty,string"`
	// pre_order is
	PreOrder ProductUpdateItemPreOrder `json:"pre_order"`
	// item_name is Item name.
	ItemName string `json:"item_name,omitempty"`
	// item_status is Item status.
	ItemStatus string `json:"item_status,omitempty"`
	// images is Item images.
	Images ProductUpdateItemImage `json:"images"`
	// logistic_info is
	LogisticInfo []ProductUpdateItemLogisticInfo `json:"logistic_info"`
	// item_id is ID of item.
	ItemID int `json:"item_id,omitempty"`
	// category_id is ID of item category.
	CategoryID int `json:"category_id,omitempty"`
	// dimension is
	Dimension ProductUpdateItemDimension `json:"dimension"`
	// condition is Item condition, could be USED or NEW.
	Condition string `json:"condition,omitempty"`
	// brand is
	Brand ProductUpdateItemBrand `json:"brand"`
	// item_dangerous is This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
	ItemDangerous int `json:"item_dangerous,omitempty"`
	// complaint_policy is Complaint policy
	ComplaintPolicy ProductUpdateItemComplaintPolicy `json:"complaint_policy"`
	// description_info is New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo ProductUpdateItemDescriptionInfo `json:"description_info"`
	// description_type is <p>description_type (normal , extended).</p>
	DescriptionType string `json:"description_type,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItem =======================================================

type ProductUpdateItemBrand added in v1.5.4

type ProductUpdateItemBrand struct {
	// brand_id is Id of brand.
	BrandID int `json:"brand_id,omitempty"`
	// original_brand_name is  Original name of brand.
	OriginalBrandName string `json:"original_brand_name,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemBrand =======================================================

type ProductUpdateItemComplaintPolicy added in v1.5.4

type ProductUpdateItemComplaintPolicy struct {
	// warranty_time is Value should be in one of ONE_YEAR TWO_YEARS OVER_TWO_YEARS.
	WarrantyTime string `json:"warranty_time,omitempty"`
	// exclude_entrepreneur_warranty is If True means "I exclude warranty complaints for entrepreneur"
	ExcludeEntrepreneurWarranty bool `json:"exclude_entrepreneur_warranty,omitempty"`
	// additional_information is Additional information for complaint policy
	AdditionalInformation string `json:"additional_information,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemComplaintPolicy =======================================================

type ProductUpdateItemDescriptionInfo added in v1.5.4

type ProductUpdateItemDescriptionInfo struct {
	// extended_description is If description_type is extended , description information should be set by this field.
	ExtendedDescription ProductUpdateItemDescriptionInfoExtendedDescription `json:"extended_description"`
}

======================================================= Object Raw Type - ProductUpdateItemDescriptionInfo =======================================================

type ProductUpdateItemDescriptionInfoExtendedDescription added in v1.5.4

type ProductUpdateItemDescriptionInfoExtendedDescription struct {
	// field_list is  Field of extended description.
	FieldList []ProductUpdateItemDescriptionInfoExtendedDescriptionField `json:"field_list"`
}

======================================================= Object Raw Type - ProductUpdateItemDescriptionInfoExtendedDescription =======================================================

type ProductUpdateItemDescriptionInfoExtendedDescriptionField added in v1.5.5

type ProductUpdateItemDescriptionInfoExtendedDescriptionField struct {
	// field_type is Type of extended description field :values: See Data Definition- description_field_type (text , image).
	FieldType string `json:"field_type,omitempty"`
	// text is If field_type is text, text information will be set by this field.
	Text string `json:"text,omitempty"`
	// image_info is If field_type is image,image url will be set by this field.
	ImageInfo ProductUpdateItemDescriptionInfoExtendedDescriptionFieldImageInfo `json:"image_info"`
}

======================================================= Object Raw Type - ProductUpdateItemDescriptionInfoExtendedDescriptionField =======================================================

type ProductUpdateItemDescriptionInfoExtendedDescriptionFieldImageInfo added in v1.5.5

type ProductUpdateItemDescriptionInfoExtendedDescriptionFieldImageInfo struct {
	// image_id is Image id.
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemDescriptionInfoExtendedDescriptionFieldImageInfo =======================================================

type ProductUpdateItemDimension added in v1.5.4

type ProductUpdateItemDimension struct {
	// package_width is <p>Package height, unit is cm</p><p><b><font color="#c24f4a">For CB and&nbsp;SG/MY/PH/VN/PL/ES local sellers:&nbsp;</font></b>Support&nbsp;1 decimal place</p><p><b><font color="#c24f4a">For&nbsp;TH/TW/ID/BR/MX/CO/CL/AR local sellers:&nbsp;</font></b>Not support&nbsp;1 decimal place</p>
	PackageWidth int `json:"package_width,omitempty"`
	// package_length is <p>Package height, unit is cm</p><p><b><font color="#c24f4a">For CB and&nbsp;SG/MY/PH/VN/PL/ES local sellers:&nbsp;</font></b>Support&nbsp;1 decimal place</p><p><b><font color="#c24f4a">For&nbsp;TH/TW/ID/BR/MX/CO/CL/AR local sellers:&nbsp;</font></b>Not support&nbsp;1 decimal place</p>
	PackageLength int `json:"package_length,omitempty"`
	// package_height is <p>Package height, unit is cm</p><p><b><font color="#c24f4a">For CB and&nbsp;SG/MY/PH/VN/PL/ES local sellers:&nbsp;</font></b>Support&nbsp;1 decimal place</p><p><b><font color="#c24f4a">For&nbsp;TH/TW/ID/BR/MX/CO/CL/AR local sellers:&nbsp;</font></b>Not support&nbsp;1 decimal place</p>
	PackageHeight int `json:"package_height,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemDimension =======================================================

type ProductUpdateItemImage added in v1.5.5

type ProductUpdateItemImage struct {
	// image_id_list is ID list of item image.
	ImageIdList []string `json:"image_id_list,omitempty"`
	// image_url_list is URL list of item image
	ImageUrlList []string `json:"image_url_list,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemImage =======================================================

type ProductUpdateItemLogisticInfo added in v1.5.4

type ProductUpdateItemLogisticInfo struct {
	// estimated_shipping_fee is Estimated shipping fee.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
	// logistic_name is Name of logistics channel.
	LogisticName string `json:"logistic_name,omitempty"`
	// enabled is Whether this channel is enabled.
	Enabled bool `json:"enabled,omitempty"`
	// logistic_id is ID of this channel.
	LogisticID int `json:"logistic_id,omitempty"`
	// is_free is Whether cover shipping fee for buyer.
	IsFree bool `json:"is_free,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemLogisticInfo =======================================================

type ProductUpdateItemPreOrder added in v1.5.4

type ProductUpdateItemPreOrder struct {
	// days_to_ship is The time it takes to ship the item.
	DaysToShip int `json:"days_to_ship,omitempty"`
	// is_pre_order is Whether item is pre order.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateItemPreOrder =======================================================

type ProductUpdateItemRequest added in v1.5.0

type ProductUpdateItemRequest struct {
	V2RequestAuthenticationParams

	// description is Description of item.
	Description string `json:"description,omitempty"`
	// weight is Weight of item.
	Weight float64 `json:"weight,omitempty,string"`
	// pre_order is Pre Order setting.
	PreOrder PreOrder `json:"pre_order,omitempty"`
	// item_name is Item name.
	ItemName string `json:"item_name,omitempty"`
	// attribute_list is Item attributes.
	AttributeList []AttributeList `json:"attribute_list,omitempty"`
	// image is Images of item.
	Image Image `json:"image,omitempty"`
	// item_sku is SKU tag for item.
	ItemSku string `json:"item_sku,omitempty"`
	// item_status is Item status, could be UNLIST or NORMAL.
	ItemStatus string `json:"item_status,omitempty"`
	// logistic_info is Logistic channel setting.
	LogisticInfo []LogisticInfo `json:"logistic_info,omitempty"`
	// wholesale is Wholesale setting.
	Wholesale []Wholesale `json:"wholesale,omitempty"`
	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// category_id is ID of category.
	CategoryID int `json:"category_id,omitempty"`
	// dimension is Dimension of item.
	Dimension Dimension `json:"dimension,omitempty"`
	// condition is Condition of item, could be NEW or USED.
	Condition string `json:"condition,omitempty"`
	// video_upload_id is Video upload ID returned from video uploading API.
	VideoUploadID string `json:"video_upload_id,omitempty"`
	// brand is
	Brand Brand `json:"brand,omitempty"`
	// item_dangerous is This field is only applicable for local sellers in Indonesia and Malaysia. Use this field to identify whether a product is a dangerous product. 0 for non-dangerous product and 1 for dangerous product. For more information, please visit the market's respective Seller Education Hub.
	ItemDangerous int `json:"item_dangerous,omitempty"`
	// tax_info is Tax information
	TaxInfo TaxInfo `json:"tax_info,omitempty"`
	// complaint_policy is Complaint Policy for item. Only required for local PL sellers, ignored otherwise.
	ComplaintPolicy ComplaintPolicy `json:"complaint_policy,omitempty"`
	// description_info is New description field. Only whitelist sellers can use it. If you use the field, please upload the description_type=extended otherwise api will return error. If you don't use this field, you don't need to upload the description_type or upload description_type=normal
	DescriptionInfo DescriptionInfo `json:"description_info,omitempty"`
	// description_type is <p>description_type (normal , extended). If you want to use extended_description or change description type ,this field must be inputed</p>
	DescriptionType string `json:"description_type,omitempty"`
}

======================================================= ProductUpdateItemRequest =======================================================

type ProductUpdateItemResponse added in v1.5.0

type ProductUpdateItemResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductUpdateItem `json:"response,omitempty"`
}

======================================================= ProductUpdateItemResponse =======================================================

type ProductUpdateModelRequest added in v1.5.0

type ProductUpdateModelRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item
	ItemID int `json:"item_id"`
	// model is Length should be between 1 to 50
	Model []Model `json:"model"`
}

======================================================= ProductUpdateModelRequest =======================================================

type ProductUpdateModelResponse added in v1.5.0

type ProductUpdateModelResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductUpdateModelResponse =======================================================

type ProductUpdatePrice added in v1.5.1

type ProductUpdatePrice struct {
	// failure_list is Fail model list.
	FailureList []ProductUpdatePriceFailure `json:"failure_list"`
	// success_list is Success model list.
	SuccessList []ProductUpdatePriceSuccess `json:"success_list"`
}

======================================================= Object Raw Type - ProductUpdatePrice =======================================================

type ProductUpdatePriceFailure added in v1.5.5

type ProductUpdatePriceFailure struct {
	// model_id is ID of model.
	ModelID int `json:"model_id,omitempty"`
	// failed_reason is Reason for failure.
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - ProductUpdatePriceFailure =======================================================

type ProductUpdatePriceRequest added in v1.5.0

type ProductUpdatePriceRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// price_list is Length should be between 1 to 50.
	PriceList []PriceList `json:"price_list"`
}

======================================================= ProductUpdatePriceRequest =======================================================

type ProductUpdatePriceResponse added in v1.5.0

type ProductUpdatePriceResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductUpdatePrice `json:"response"`
}

======================================================= ProductUpdatePriceResponse =======================================================

type ProductUpdatePriceSuccess added in v1.5.5

type ProductUpdatePriceSuccess struct {
	// model_id is ID of model.
	ModelID int `json:"model_id,omitempty"`
	// original_price is Original price for model.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
}

======================================================= Object Raw Type - ProductUpdatePriceSuccess =======================================================

type ProductUpdateSipItemPriceRequest added in v1.5.0

type ProductUpdateSipItemPriceRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// sip_item_price is
	SipItemPrice []SipItemPrice `json:"sip_item_price,omitempty"`
}

======================================================= ProductUpdateSipItemPriceRequest =======================================================

type ProductUpdateSipItemPriceResponse added in v1.5.0

type ProductUpdateSipItemPriceResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductUpdateSipItemPriceResponse =======================================================

type ProductUpdateSizeChartRequest added in v1.5.0

type ProductUpdateSizeChartRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item
	ItemID int `json:"item_id"`
	// size_chart is ID of size chart image
	SizeChart string `json:"size_chart"`
}

======================================================= ProductUpdateSizeChartRequest =======================================================

type ProductUpdateSizeChartResponse added in v1.5.0

type ProductUpdateSizeChartResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductUpdateSizeChartResponse =======================================================

type ProductUpdateStock added in v1.5.1

type ProductUpdateStock struct {
	// failure_list is Fail model list.
	FailureList []ProductUpdateStockFailure `json:"failure_list"`
	// success_list is Success model list.
	SuccessList []ProductUpdateStockSuccess `json:"success_list"`
}

======================================================= Object Raw Type - ProductUpdateStock =======================================================

type ProductUpdateStockFailure added in v1.5.5

type ProductUpdateStockFailure struct {
	// model_id is ID of model.
	ModelID int `json:"model_id,omitempty"`
	// failed_reason is Reason for failure.
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateStockFailure =======================================================

type ProductUpdateStockRequest added in v1.5.0

type ProductUpdateStockRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// stock_list is Length should be between 1 to 50.
	StockList []StockList `json:"stock_list"`
}

======================================================= ProductUpdateStockRequest =======================================================

type ProductUpdateStockResponse added in v1.5.0

type ProductUpdateStockResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ProductUpdateStock `json:"response"`
}

======================================================= ProductUpdateStockResponse =======================================================

type ProductUpdateStockSuccess added in v1.5.5

type ProductUpdateStockSuccess struct {
	// model_id is ID of model.
	ModelID int `json:"model_id,omitempty"`
	// normal_stock is Stock of this model.
	NormalStock int `json:"normal_stock,omitempty"`
	// location_id is <p>location id; This field and the stock field are returned in pairs<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock;This field is returned if seller stock is used in the request, and normal stock fields are not returned.<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - ProductUpdateStockSuccess =======================================================

type ProductUpdateTierVariationRequest added in v1.5.0

type ProductUpdateTierVariationRequest struct {
	V2RequestAuthenticationParams

	// item_id is ID of item.
	ItemID int `json:"item_id"`
	// tier_variation is Tier variation info list.If you define a one-tier structure, the maximum number of options cannot exceed 50. If you define a two-tier structure, the number of options multiplied by the two tiers cannot exceed 50.
	TierVariation []TierVariation `json:"tier_variation"`
}

======================================================= ProductUpdateTierVariationRequest =======================================================

type ProductUpdateTierVariationResponse added in v1.5.0

type ProductUpdateTierVariationResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ProductUpdateTierVariationResponse =======================================================

type PublicGetMerchantsByPartnerRequest added in v1.5.0

type PublicGetMerchantsByPartnerRequest struct {
	V2RequestAuthenticationParams

	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.
	PageSize int `json:"page_size,omitempty"`
	// page_no is Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
	PageNo int `json:"page_no,omitempty"`
}

======================================================= PublicGetMerchantsByPartnerRequest =======================================================

type PublicGetMerchantsByPartnerResponse added in v1.5.0

type PublicGetMerchantsByPartnerResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= PublicGetMerchantsByPartnerResponse =======================================================

type PublicGetRefreshTokenByUpgradeCode added in v1.5.1

type PublicGetRefreshTokenByUpgradeCode struct {
	// success_shop_id_list is <p>The list of shop id which get the refresh_token successfully.<br /></p>
	SuccessShopIdList []int `json:"success_shop_id_list,omitempty"`
	// refresh_token is <p>Use refresh_token to obtain new access_token. Valid for each shop_id and merchant_id respectively one-time use, expires in 30 days.<br /></p>
	RefreshToken string `json:"refresh_token,omitempty"`
	// failure_list is <p>The failure information list<br /></p>
	FailureList []PublicGetRefreshTokenByUpgradeCodeFailure `json:"failure_list"`
}

======================================================= Object Raw Type - PublicGetRefreshTokenByUpgradeCode =======================================================

type PublicGetRefreshTokenByUpgradeCodeFailure added in v1.5.5

type PublicGetRefreshTokenByUpgradeCodeFailure struct {
	// shop_id is <p>The list of shop id which failed to get the refresh_token.<br /></p>
	ShopID int `json:"shop_id,omitempty"`
	// failed_reason is <p>The reason why your shop failed to get refresh token<br /></p>
	FailedReason string `json:"failed_reason,omitempty"`
}

======================================================= Object Raw Type - PublicGetRefreshTokenByUpgradeCodeFailure =======================================================

type PublicGetRefreshTokenByUpgradeCodeRequest added in v1.5.0

type PublicGetRefreshTokenByUpgradeCodeRequest struct {
	V2RequestAuthenticationParams

	// upgrade_code is <p>All the app who have the access to call open api V1.0 can have an upgrade_code after they apply in app details page.Each authorized shop can use this upgrade_code 3 times to get a V2 refresh token and start to call open api V2.0.<br /></p>
	UpgradeCode string `json:"upgrade_code"`
	// shop_id_list is <p>The list of shop id which you want to get the V2 refresh token. The limit is between 1 and 100.<br /></p>
	ShopIdList []int `json:"shop_id_list"`
}

======================================================= PublicGetRefreshTokenByUpgradeCodeRequest =======================================================

type PublicGetRefreshTokenByUpgradeCodeResponse added in v1.5.0

type PublicGetRefreshTokenByUpgradeCodeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is <p>Detail informations you are querying.<br /></p>
	Response PublicGetRefreshTokenByUpgradeCode `json:"response"`
}

======================================================= PublicGetRefreshTokenByUpgradeCodeResponse =======================================================

type PublicGetShopsByPartnerRequest added in v1.5.0

type PublicGetShopsByPartnerRequest struct {
	V2RequestAuthenticationParams

	// page_size is Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data.
	PageSize int `json:"page_size,omitempty"`
	// page_no is Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call.
	PageNo int `json:"page_no,omitempty"`
}

======================================================= PublicGetShopsByPartnerRequest =======================================================

type PublicGetShopsByPartnerResponse added in v1.5.0

type PublicGetShopsByPartnerResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= PublicGetShopsByPartnerResponse =======================================================

type PublicGetTokenByResendCodeRequest added in v1.5.0

type PublicGetTokenByResendCodeRequest struct {
	V2RequestAuthenticationParams

	// resend_code is the code in redirect url after you resend code in shop authorization management page. valid for one-time use, expires in 10minutes.
	ResendCode string `json:"resend_code"`
}

======================================================= PublicGetTokenByResendCodeRequest =======================================================

type PublicGetTokenByResendCodeResponse added in v1.5.0

type PublicGetTokenByResendCodeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= PublicGetTokenByResendCodeResponse =======================================================

type PushConfig added in v1.5.0

type PushConfig struct {
	// order_status is 0 stands for off and 1 stands for on.
	OrderStatus int `json:"order_status,omitempty"`
	// order_tracking_no is 0 stands for off and 1 stands for on.
	OrderTrackingNo int `json:"order_tracking_no,omitempty"`
	// shop_update is 0 stands for off and 1 stands for on.
	ShopUpdate int `json:"shop_update,omitempty"`
	// banned_item is 0 stands for off and 1 stands for on.
	BannedItem int `json:"banned_item,omitempty"`
	// item_promotion is 0 stands for off and 1 stands for on.
	ItemPromotion int `json:"item_promotion,omitempty"`
	// reserved_stock_change is 0 stands for off and 1 stands for on.
	ReservedStockChange int `json:"reserved_stock_change,omitempty"`
	// brand_register_result is 0 stands for off and 1 stands for on.
	BrandRegisterResult int `json:"brand_register_result,omitempty"`
	// promotion_update is 0 stands for off and 1 stands for on.
	PromotionUpdate int `json:"promotion_update,omitempty"`
	// webchat_update is 0 stands for off and 1 stands for on.
	WebchatUpdate int `json:"webchat_update,omitempty"`
	// open_api_authorization_expiry is 0 stands for off and 1 stands for on.
	OpenApiAuthorizationExpiry int `json:"open_api_authorization_expiry,omitempty"`
	// shop_authorization_canceled_push is <p>0 stands for off and 1 stands for on.<br /></p>
	ShopAuthorizationCanceledPush int `json:"shop_authorization_canceled_push,omitempty"`
	// shop_authorization_push is <p>0 stands for off and 1 stands for on.<br /></p>
	ShopAuthorizationPush int `json:"shop_authorization_push,omitempty"`
}

======================================================= Object Raw Type - PushConfig =======================================================

type PushGetPushConfigRequest added in v1.5.0

type PushGetPushConfigRequest struct {
	V2RequestAuthenticationParams
}

======================================================= PushGetPushConfigRequest =======================================================

type PushGetPushConfigResponse added in v1.5.0

type PushGetPushConfigResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= PushGetPushConfigResponse =======================================================

type PushSetPushConfigRequest added in v1.5.0

type PushSetPushConfigRequest struct {
	V2RequestAuthenticationParams

	// callback_url is The callback url of push mechanism.
	CallbackUrl string `json:"callback_url,omitempty"`
	// push_config is Detail configuration of push mechanism.
	PushConfig PushConfig `json:"push_config,omitempty"`
	// blocked_shop_id is Use this filed to set shops that need to be blocked.
	BlockedShopID []int `json:"blocked_shop_id,omitempty"`
}

======================================================= PushSetPushConfigRequest =======================================================

type PushSetPushConfigResponse added in v1.5.0

type PushSetPushConfigResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= PushSetPushConfigResponse =======================================================

type Queries added in v1.5.1

type Queries struct {
	// order_sn is <p>Shopee's unique identifier for an order.Limit 50.<br /></p>
	OrderSN string `json:"order_sn,omitempty"`
}

======================================================= Object Raw Type - Queries =======================================================

type RefreshAccessTokenRequest

type RefreshAccessTokenRequest struct {
	// Use refresh_token to obtain new access_token. Valid for one-time use, expires in 30 days.
	RefreshToken string `json:"refresh_token,omitempty"`
	// The shop_id of the shop that authorized the developer.
	ShopID int64 `json:"shop_id,omitempty"`
	// The credential retrieved in the APP console.
	PartnerID int64 `json:"partner_id,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type RefreshAccessTokenResponse

type RefreshAccessTokenResponse struct {
	// The identifier for an API request for error tracking.
	RequestID string `json:"request_id,omitempty"`
	// Error code. Empty when the api call succeeded.
	Error string `json:"error,omitempty"`
	// Use refresh_token to obtain new access_token. Valid for one-time use, expires in 30 days.
	RefreshToken string `json:"refresh_token,omitempty"`
	// Use access_token as a common request parameter for certian APIs. Valid for multiple use, expires in 4 hours.
	AccessToken string `json:"access_token,omitempty"`
	// Access_token expiration time, unit is second.
	ExpireIn int `json:"expire_in,omitempty"`
	// The credential retrieved in the APP console.
	PartnerID int64 `json:"partner_id,omitempty"`
	// The shop_id of the shop that authorized the developer.
	ShopID int64 `json:"shop_id,omitempty"`
}

type ReplyCommentsRequestCMTList

type ReplyCommentsRequestCMTList struct {
	// The identity of comment.
	CMTID int64 `json:"cmt_id,omitempty"`
	// Content of the comment.
	Comment string `json:"comment,omitempty"`
}

type ReplyCommentsResponseError

type ReplyCommentsResponseError struct {
	// The identity of comment.
	CMTID    int64  `json:"cmt_id,omitempty"`
	ErrorMsg string `json:"error_msg,omitempty"`
}

type ReplyCommentsResponseSuccList

type ReplyCommentsResponseSuccList struct {
	CMTID int64 `json:"cmt_id,omitempty"`
}

type ReportData added in v1.5.0

type ReportData struct {
	// upload_cost is Time used for uploading the video file via upload_video_part api, in milliseconds. For video upload performance tracking purpose.
	UploadCost int `json:"upload_cost,omitempty"`
}

======================================================= Object Raw Type - ReportData =======================================================

type ResponseError

type ResponseError struct {
	RequestID string `json:"request_id,omitempty"`
	Msg       string `json:"msg,omitempty"`
	ErrorType string `json:"error,omitempty"`
	Message   string `json:"message,omitempty"`
}

ResponseError defines a error response

func (ResponseError) Error

func (e ResponseError) Error() string

type ReturnsAcceptOffer added in v1.5.1

type ReturnsAcceptOffer struct {
	// return_sn is
	ReturnSN string `json:"return_sn,omitempty"`
}

======================================================= Object Raw Type - ReturnsAcceptOffer =======================================================

type ReturnsAcceptOfferRequest added in v1.5.0

type ReturnsAcceptOfferRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
}

======================================================= ReturnsAcceptOfferRequest =======================================================

type ReturnsAcceptOfferResponse added in v1.5.0

type ReturnsAcceptOfferResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ReturnsAcceptOffer `json:"response"`
}

======================================================= ReturnsAcceptOfferResponse =======================================================

type ReturnsConfirm added in v1.5.1

type ReturnsConfirm struct {
	// return_sn is The identifier for an API request for error tracking
	ReturnSN string `json:"return_sn,omitempty"`
}

======================================================= Object Raw Type - ReturnsConfirm =======================================================

type ReturnsConfirmRequest added in v1.5.0

type ReturnsConfirmRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
}

======================================================= ReturnsConfirmRequest =======================================================

type ReturnsConfirmResponse added in v1.5.0

type ReturnsConfirmResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ReturnsConfirm `json:"response"`
}

======================================================= ReturnsConfirmResponse =======================================================

type ReturnsDispute added in v1.5.1

type ReturnsDispute struct {
	// return_sn is The identifier for an API request for error tracking
	ReturnSN string `json:"return_sn,omitempty"`
}

======================================================= Object Raw Type - ReturnsDispute =======================================================

type ReturnsDisputeRequest added in v1.5.0

type ReturnsDisputeRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
	// email is
	Email string `json:"email"`
	// dispute_reason is
	DisputeReason string `json:"dispute_reason"`
	// dispute_text_reason is
	DisputeTextReason string `json:"dispute_text_reason"`
	// image is
	Image []string `json:"image"`
}

======================================================= ReturnsDisputeRequest =======================================================

type ReturnsDisputeResponse added in v1.5.0

type ReturnsDisputeResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ReturnsDispute `json:"response"`
}

======================================================= ReturnsDisputeResponse =======================================================

type ReturnsGetAvailableSolutions added in v1.5.1

type ReturnsGetAvailableSolutions struct {
	// return_sn is
	ReturnSN string `json:"return_sn,omitempty"`
	// offer_return_refund is
	OfferReturnRefund ReturnsGetAvailableSolutionsOfferReturnRefund `json:"offer_return_refund"`
	// offer_refund is
	OfferRefund ReturnsGetAvailableSolutionsOfferRefund `json:"offer_refund"`
}

======================================================= Object Raw Type - ReturnsGetAvailableSolutions =======================================================

type ReturnsGetAvailableSolutionsOfferRefund added in v1.5.4

type ReturnsGetAvailableSolutionsOfferRefund struct {
	// eligibility is To indicate whether Refund solution is available for sellers to select
	Eligibility bool `json:"eligibility,omitempty"`
	// refund_amount_adjustable is To indicate whether refund is adjustable for Refund solution
	RefundAmountAdjustable bool `json:"refund_amount_adjustable,omitempty"`
	// max_refund_amount is The max refund amount for ReturnRefund solution
	MaxRefundAmount float64 `json:"max_refund_amount,omitempty,string"`
}

======================================================= Object Raw Type - ReturnsGetAvailableSolutionsOfferRefund =======================================================

type ReturnsGetAvailableSolutionsOfferReturnRefund added in v1.5.4

type ReturnsGetAvailableSolutionsOfferReturnRefund struct {
	// eligibility is To indicate whether ReturnRefund solution is available for sellers to select
	Eligibility bool `json:"eligibility,omitempty"`
	// refund_amount_adjustable is To indicate whether refund is adjustable for ReturnRefund solution
	RefundAmountAdjustable bool `json:"refund_amount_adjustable,omitempty"`
	// max_refund_amount is The max refund amount for ReturnRefund solution
	MaxRefundAmount float64 `json:"max_refund_amount,omitempty,string"`
}

======================================================= Object Raw Type - ReturnsGetAvailableSolutionsOfferReturnRefund =======================================================

type ReturnsGetAvailableSolutionsRequest added in v1.5.0

type ReturnsGetAvailableSolutionsRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
}

======================================================= ReturnsGetAvailableSolutionsRequest =======================================================

type ReturnsGetAvailableSolutionsResponse added in v1.5.0

type ReturnsGetAvailableSolutionsResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ReturnsGetAvailableSolutions `json:"response"`
}

======================================================= ReturnsGetAvailableSolutionsResponse =======================================================

type ReturnsGetReturnDetail added in v1.5.1

type ReturnsGetReturnDetail struct {
	// image is Image URLs of return.
	Image []string `json:"image,omitempty"`
	// reason is Reason for return product. Applicable values: See Data Definition- ReturnReason.
	Reason string `json:"reason,omitempty"`
	// text_reason is Reason that buyer provide.
	TextReason string `json:"text_reason,omitempty"`
	// return_sn is The serial number of return.
	ReturnSN int `json:"return_sn,omitempty"`
	// refund_amount is Amount of the refund.
	RefundAmount float64 `json:"refund_amount,omitempty,string"`
	// currency is Currency of the return.
	Currency string `json:"currency,omitempty"`
	// create_time is The time of return create.
	CreateTime int `json:"create_time,omitempty"`
	// update_time is The time of modify return.
	UpdateTime int `json:"update_time,omitempty"`
	// status is Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
	Status string `json:"status,omitempty"`
	// due_date is The last time seller deal with this return.
	DueDate int `json:"due_date,omitempty"`
	// tracking_number is The tracking number assigned by the shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// dispute_reason is The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.
	DisputeReason []string `json:"dispute_reason,omitempty"`
	// dispute_text_reason is The reason that seller provide. While the return has been disputed, this field is useful.
	DisputeTextReason []string `json:"dispute_text_reason,omitempty"`
	// needs_logistics is Items to be sent back to seller. Can be either integrated/non-integrated.
	NeedsLogistics bool `json:"needs_logistics,omitempty"`
	// amount_before_discount is Order price before discount.
	AmountBeforeDiscount float64 `json:"amount_before_discount,omitempty,string"`
	// user is
	User ReturnsGetReturnDetailUser `json:"user"`
	// item is
	Item []ReturnsGetReturnDetailItem `json:"item"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// return_ship_due_date is The due date for buyer to ship order.
	ReturnShipDueDate int `json:"return_ship_due_date,omitempty"`
	// return_seller_due_date is The due date for seller to deal with this return when buyer have shipped order.
	ReturnSellerDueDate int `json:"return_seller_due_date,omitempty"`
	// activity is
	Activity []ReturnsGetReturnDetailActivity `json:"activity"`
	// seller_proof is
	SellerProof ReturnsGetReturnDetailSellerProof `json:"seller_proof"`
	// seller_compensation is
	SellerCompensation ReturnsGetReturnDetailSellerCompensation `json:"seller_compensation"`
	// negotiation is
	Negotiation ReturnsGetReturnDetailNegotiation `json:"negotiation"`
	// logistics_status is To indicate the reverse logistic status. See "Data Definition - LogisticsStatus"
	LogisticsStatus string `json:"logistics_status,omitempty"`
	// return_pickup_address is To indicate the buyer's pickup address
	ReturnPickupAddress ReturnsGetReturnDetailReturnPickupAddres `json:"return_pickup_address"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetail =======================================================

type ReturnsGetReturnDetailActivity added in v1.5.4

type ReturnsGetReturnDetailActivity struct {
	// activity_id is The id of activity.
	ActivityID int `json:"activity_id,omitempty"`
	// activity_type is The type of activity.
	ActivityType string `json:"activity_type,omitempty"`
	// original_price is activity's origin price
	OriginalPrice string `json:"original_price,omitempty"`
	// discounted_price is activity's discount price
	DiscountedPrice string `json:"discounted_price,omitempty"`
	// items is
	Items []ReturnsGetReturnDetailActivityItem `json:"items"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailActivity =======================================================

type ReturnsGetReturnDetailActivityItem added in v1.5.5

type ReturnsGetReturnDetailActivityItem struct {
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// variation_id is Shopee's unique identifier for a variation of an item.
	VariationID int `json:"variation_id,omitempty"`
	// quantity_purchased is item's quantity purchase
	QuantityPurchased int `json:"quantity_purchased,omitempty"`
	// original_price is item's origin price
	OriginalPrice string `json:"original_price,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailActivityItem =======================================================

type ReturnsGetReturnDetailItem added in v1.5.4

type ReturnsGetReturnDetailItem struct {
	// model_id is Shopee's unique identifier for a variation of an item.
	ModelID int `json:"model_id,omitempty"`
	// name is Name of item in local language.
	Name string `json:"name,omitempty"`
	// images is Image URLs of item.
	Images []string `json:"images,omitempty"`
	// amount is Amount of this item.
	Amount int `json:"amount,omitempty"`
	// item_price is The price of item.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// is_add_on_deal is To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// is_main_item is To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// add_on_deal_id is The unique identity of an addon deal.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// item_sku is The sku of item.
	ItemSku string `json:"item_sku,omitempty"`
	// variation_sku is the variation sku of item
	VariationSku string `json:"variation_sku,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailItem =======================================================

type ReturnsGetReturnDetailNegotiation added in v1.5.4

type ReturnsGetReturnDetailNegotiation struct {
	// negotiation_status is To indicate whether the seller can negotiate with the buyer. See "Data Definition - NegotiationStatus"
	NegotiationStatus string `json:"negotiation_status,omitempty"`
	// latest_solution is To indicate what is the offer solution. See "Data Definition - ReturnSolution"
	LatestSolution string `json:"latest_solution,omitempty"`
	// latest_offer_amount is To indicate the refund amount in the latest offer solution
	LatestOfferAmount float64 `json:"latest_offer_amount,omitempty,string"`
	// latest_offer_creator is To indicate which party made the latest offer
	LatestOfferCreator string `json:"latest_offer_creator,omitempty"`
	// counter_limit is To indicate the remaining counter limit
	CounterLimit int `json:"counter_limit,omitempty"`
	// offer_due_date is To indicate offer_due_date
	OfferDueDate int `json:"offer_due_date,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailNegotiation =======================================================

type ReturnsGetReturnDetailRequest added in v1.5.0

type ReturnsGetReturnDetailRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
}

======================================================= ReturnsGetReturnDetailRequest =======================================================

type ReturnsGetReturnDetailResponse added in v1.5.0

type ReturnsGetReturnDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Amount of the refund.
	Response ReturnsGetReturnDetail `json:"response"`
}

======================================================= ReturnsGetReturnDetailResponse =======================================================

type ReturnsGetReturnDetailReturnPickupAddres added in v1.5.5

type ReturnsGetReturnDetailReturnPickupAddres struct {
	// address is
	Address string `json:"address,omitempty"`
	// name is
	Name string `json:"name,omitempty"`
	// phone is
	Phone string `json:"phone,omitempty"`
	// town is
	Town string `json:"town,omitempty"`
	// district is
	District string `json:"district,omitempty"`
	// city is
	City string `json:"city,omitempty"`
	// state is
	State string `json:"state,omitempty"`
	// region is
	Region string `json:"region,omitempty"`
	// zipcode is
	Zipcode string `json:"zipcode,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailReturnPickupAddres =======================================================

type ReturnsGetReturnDetailSellerCompensation added in v1.5.4

type ReturnsGetReturnDetailSellerCompensation struct {
	// seller_compensation_status is To indicate whether the seller is eligible for raising a compensation request. See "Data Definition - SellerCompensationStatus"
	SellerCompensationStatus string `json:"seller_compensation_status,omitempty"`
	// seller_compensation_due_date is To indicate the deadline for requesting the compensation
	SellerCompensationDueDate int `json:"seller_compensation_due_date,omitempty"`
	// compensation_amount is To indicate the compensation amount that the agent decided
	CompensationAmount float64 `json:"compensation_amount,omitempty,string"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailSellerCompensation =======================================================

type ReturnsGetReturnDetailSellerProof added in v1.5.4

type ReturnsGetReturnDetailSellerProof struct {
	// seller_proof_status is To indicate whether the seller needs to provide evidence when the return status is RT4 and RT8. See "Data Definition - SellerProofStatus"
	SellerProofStatus string `json:"seller_proof_status,omitempty"`
	// seller_evidence_deadline is To indicate the deadline for submitting the evidence
	SellerEvidenceDeadline int `json:"seller_evidence_deadline,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailSellerProof =======================================================

type ReturnsGetReturnDetailUser added in v1.5.4

type ReturnsGetReturnDetailUser struct {
	// username is Buyer's nickname.
	Username string `json:"username,omitempty"`
	// email is Buyer's email.
	Email string `json:"email,omitempty"`
	// portrait is Buyer's portrait.
	Portrait string `json:"portrait,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnDetailUser =======================================================

type ReturnsGetReturnList added in v1.5.1

type ReturnsGetReturnList struct {
	// more is Whether has next page
	More bool `json:"more,omitempty"`
	// return is
	Return []ReturnsGetReturnListReturn `json:"return"`
}

======================================================= Object Raw Type - ReturnsGetReturnList =======================================================

type ReturnsGetReturnListRequest added in v1.5.0

type ReturnsGetReturnListRequest struct {
	V2RequestAuthenticationParams

	// page_no is Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call.
	PageNo int `json:"page_no"`
	// page_size is if many items are available to retrieve, you may need to call GetReturnList multiple times to retrieve all the data. Each result set is returned as a page of entries. Default is 40. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is usUed to specify the maximum number of entries to return in a single ""page"" of data.
	PageSize int `json:"page_size"`
	// create_time_from is The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
	CreateTimeFrom int `json:"create_time_from,omitempty"`
	// create_time_to is The create_time_from and create_time_to fields specify a date range for retrieving orders (based on the order create time). The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days.
	CreateTimeTo int `json:"create_time_to,omitempty"`
	// status is This is for filtering return request by return status. See "Data Definition - ReturnStatus"
	Status string `json:"status,omitempty"`
	// negotiation_status is This is for filtering return request by counter status. See "Data Definition - NegotiationStatus"
	NegotiationStatus string `json:"negotiation_status,omitempty"`
	// seller_proof_status is This is for filtering return request by proof status. See "Data Definition - SellerProofStatus"
	SellerProofStatus string `json:"seller_proof_status,omitempty"`
	// seller_compensation_status is This is for filtering return request by compensation status. See "Data Definition - SellerCompensationStatus"
	SellerCompensationStatus string `json:"seller_compensation_status,omitempty"`
}

======================================================= ReturnsGetReturnListRequest =======================================================

type ReturnsGetReturnListResponse added in v1.5.0

type ReturnsGetReturnListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Amount of the refund.
	Response []ReturnsGetReturnList `json:"response,omitempty"`
}

======================================================= ReturnsGetReturnListResponse =======================================================

type ReturnsGetReturnListReturn added in v1.5.4

type ReturnsGetReturnListReturn struct {
	// image is Image URLs of return.
	Image []string `json:"image,omitempty"`
	// reason is Reason for return product. Applicable values: See Data Definition- ReturnReason.
	Reason string `json:"reason,omitempty"`
	// text_reason is Reason that buyer provide.
	TextReason string `json:"text_reason,omitempty"`
	// return_sn is The serial number of return.
	ReturnSN int `json:"return_sn,omitempty"`
	// refund_amount is Amount of the refund.
	RefundAmount float64 `json:"refund_amount,omitempty,string"`
	// currency is Currency of the return.
	Currency string `json:"currency,omitempty"`
	// create_time is The time of return create.
	CreateTime int `json:"create_time,omitempty"`
	// update_time is The time of modify return.
	UpdateTime int `json:"update_time,omitempty"`
	// status is Enumerated type that defines the current status of the return. Applicable values: See Data Definition- ReturnStatus.
	Status string `json:"status,omitempty"`
	// due_date is The last time seller deal with this return.
	DueDate int `json:"due_date,omitempty"`
	// tracking_number is The tracking number assigned by the shipping carrier for item shipment.
	TrackingNumber string `json:"tracking_number,omitempty"`
	// dispute_reason is The reason of seller dispute return. While the return has been disputed, this field is useful. Applicable values: See Data Definition- ReturnDisputeReason.
	DisputeReason []string `json:"dispute_reason,omitempty"`
	// dispute_text_reason is The reason that seller provide. While the return has been disputed, this field is useful.
	DisputeTextReason []string `json:"dispute_text_reason,omitempty"`
	// needs_logistics is Items to be sent back to seller. Can be either integrated/non-integrated.
	NeedsLogistics bool `json:"needs_logistics,omitempty"`
	// amount_before_discount is Order price before discount.
	AmountBeforeDiscount float64 `json:"amount_before_discount,omitempty,string"`
	// user is
	User ReturnsGetReturnListReturnUser `json:"user"`
	// item is
	Item []ReturnsGetReturnListReturnItem `json:"item"`
	// order_sn is Shopee's unique identifier for an order.
	OrderSN string `json:"order_sn,omitempty"`
	// return_ship_due_date is The due date for buyer to ship order.
	ReturnShipDueDate int `json:"return_ship_due_date,omitempty"`
	// return_seller_due_date is The due date for seller to deal with this return when buyer have shipped order.
	ReturnSellerDueDate int `json:"return_seller_due_date,omitempty"`
	// negotiation_status is Counter status. See "Data Definition - NegotiationStatus"
	NegotiationStatus string `json:"negotiation_status,omitempty"`
	// seller_proof_status is Proof status. See "Data Definition - SellerProofStatus"
	SellerProofStatus string `json:"seller_proof_status,omitempty"`
	// seller_compensation_status is Compensation status. See "Data Definition - SellerCompensationStatus"
	SellerCompensationStatus string `json:"seller_compensation_status,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnListReturn =======================================================

type ReturnsGetReturnListReturnItem added in v1.5.4

type ReturnsGetReturnListReturnItem struct {
	// model_id is Shopee's unique identifier for a variation of an item.
	ModelID int `json:"model_id,omitempty"`
	// name is Name of item in local language.
	Name string `json:"name,omitempty"`
	// images is Image URLs of item.
	Images []string `json:"images,omitempty"`
	// amount is Amount of this item.
	Amount int `json:"amount,omitempty"`
	// item_price is The price of item.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// is_add_on_deal is To indicate if this item belongs to an addon deal.
	IsAddOnDeal bool `json:"is_add_on_deal,omitempty"`
	// is_main_item is To indicate if this item is main item or sub item. True means main item, false means sub item.
	IsMainItem bool `json:"is_main_item,omitempty"`
	// add_on_deal_id is The unique identity of an addon deal.
	AddOnDealID int `json:"add_on_deal_id,omitempty"`
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// item_sku is The sku of item.
	ItemSku string `json:"item_sku,omitempty"`
	// variation_sku is The variation sku of item
	VariationSku string `json:"variation_sku,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnListReturnItem =======================================================

type ReturnsGetReturnListReturnUser added in v1.5.4

type ReturnsGetReturnListReturnUser struct {
	// username is Buyer's nickname.
	Username string `json:"username,omitempty"`
	// email is Buyer's email.
	Email string `json:"email,omitempty"`
	// portrait is Buyer's portrait.
	Portrait string `json:"portrait,omitempty"`
}

======================================================= Object Raw Type - ReturnsGetReturnListReturnUser =======================================================

type ReturnsOffer added in v1.5.1

type ReturnsOffer struct {
	// return_sn is
	ReturnSN string `json:"return_sn,omitempty"`
}

======================================================= Object Raw Type - ReturnsOffer =======================================================

type ReturnsOfferRequest added in v1.5.0

type ReturnsOfferRequest struct {
	V2RequestAuthenticationParams

	// return_sn is The serial number of return.
	ReturnSN string `json:"return_sn"`
	// proposed_solution is The new solution to be offered. See "Data Definition - ReturnSolution"
	ProposedSolution string `json:"proposed_solution"`
	// proposed_adjusted_refund_amount is The new refund amount to be offered
	ProposedAdjustedRefundAmount float64 `json:"proposed_adjusted_refund_amount,omitempty,string"`
}

======================================================= ReturnsOfferRequest =======================================================

type ReturnsOfferResponse added in v1.5.0

type ReturnsOfferResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ReturnsOffer `json:"response,omitempty"`
}

======================================================= ReturnsOfferResponse =======================================================

type SellerInfo added in v1.5.0

type SellerInfo struct {
	// address is The full address of the seller.
	Address string `json:"address,omitempty"`
	// name is Seller's name for the address.
	Name string `json:"name,omitempty"`
	// zipcode is Seller's postal code.
	Zipcode string `json:"zipcode,omitempty"`
	// region is Seller's location.
	Region string `json:"region,omitempty"`
	// phone is Seller's phone number.
	Phone string `json:"phone,omitempty"`
}

======================================================= Object Raw Type - SellerInfo =======================================================

type SellerStock added in v1.5.1

type SellerStock struct {
	// location_id is <p>location id,&nbsp;you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouses, you don't need to upload this field.<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock<br /></p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - SellerStock =======================================================

type SetPushConfigRequestDeatiledConfig

type SetPushConfigRequestDeatiledConfig struct {
	// 0 stands for off and 1 stands for on.
	OrderStatus int `json:"order_status,omitempty"`
	// 0 stands for off and 1 stands for on.
	OrderTrackingNo int `json:"order_trackingno,omitempty"`
	// 0 stands for off and 1 stands for on.
	ShopUpdate int `json:"shop_update,omitempty"`
	// 0 stands for off and 1 stands for on.
	BannedItem int `json:"banned_item,omitempty"`
	// 0 stands for off and 1 stands for on.
	ItemPromotion int `json:"item_promotion,omitempty"`
	// 0 stands for off and 1 stands for on.
	ReservedStockChange int `json:"reserved_stock_change,omitempty"`
}

type SetShopInstallmentStatusRequest

type SetShopInstallmentStatusRequest struct {
	// The status of whether shop support installment: 1 means true and 0 means false.
	InstallmentStatus int `json:"installment_status,omitempty"`
	// Partner ID is assigned upon registration is successful. Required for all requests.
	PartnerID int64 `json:"partner_id,omitempty"`
	// Shopee's unique identifier for a shop. Required for all requests.
	ShopID int64 `json:"shopid,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type SetShopInstallmentStatusResponse

type SetShopInstallmentStatusResponse struct {
	// The status of whether shop support installment: 1 means true and 0 means false.
	InstallmentStatus int `json:"installment_status,omitempty"`
}

type ShopCategoryAddItemList added in v1.5.1

type ShopCategoryAddItemList struct {
	// invalid_item_id_list is List of invalid item ids.
	InvalidItemIdList []ShopCategoryAddItemListInvalidItemId `json:"invalid_item_id_list"`
	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id,omitempty"`
	// current_count is Count of items under this shop category after deletion.
	CurrentCount int `json:"current_count,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryAddItemList =======================================================

type ShopCategoryAddItemListInvalidItemId added in v1.5.5

type ShopCategoryAddItemListInvalidItemId struct {
	// item_id is The invalid item id.
	ItemID int `json:"item_id,omitempty"`
	// fail_error is The reason of the fail.
	FailError string `json:"fail_error,omitempty"`
	// fail_message is The detailed reason of the failure and the hints of error fixing
	FailMessage string `json:"fail_message,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryAddItemListInvalidItemId =======================================================

type ShopCategoryAddItemListRequest added in v1.5.0

type ShopCategoryAddItemListRequest struct {
	V2RequestAuthenticationParams

	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id"`
	// item_list is Shopee's unique identifiers list for an item. Max. 100 items to be deleted per request.
	ItemList []int `json:"item_list"`
}

======================================================= ShopCategoryAddItemListRequest =======================================================

type ShopCategoryAddItemListResponse added in v1.5.0

type ShopCategoryAddItemListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryAddItemList `json:"response"`
}

======================================================= ShopCategoryAddItemListResponse =======================================================

type ShopCategoryAddShopCategory added in v1.5.1

type ShopCategoryAddShopCategory struct {
	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryAddShopCategory =======================================================

type ShopCategoryAddShopCategoryRequest added in v1.5.0

type ShopCategoryAddShopCategoryRequest struct {
	V2RequestAuthenticationParams

	// name is ShopCategory's name.
	Name string `json:"name"`
	// sort_weight is ShopCategory's sort weight. The maximum number should be 2147483546.
	SortWeight int `json:"sort_weight,omitempty"`
}

======================================================= ShopCategoryAddShopCategoryRequest =======================================================

type ShopCategoryAddShopCategoryResponse added in v1.5.0

type ShopCategoryAddShopCategoryResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryAddShopCategory `json:"response,omitempty"`
}

======================================================= ShopCategoryAddShopCategoryResponse =======================================================

type ShopCategoryDeleteItemList added in v1.5.1

type ShopCategoryDeleteItemList struct {
	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id,omitempty"`
	// invalid_item_id is The list of item ids which are invalid; In other words, the item ids not being under the category.
	InvalidItemID []int `json:"invalid_item_id,omitempty"`
	// current_count is count of items under this shop category after deleting
	CurrentCount int `json:"current_count,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryDeleteItemList =======================================================

type ShopCategoryDeleteItemListRequest added in v1.5.0

type ShopCategoryDeleteItemListRequest struct {
	V2RequestAuthenticationParams

	// shop_category_id is The list of items need to be deleted. To note that the items which can be deleted successfully should be under this category.
	ShopCategoryID int `json:"shop_category_id"`
	// item_list is ShopCategory's unique identifier.
	ItemList []int `json:"item_list"`
}

======================================================= ShopCategoryDeleteItemListRequest =======================================================

type ShopCategoryDeleteItemListResponse added in v1.5.0

type ShopCategoryDeleteItemListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryDeleteItemList `json:"response"`
}

======================================================= ShopCategoryDeleteItemListResponse =======================================================

type ShopCategoryDeleteShopCategory added in v1.5.1

type ShopCategoryDeleteShopCategory struct {
	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id,omitempty"`
	// msg is The return message of the operation result
	Msg string `json:"msg,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryDeleteShopCategory =======================================================

type ShopCategoryDeleteShopCategoryRequest added in v1.5.0

type ShopCategoryDeleteShopCategoryRequest struct {
	V2RequestAuthenticationParams

	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id"`
}

======================================================= ShopCategoryDeleteShopCategoryRequest =======================================================

type ShopCategoryDeleteShopCategoryResponse added in v1.5.0

type ShopCategoryDeleteShopCategoryResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryDeleteShopCategory `json:"response"`
}

======================================================= ShopCategoryDeleteShopCategoryResponse =======================================================

type ShopCategoryGetItemList added in v1.5.1

type ShopCategoryGetItemList struct {
	// item_list is A list of Shopee's unique identifiers for items.
	ItemList []int `json:"item_list,omitempty"`
	// total_count is This is to indicate the whole number of items under the shop category.
	TotalCount int `json:"total_count,omitempty"`
	// more is This is to indicate whether the item list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of items.
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryGetItemList =======================================================

type ShopCategoryGetItemListRequest added in v1.5.0

type ShopCategoryGetItemListRequest struct {
	V2RequestAuthenticationParams

	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id"`
	// page_size is Specifies the starting entry of data to return in the current call. Default is 1000. The input range of page_size is [0, 1000]
	PageSize int `json:"page_size,omitempty"`
	// page_no is If many items are available to retrieve, you may need to call this api multiple times to retrieve all the data. And the default will be 0. page_size*page_no should be [0, 2147483446].
	PageNo int `json:"page_no,omitempty"`
}

======================================================= ShopCategoryGetItemListRequest =======================================================

type ShopCategoryGetItemListResponse added in v1.5.0

type ShopCategoryGetItemListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryGetItemList `json:"response,omitempty"`
}

======================================================= ShopCategoryGetItemListResponse =======================================================

type ShopCategoryGetShopCategoryList added in v1.5.1

type ShopCategoryGetShopCategoryList struct {
	// shop_categorys is ShopCategory's unique identifier.
	ShopCategorys []ShopCategoryGetShopCategoryListShopCategory `json:"shop_categorys"`
	// total_count is This is to indicate the whole number of  in-shop categories under the shop.
	TotalCount int `json:"total_count,omitempty"`
	// more is This is to indicate whether the list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest.
	More bool `json:"more,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryGetShopCategoryList =======================================================

type ShopCategoryGetShopCategoryListRequest added in v1.5.0

type ShopCategoryGetShopCategoryListRequest struct {
	V2RequestAuthenticationParams

	// page_size is Specifies the starting entry of data to return in the current call. The parameter range of page_size should be [1, 2147483647]
	PageSize int `json:"page_size"`
	// page_no is Specifies the total returned data per entry. The parameter range of page_no should be [1, 100]
	PageNo int `json:"page_no"`
}

======================================================= ShopCategoryGetShopCategoryListRequest =======================================================

type ShopCategoryGetShopCategoryListResponse added in v1.5.0

type ShopCategoryGetShopCategoryListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryGetShopCategoryList `json:"response"`
}

======================================================= ShopCategoryGetShopCategoryListResponse =======================================================

type ShopCategoryGetShopCategoryListShopCategory added in v1.5.5

type ShopCategoryGetShopCategoryListShopCategory struct {
	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id,omitempty"`
	// status is ShopCategory's status. Applicable values--1: 'NORMAL', 2: 'INACTIVE', 0: 'DELETED'
	Status int `json:"status,omitempty"`
	// name is ShopCategory's name.
	Name string `json:"name,omitempty"`
	// sort_weight is ShopCategory's sort weight.
	SortWeight int `json:"sort_weight,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryGetShopCategoryListShopCategory =======================================================

type ShopCategoryUpdateShopCategory added in v1.5.1

type ShopCategoryUpdateShopCategory struct {
	// shop_category_id is This is to indicate whether the shop categories list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of shop categories
	ShopCategoryID int `json:"shop_category_id,omitempty"`
	// name is ShopCategory's name.
	Name string `json:"name,omitempty"`
	// sort_weight is ShopCategory's sort weight.
	SortWeight int `json:"sort_weight,omitempty"`
	// status is ShopCategory's status. Applicable values: NORMAL, INACTIVE, DELETED.
	Status string `json:"status,omitempty"`
}

======================================================= Object Raw Type - ShopCategoryUpdateShopCategory =======================================================

type ShopCategoryUpdateShopCategoryRequest added in v1.5.0

type ShopCategoryUpdateShopCategoryRequest struct {
	V2RequestAuthenticationParams

	// shop_category_id is ShopCategory's unique identifier.
	ShopCategoryID int `json:"shop_category_id"`
	// name is ShopCategory's name.
	Name string `json:"name,omitempty"`
	// sort_weight is ShopCategory's sort weight.
	SortWeight int `json:"sort_weight,omitempty"`
	// status is ShopCategory's status. Applicable values: NORMAL, INACTIVE, DELETED.
	Status string `json:"status,omitempty"`
}

======================================================= ShopCategoryUpdateShopCategoryRequest =======================================================

type ShopCategoryUpdateShopCategoryResponse added in v1.5.0

type ShopCategoryUpdateShopCategoryResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response ShopCategoryUpdateShopCategory `json:"response,omitempty"`
}

======================================================= ShopCategoryUpdateShopCategoryResponse =======================================================

type ShopGetProfile added in v1.5.2

type ShopGetProfile struct {
	ShopLogo string `json:"shop_logo,omitempty"`
	// description is The content of the shop description.
	Description string `json:"description,omitempty"`
	// shop_name is The content of the shop name.
	ShopName string `json:"shop_name,omitempty"`
}

======================================================= Object Raw Type - ShopGetProfile =======================================================

type ShopGetProfileRequest added in v1.5.0

type ShopGetProfileRequest struct {
	V2RequestAuthenticationParams
}

======================================================= ShopGetProfileRequest =======================================================

type ShopGetProfileResponse added in v1.5.0

type ShopGetProfileResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is The information about shop logo, shop name, shop description.
	Response ShopGetProfile `json:"response,omitempty"`
}

======================================================= ShopGetProfileResponse =======================================================

type ShopGetShopInfoRequest added in v1.5.0

type ShopGetShopInfoRequest struct {
	V2RequestAuthenticationParams
}

======================================================= ShopGetShopInfoRequest =======================================================

type ShopGetShopInfoResponse added in v1.5.0

type ShopGetShopInfoResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse
}

======================================================= ShopGetShopInfoResponse =======================================================

type ShopGetWarehouseDetail added in v1.5.1

type ShopGetWarehouseDetail struct {
	// warehouse_id is <p>Warehouse address identifier. It should be unique for every warehouse address<br /></p>
	WarehouseID int `json:"warehouse_id,omitempty"`
	// warehouse_name is <p>The warehouse name filled in when creating the warehouse address</p>
	WarehouseName string `json:"warehouse_name,omitempty"`
	// location_id is <p>Location identifier for stocks. Different location_ids represent that your addresses are in different item stocks</p>
	LocationID string `json:"location_id,omitempty"`
	// country is <p>Country of your warehouse address</p>
	Country string `json:"country,omitempty"`
	// state is <p>State of your warehouse address<br /></p>
	State string `json:"state,omitempty"`
	// city is <p>City of your warehouse address<br /></p>
	City string `json:"city,omitempty"`
	// district is <p>Distinct of your warehouse address<br /></p>
	District string `json:"district,omitempty"`
	// town is <p>Town of your warehouse address<br /></p>
	Town string `json:"town,omitempty"`
	// address is <p>Detail address of your warehouse address</p>
	Address string `json:"address,omitempty"`
	// zipcode is <p>Zipcode of your warehouse address<br /></p>
	Zipcode string `json:"zipcode,omitempty"`
	// state_code is <p>State code of your warehouse address<br /></p>
	StateCode string `json:"state_code,omitempty"`
	// holiday_mode_state is <p>The holiday mode state of your address.<br />0: not in holiday mode</p><p>1: holiday mode active</p><p>2: holiday mode is turning of</p><p>3: holiday mode is turning on</p>
	HolidayModeState int `json:"holiday_mode_state,omitempty"`
}

======================================================= Object Raw Type - ShopGetWarehouseDetail =======================================================

type ShopGetWarehouseDetailRequest added in v1.5.0

type ShopGetWarehouseDetailRequest struct {
	V2RequestAuthenticationParams
}

======================================================= ShopGetWarehouseDetailRequest =======================================================

type ShopGetWarehouseDetailResponse added in v1.5.0

type ShopGetWarehouseDetailResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is
	Response []ShopGetWarehouseDetail `json:"response,omitempty"`
}

======================================================= ShopGetWarehouseDetailResponse =======================================================

type ShopSyncList added in v1.5.1

type ShopSyncList struct {
	// shop_id is Id of shop.
	ShopID int `json:"shop_id,omitempty"`
	// shop_region is TW TH MY BR IN SG VN
	ShopRegion string `json:"shop_region,omitempty"`
	// name_and_description is sync name and description
	NameAndDescription bool `json:"name_and_description,omitempty"`
	// media_information is sync media information
	MediaInformation bool `json:"media_information,omitempty"`
	// tier_variation_name_and_option is sync tier variation
	TierVariationNameAndOption bool `json:"tier_variation_name_and_option,omitempty"`
	// price is sync price
	Price bool `json:"price,omitempty"`
	// days_to_ship is sync days to ship info
	DaysToShip bool `json:"days_to_ship,omitempty"`
}

======================================================= Object Raw Type - ShopSyncList =======================================================

type ShopUpdateProfile added in v1.5.2

type ShopUpdateProfile struct {
	ShopLogo string `json:"shop_logo,omitempty"`
	// description is The content of the shop description after updated.
	Description string `json:"description,omitempty"`
	// shop_name is The content of the shop name after updated.
	ShopName string `json:"shop_name,omitempty"`
}

======================================================= Object Raw Type - ShopUpdateProfile =======================================================

type ShopUpdateProfileRequest added in v1.5.0

type ShopUpdateProfileRequest struct {
	V2RequestAuthenticationParams

	// shop_name is The new shop name
	ShopName string `json:"shop_name,omitempty"`
	ShopLogo string `json:"shop_logo,omitempty"`
	// description is The new shop description.
	Description string `json:"description,omitempty"`
}

======================================================= ShopUpdateProfileRequest =======================================================

type ShopUpdateProfileResponse added in v1.5.0

type ShopUpdateProfileResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is If update successfully, the information is about shop logo, shop name, shop description.
	Response ShopUpdateProfile `json:"response,omitempty"`
}

======================================================= ShopUpdateProfileResponse =======================================================

type ShopeeClient

type ShopeeClient struct {
	Secret string

	IsSandbox bool
	Version   ClientVersion
	// contains filtered or unexported fields
}

ShopeeClient represents a client to Shopee

func (*ShopeeClient) AccountHealthShopPenalty added in v1.5.0

func (s *ShopeeClient) AccountHealthShopPenalty(req *AccountHealthShopPenaltyRequest) (err error)

func (*ShopeeClient) AccountHealthShopPerformance added in v1.5.0

func (s *ShopeeClient) AccountHealthShopPerformance(req *AccountHealthShopPerformanceRequest) (err error)

func (*ShopeeClient) AddOnDealAddAddOnDeal added in v1.5.0

func (s *ShopeeClient) AddOnDealAddAddOnDeal(req *AddOnDealAddAddOnDealRequest) (resp *AddOnDealAddAddOnDeal, err error)

func (*ShopeeClient) AddOnDealAddAddOnDealMainItem added in v1.5.0

func (s *ShopeeClient) AddOnDealAddAddOnDealMainItem(req *AddOnDealAddAddOnDealMainItemRequest) (resp *AddOnDealAddAddOnDealMainItem, err error)

func (*ShopeeClient) AddOnDealAddAddOnDealSubItem added in v1.5.0

func (s *ShopeeClient) AddOnDealAddAddOnDealSubItem(req *AddOnDealAddAddOnDealSubItemRequest) (resp *AddOnDealAddAddOnDealSubItem, err error)

func (*ShopeeClient) AddOnDealDeleteAddOnDeal added in v1.5.0

func (s *ShopeeClient) AddOnDealDeleteAddOnDeal(req *AddOnDealDeleteAddOnDealRequest) (resp *AddOnDealDeleteAddOnDeal, err error)

func (*ShopeeClient) AddOnDealDeleteAddOnDealMainItem added in v1.5.0

func (s *ShopeeClient) AddOnDealDeleteAddOnDealMainItem(req *AddOnDealDeleteAddOnDealMainItemRequest) (resp *AddOnDealDeleteAddOnDealMainItem, err error)

func (*ShopeeClient) AddOnDealDeleteAddOnDealSubItem added in v1.5.0

func (s *ShopeeClient) AddOnDealDeleteAddOnDealSubItem(req *AddOnDealDeleteAddOnDealSubItemRequest) (resp *AddOnDealDeleteAddOnDealSubItem, err error)

func (*ShopeeClient) AddOnDealEndAddOnDeal added in v1.5.0

func (s *ShopeeClient) AddOnDealEndAddOnDeal(req *AddOnDealEndAddOnDealRequest) (resp *AddOnDealEndAddOnDeal, err error)

func (*ShopeeClient) AddOnDealGetAddOnDeal added in v1.5.0

func (s *ShopeeClient) AddOnDealGetAddOnDeal(req *AddOnDealGetAddOnDealRequest) (resp *AddOnDealGetAddOnDeal, err error)

func (*ShopeeClient) AddOnDealGetAddOnDealList added in v1.5.0

func (s *ShopeeClient) AddOnDealGetAddOnDealList(req *AddOnDealGetAddOnDealListRequest) (resp *AddOnDealGetAddOnDealList, err error)

func (*ShopeeClient) AddOnDealGetAddOnDealMainItem added in v1.5.0

func (s *ShopeeClient) AddOnDealGetAddOnDealMainItem(req *AddOnDealGetAddOnDealMainItemRequest) (resp *AddOnDealGetAddOnDealMainItem, err error)

func (*ShopeeClient) AddOnDealGetAddOnDealSubItem added in v1.5.0

func (s *ShopeeClient) AddOnDealGetAddOnDealSubItem(req *AddOnDealGetAddOnDealSubItemRequest) (resp *AddOnDealGetAddOnDealSubItem, err error)

func (*ShopeeClient) AddOnDealUpdateAddOnDeal added in v1.5.0

func (s *ShopeeClient) AddOnDealUpdateAddOnDeal(req *AddOnDealUpdateAddOnDealRequest) (resp *AddOnDealUpdateAddOnDeal, err error)

func (*ShopeeClient) AddOnDealUpdateAddOnDealMainItem added in v1.5.0

func (s *ShopeeClient) AddOnDealUpdateAddOnDealMainItem(req *AddOnDealUpdateAddOnDealMainItemRequest) (resp *AddOnDealUpdateAddOnDealMainItem, err error)

func (*ShopeeClient) AddOnDealUpdateAddOnDealSubItem added in v1.5.0

func (s *ShopeeClient) AddOnDealUpdateAddOnDealSubItem(req *AddOnDealUpdateAddOnDealSubItemRequest) (resp *AddOnDealUpdateAddOnDealSubItem, err error)

func (*ShopeeClient) AuthPartner

func (s *ShopeeClient) AuthPartner(req *AuthPartnerRequest) string

AuthPartner for V2.

func (*ShopeeClient) BundleDealAddBundleDeal added in v1.5.0

func (s *ShopeeClient) BundleDealAddBundleDeal(req *BundleDealAddBundleDealRequest) (resp *BundleDealAddBundleDeal, err error)

func (*ShopeeClient) BundleDealAddBundleDealItem added in v1.5.0

func (s *ShopeeClient) BundleDealAddBundleDealItem(req *BundleDealAddBundleDealItemRequest) (resp *BundleDealAddBundleDealItem, err error)

func (*ShopeeClient) BundleDealDeleteBundleDeal added in v1.5.0

func (s *ShopeeClient) BundleDealDeleteBundleDeal(req *BundleDealDeleteBundleDealRequest) (resp *BundleDealDeleteBundleDeal, err error)

func (*ShopeeClient) BundleDealDeleteBundleDealItem added in v1.5.0

func (s *ShopeeClient) BundleDealDeleteBundleDealItem(req *BundleDealDeleteBundleDealItemRequest) (resp *BundleDealDeleteBundleDealItem, err error)

func (*ShopeeClient) BundleDealEndBundleDeal added in v1.5.0

func (s *ShopeeClient) BundleDealEndBundleDeal(req *BundleDealEndBundleDealRequest) (resp *BundleDealEndBundleDeal, err error)

func (*ShopeeClient) BundleDealGetBundleDeal added in v1.5.0

func (s *ShopeeClient) BundleDealGetBundleDeal(req *BundleDealGetBundleDealRequest) (resp *BundleDealGetBundleDeal, err error)

func (*ShopeeClient) BundleDealGetBundleDealItem added in v1.5.0

func (s *ShopeeClient) BundleDealGetBundleDealItem(req *BundleDealGetBundleDealItemRequest) (resp *BundleDealGetBundleDealItem, err error)

func (*ShopeeClient) BundleDealGetBundleDealList added in v1.5.0

func (s *ShopeeClient) BundleDealGetBundleDealList(req *BundleDealGetBundleDealListRequest) (resp *BundleDealGetBundleDealList, err error)

func (*ShopeeClient) BundleDealUpdateBundleDeal added in v1.5.0

func (s *ShopeeClient) BundleDealUpdateBundleDeal(req *BundleDealUpdateBundleDealRequest) (resp *BundleDealUpdateBundleDeal, err error)

func (*ShopeeClient) BundleDealUpdateBundleDealItem added in v1.5.0

func (s *ShopeeClient) BundleDealUpdateBundleDealItem(req *BundleDealUpdateBundleDealItemRequest) (resp *BundleDealUpdateBundleDealItem, err error)

func (*ShopeeClient) DiscountAddDiscount added in v1.5.0

func (s *ShopeeClient) DiscountAddDiscount(req *DiscountAddDiscountRequest) (resp *DiscountAddDiscount, err error)

func (*ShopeeClient) DiscountAddDiscountItem added in v1.5.0

func (s *ShopeeClient) DiscountAddDiscountItem(req *DiscountAddDiscountItemRequest) (resp *DiscountAddDiscountItem, err error)

func (*ShopeeClient) DiscountDeleteDiscount added in v1.5.0

func (s *ShopeeClient) DiscountDeleteDiscount(req *DiscountDeleteDiscountRequest) (resp *DiscountDeleteDiscount, err error)

func (*ShopeeClient) DiscountDeleteDiscountItem added in v1.5.0

func (s *ShopeeClient) DiscountDeleteDiscountItem(req *DiscountDeleteDiscountItemRequest) (resp *DiscountDeleteDiscountItem, err error)

func (*ShopeeClient) DiscountEndDiscount added in v1.5.0

func (s *ShopeeClient) DiscountEndDiscount(req *DiscountEndDiscountRequest) (resp *DiscountEndDiscount, err error)

func (*ShopeeClient) DiscountGetDiscount added in v1.5.0

func (s *ShopeeClient) DiscountGetDiscount(req *DiscountGetDiscountRequest) (resp *DiscountGetDiscount, err error)

func (*ShopeeClient) DiscountGetDiscountList added in v1.5.0

func (s *ShopeeClient) DiscountGetDiscountList(req *DiscountGetDiscountListRequest) (resp *DiscountGetDiscountList, err error)

func (*ShopeeClient) DiscountUpdateDiscount added in v1.5.0

func (s *ShopeeClient) DiscountUpdateDiscount(req *DiscountUpdateDiscountRequest) (resp *DiscountUpdateDiscount, err error)

func (*ShopeeClient) DiscountUpdateDiscountItem added in v1.5.0

func (s *ShopeeClient) DiscountUpdateDiscountItem(req *DiscountUpdateDiscountItemRequest) (resp *DiscountUpdateDiscountItem, err error)

func (*ShopeeClient) FirstMileBindFirstMileTrackingNumber added in v1.5.0

func (s *ShopeeClient) FirstMileBindFirstMileTrackingNumber(req *FirstMileBindFirstMileTrackingNumberRequest) (resp *FirstMileBindFirstMileTrackingNumber, err error)

func (*ShopeeClient) FirstMileGenerateFirstMileTrackingNumber added in v1.5.0

func (s *ShopeeClient) FirstMileGenerateFirstMileTrackingNumber(req *FirstMileGenerateFirstMileTrackingNumberRequest) (resp *FirstMileGenerateFirstMileTrackingNumber, err error)

func (*ShopeeClient) FirstMileGetChannelList added in v1.5.0

func (s *ShopeeClient) FirstMileGetChannelList(req *FirstMileGetChannelListRequest) (resp *FirstMileGetChannelList, err error)

func (*ShopeeClient) FirstMileGetDetail added in v1.5.0

func (s *ShopeeClient) FirstMileGetDetail(req *FirstMileGetDetailRequest) (resp *FirstMileGetDetail, err error)

func (*ShopeeClient) FirstMileGetTrackingNumberList added in v1.5.0

func (s *ShopeeClient) FirstMileGetTrackingNumberList(req *FirstMileGetTrackingNumberListRequest) (resp *FirstMileGetTrackingNumberList, err error)

func (*ShopeeClient) FirstMileGetUnbindOrderList added in v1.5.0

func (s *ShopeeClient) FirstMileGetUnbindOrderList(req *FirstMileGetUnbindOrderListRequest) (resp *FirstMileGetUnbindOrderList, err error)

func (*ShopeeClient) FirstMileGetWaybill added in v1.5.0

func (s *ShopeeClient) FirstMileGetWaybill(req *FirstMileGetWaybillRequest) (err error)

func (*ShopeeClient) FirstMileUnbindFirstMileTrackingNumber added in v1.5.0

func (s *ShopeeClient) FirstMileUnbindFirstMileTrackingNumber(req *FirstMileUnbindFirstMileTrackingNumberRequest) (resp *FirstMileUnbindFirstMileTrackingNumber, err error)

func (*ShopeeClient) FollowPrizeAddFollowPrize added in v1.5.0

func (s *ShopeeClient) FollowPrizeAddFollowPrize(req *FollowPrizeAddFollowPrizeRequest) (resp *FollowPrizeAddFollowPrize, err error)

func (*ShopeeClient) FollowPrizeDeleteFollowPrize added in v1.5.0

func (s *ShopeeClient) FollowPrizeDeleteFollowPrize(req *FollowPrizeDeleteFollowPrizeRequest) (resp *FollowPrizeDeleteFollowPrize, err error)

func (*ShopeeClient) FollowPrizeEndFollowPrize added in v1.5.0

func (s *ShopeeClient) FollowPrizeEndFollowPrize(req *FollowPrizeEndFollowPrizeRequest) (resp *FollowPrizeEndFollowPrize, err error)

func (*ShopeeClient) FollowPrizeGetFollowPrizeDetail added in v1.5.0

func (s *ShopeeClient) FollowPrizeGetFollowPrizeDetail(req *FollowPrizeGetFollowPrizeDetailRequest) (resp *FollowPrizeGetFollowPrizeDetail, err error)

func (*ShopeeClient) FollowPrizeGetFollowPrizeList added in v1.5.0

func (s *ShopeeClient) FollowPrizeGetFollowPrizeList(req *FollowPrizeGetFollowPrizeListRequest) (resp *FollowPrizeGetFollowPrizeList, err error)

func (*ShopeeClient) FollowPrizeUpdateFollowPrize added in v1.5.0

func (s *ShopeeClient) FollowPrizeUpdateFollowPrize(req *FollowPrizeUpdateFollowPrizeRequest) (resp *FollowPrizeUpdateFollowPrize, err error)

func (*ShopeeClient) GetAccessToken

func (s *ShopeeClient) GetAccessToken(req *GetAccessTokenRequest) (resp *GetAccessTokenResponse, err error)

GetAccessToken Use this API and the code to obtain the access_token and refresh_token.

func (*ShopeeClient) GetShopInfo

func (s *ShopeeClient) GetShopInfo(req *GetShopInfoRequest) (resp *GetShopInfoResponse, err error)

GetShopInfo Use this call to get information of shop

func (*ShopeeClient) GlobalProductAddGlobalItem added in v1.5.0

func (s *ShopeeClient) GlobalProductAddGlobalItem(req *GlobalProductAddGlobalItemRequest) (resp *GlobalProductAddGlobalItem, err error)

func (*ShopeeClient) GlobalProductAddGlobalModel added in v1.5.0

func (s *ShopeeClient) GlobalProductAddGlobalModel(req *GlobalProductAddGlobalModelRequest) (err error)

func (*ShopeeClient) GlobalProductCategoryRecommend added in v1.5.0

func (s *ShopeeClient) GlobalProductCategoryRecommend(req *GlobalProductCategoryRecommendRequest) (resp *GlobalProductCategoryRecommend, err error)

func (*ShopeeClient) GlobalProductCreatePublishTask added in v1.5.0

func (s *ShopeeClient) GlobalProductCreatePublishTask(req *GlobalProductCreatePublishTaskRequest) (resp *GlobalProductCreatePublishTask, err error)

func (*ShopeeClient) GlobalProductDeleteGlobalItem added in v1.5.0

func (s *ShopeeClient) GlobalProductDeleteGlobalItem(req *GlobalProductDeleteGlobalItemRequest) (resp *GlobalProductDeleteGlobalItem, err error)

func (*ShopeeClient) GlobalProductDeleteGlobalModel added in v1.5.0

func (s *ShopeeClient) GlobalProductDeleteGlobalModel(req *GlobalProductDeleteGlobalModelRequest) (resp *GlobalProductDeleteGlobalModel, err error)

func (*ShopeeClient) GlobalProductGetAttributes added in v1.5.0

func (s *ShopeeClient) GlobalProductGetAttributes(req *GlobalProductGetAttributesRequest) (resp *GlobalProductGetAttributes, err error)

func (*ShopeeClient) GlobalProductGetBrandList added in v1.5.0

func (s *ShopeeClient) GlobalProductGetBrandList(req *GlobalProductGetBrandListRequest) (resp *GlobalProductGetBrandList, err error)

func (*ShopeeClient) GlobalProductGetCategory added in v1.5.0

func (s *ShopeeClient) GlobalProductGetCategory(req *GlobalProductGetCategoryRequest) (resp *GlobalProductGetCategory, err error)

func (*ShopeeClient) GlobalProductGetDtsLimit added in v1.5.0

func (s *ShopeeClient) GlobalProductGetDtsLimit(req *GlobalProductGetDtsLimitRequest) (resp *GlobalProductGetDtsLimit, err error)

func (*ShopeeClient) GlobalProductGetGlobalItemID added in v1.5.0

func (s *ShopeeClient) GlobalProductGetGlobalItemID(req *GlobalProductGetGlobalItemIDRequest) (resp *GlobalProductGetGlobalItemID, err error)

func (*ShopeeClient) GlobalProductGetGlobalItemInfo added in v1.5.0

func (s *ShopeeClient) GlobalProductGetGlobalItemInfo(req *GlobalProductGetGlobalItemInfoRequest) (resp *GlobalProductGetGlobalItemInfo, err error)

func (*ShopeeClient) GlobalProductGetGlobalItemLimit added in v1.5.0

func (s *ShopeeClient) GlobalProductGetGlobalItemLimit(req *GlobalProductGetGlobalItemLimitRequest) (resp *GlobalProductGetGlobalItemLimit, err error)

func (*ShopeeClient) GlobalProductGetGlobalItemList added in v1.5.0

func (s *ShopeeClient) GlobalProductGetGlobalItemList(req *GlobalProductGetGlobalItemListRequest) (resp *GlobalProductGetGlobalItemList, err error)

func (*ShopeeClient) GlobalProductGetGlobalModelList added in v1.5.0

func (s *ShopeeClient) GlobalProductGetGlobalModelList(req *GlobalProductGetGlobalModelListRequest) (resp *GlobalProductGetGlobalModelList, err error)

func (*ShopeeClient) GlobalProductGetPublishTaskResult added in v1.5.0

func (s *ShopeeClient) GlobalProductGetPublishTaskResult(req *GlobalProductGetPublishTaskResultRequest) (resp *GlobalProductGetPublishTaskResult, err error)

func (*ShopeeClient) GlobalProductGetPublishableShop added in v1.5.0

func (s *ShopeeClient) GlobalProductGetPublishableShop(req *GlobalProductGetPublishableShopRequest) (resp *GlobalProductGetPublishableShop, err error)

func (*ShopeeClient) GlobalProductGetPublishedList added in v1.5.0

func (s *ShopeeClient) GlobalProductGetPublishedList(req *GlobalProductGetPublishedListRequest) (resp *GlobalProductGetPublishedList, err error)

func (*ShopeeClient) GlobalProductGetRecommendAttribute added in v1.5.0

func (s *ShopeeClient) GlobalProductGetRecommendAttribute(req *GlobalProductGetRecommendAttributeRequest) (resp *GlobalProductGetRecommendAttribute, err error)

func (*ShopeeClient) GlobalProductInitTierVariation added in v1.5.0

func (s *ShopeeClient) GlobalProductInitTierVariation(req *GlobalProductInitTierVariationRequest) (err error)

func (*ShopeeClient) GlobalProductSetSyncField added in v1.5.0

func (s *ShopeeClient) GlobalProductSetSyncField(req *GlobalProductSetSyncFieldRequest) (err error)

func (*ShopeeClient) GlobalProductSupportSizeChart added in v1.5.0

func (s *ShopeeClient) GlobalProductSupportSizeChart(req *GlobalProductSupportSizeChartRequest) (resp *GlobalProductSupportSizeChart, err error)

func (*ShopeeClient) GlobalProductUpdateGlobalItem added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdateGlobalItem(req *GlobalProductUpdateGlobalItemRequest) (resp *GlobalProductUpdateGlobalItem, err error)

func (*ShopeeClient) GlobalProductUpdateGlobalModel added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdateGlobalModel(req *GlobalProductUpdateGlobalModelRequest) (err error)

func (*ShopeeClient) GlobalProductUpdatePrice added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdatePrice(req *GlobalProductUpdatePriceRequest) (err error)

func (*ShopeeClient) GlobalProductUpdateSizeChart added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdateSizeChart(req *GlobalProductUpdateSizeChartRequest) (err error)

func (*ShopeeClient) GlobalProductUpdateStock added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdateStock(req *GlobalProductUpdateStockRequest) (err error)

func (*ShopeeClient) GlobalProductUpdateTierVariation added in v1.5.0

func (s *ShopeeClient) GlobalProductUpdateTierVariation(req *GlobalProductUpdateTierVariationRequest) (err error)

func (*ShopeeClient) LogisticsBatchShipOrder added in v1.5.0

func (s *ShopeeClient) LogisticsBatchShipOrder(req *LogisticsBatchShipOrderRequest) (resp *LogisticsBatchShipOrder, err error)

func (*ShopeeClient) LogisticsCreateShippingDocument added in v1.5.0

func (s *ShopeeClient) LogisticsCreateShippingDocument(req *LogisticsCreateShippingDocumentRequest) (resp *LogisticsCreateShippingDocument, err error)

func (*ShopeeClient) LogisticsDeleteAddress added in v1.5.0

func (s *ShopeeClient) LogisticsDeleteAddress(req *LogisticsDeleteAddressRequest) (err error)

func (*ShopeeClient) LogisticsDownloadShippingDocument added in v1.5.0

func (s *ShopeeClient) LogisticsDownloadShippingDocument(saveFilePath string) func(req *LogisticsDownloadShippingDocumentRequest) (err error)

these function replace original function

func (*ShopeeClient) LogisticsGetAddressList added in v1.5.0

func (s *ShopeeClient) LogisticsGetAddressList(req *LogisticsGetAddressListRequest) (resp *LogisticsGetAddressList, err error)

func (*ShopeeClient) LogisticsGetChannelList added in v1.5.0

func (s *ShopeeClient) LogisticsGetChannelList(req *LogisticsGetChannelListRequest) (resp *LogisticsGetChannelList, err error)

func (*ShopeeClient) LogisticsGetShippingDocumentInfo added in v1.5.0

func (s *ShopeeClient) LogisticsGetShippingDocumentInfo(req *LogisticsGetShippingDocumentInfoRequest) (resp *LogisticsGetShippingDocumentInfo, err error)

func (*ShopeeClient) LogisticsGetShippingDocumentParameter added in v1.5.0

func (s *ShopeeClient) LogisticsGetShippingDocumentParameter(req *LogisticsGetShippingDocumentParameterRequest) (resp *LogisticsGetShippingDocumentParameter, err error)

func (*ShopeeClient) LogisticsGetShippingDocumentResult added in v1.5.0

func (s *ShopeeClient) LogisticsGetShippingDocumentResult(req *LogisticsGetShippingDocumentResultRequest) (resp *LogisticsGetShippingDocumentResult, err error)

func (*ShopeeClient) LogisticsGetShippingParameter added in v1.5.0

func (s *ShopeeClient) LogisticsGetShippingParameter(req *LogisticsGetShippingParameterRequest) (resp *LogisticsGetShippingParameter, err error)

func (*ShopeeClient) LogisticsGetTrackingInfo added in v1.5.0

func (s *ShopeeClient) LogisticsGetTrackingInfo(req *LogisticsGetTrackingInfoRequest) (resp *LogisticsGetTrackingInfo, err error)

func (*ShopeeClient) LogisticsGetTrackingNumber added in v1.5.0

func (s *ShopeeClient) LogisticsGetTrackingNumber(req *LogisticsGetTrackingNumberRequest) (resp *LogisticsGetTrackingNumber, err error)

func (*ShopeeClient) LogisticsSetAddressConfig added in v1.5.0

func (s *ShopeeClient) LogisticsSetAddressConfig(req *LogisticsSetAddressConfigRequest) (err error)

func (*ShopeeClient) LogisticsShipOrder added in v1.5.0

func (s *ShopeeClient) LogisticsShipOrder(req *LogisticsShipOrderRequest) (err error)

func (*ShopeeClient) LogisticsUpdateChannel added in v1.5.0

func (s *ShopeeClient) LogisticsUpdateChannel(req *LogisticsUpdateChannelRequest) (resp *LogisticsUpdateChannel, err error)

func (*ShopeeClient) LogisticsUpdateShippingOrder added in v1.5.0

func (s *ShopeeClient) LogisticsUpdateShippingOrder(req *LogisticsUpdateShippingOrderRequest) (err error)

func (*ShopeeClient) MediaSpaceCancelVideoUpload added in v1.5.0

func (s *ShopeeClient) MediaSpaceCancelVideoUpload(req *MediaSpaceCancelVideoUploadRequest) (err error)

func (*ShopeeClient) MediaSpaceCompleteVideoUpload added in v1.5.0

func (s *ShopeeClient) MediaSpaceCompleteVideoUpload(req *MediaSpaceCompleteVideoUploadRequest) (err error)

func (*ShopeeClient) MediaSpaceGetVideoUploadResult added in v1.5.0

func (s *ShopeeClient) MediaSpaceGetVideoUploadResult(req *MediaSpaceGetVideoUploadResultRequest) (resp *MediaSpaceGetVideoUploadResult, err error)

func (*ShopeeClient) MediaSpaceInitVideoUpload added in v1.5.0

func (s *ShopeeClient) MediaSpaceInitVideoUpload(req *MediaSpaceInitVideoUploadRequest) (resp *MediaSpaceInitVideoUpload, err error)

func (*ShopeeClient) MediaSpaceUploadImage added in v1.5.0

func (s *ShopeeClient) MediaSpaceUploadImage(req *MediaSpaceUploadImageRequest) (resp *MediaSpaceUploadImage, err error)

func (*ShopeeClient) MediaSpaceUploadVideoPart added in v1.5.0

func (s *ShopeeClient) MediaSpaceUploadVideoPart(req *MediaSpaceUploadVideoPartRequest) (err error)

func (*ShopeeClient) MerchantGetMerchantInfo added in v1.5.0

func (s *ShopeeClient) MerchantGetMerchantInfo(req *MerchantGetMerchantInfoRequest) (err error)

func (*ShopeeClient) MerchantGetShopListByMerchant added in v1.5.0

func (s *ShopeeClient) MerchantGetShopListByMerchant(req *MerchantGetShopListByMerchantRequest) (err error)

func (*ShopeeClient) OrderAddInvoiceData added in v1.5.0

func (s *ShopeeClient) OrderAddInvoiceData(req *OrderAddInvoiceDataRequest) (err error)

func (*ShopeeClient) OrderCancelOrder added in v1.5.0

func (s *ShopeeClient) OrderCancelOrder(req *OrderCancelOrderRequest) (resp *OrderCancelOrder, err error)

func (*ShopeeClient) OrderDownloadInvoiceDoc added in v1.5.0

func (s *ShopeeClient) OrderDownloadInvoiceDoc(req *OrderDownloadInvoiceDocRequest) (err error)

func (*ShopeeClient) OrderGetBuyerInvoiceInfo added in v1.5.0

func (s *ShopeeClient) OrderGetBuyerInvoiceInfo(req *OrderGetBuyerInvoiceInfoRequest) (err error)

func (*ShopeeClient) OrderGetOrderDetail added in v1.5.0

func (s *ShopeeClient) OrderGetOrderDetail(req *OrderGetOrderDetailRequest) (resp *OrderGetOrderDetail, err error)

func (*ShopeeClient) OrderGetOrderList added in v1.5.0

func (s *ShopeeClient) OrderGetOrderList(req *OrderGetOrderListRequest) (resp *OrderGetOrderList, err error)

func (*ShopeeClient) OrderGetPendingBuyerInvoiceOrderList added in v1.5.0

func (s *ShopeeClient) OrderGetPendingBuyerInvoiceOrderList(req *OrderGetPendingBuyerInvoiceOrderListRequest) (resp *OrderGetPendingBuyerInvoiceOrderList, err error)

func (*ShopeeClient) OrderGetShipmentList added in v1.5.0

func (s *ShopeeClient) OrderGetShipmentList(req *OrderGetShipmentListRequest) (resp *OrderGetShipmentList, err error)

func (*ShopeeClient) OrderHandleBuyerCancellation added in v1.5.0

func (s *ShopeeClient) OrderHandleBuyerCancellation(req *OrderHandleBuyerCancellationRequest) (resp *OrderHandleBuyerCancellation, err error)

func (*ShopeeClient) OrderSetNote added in v1.5.0

func (s *ShopeeClient) OrderSetNote(req *OrderSetNoteRequest) (err error)

func (*ShopeeClient) OrderSplitOrder added in v1.5.0

func (s *ShopeeClient) OrderSplitOrder(req *OrderSplitOrderRequest) (resp *OrderSplitOrder, err error)

func (*ShopeeClient) OrderUnsplitOrder added in v1.5.0

func (s *ShopeeClient) OrderUnsplitOrder(req *OrderUnsplitOrderRequest) (err error)

func (*ShopeeClient) OrderUploadInvoiceDoc added in v1.5.0

func (s *ShopeeClient) OrderUploadInvoiceDoc(req *OrderUploadInvoiceDocRequest) (err error)

func (*ShopeeClient) PaymentGetEscrowDetail added in v1.5.0

func (s *ShopeeClient) PaymentGetEscrowDetail(req *PaymentGetEscrowDetailRequest) (resp *PaymentGetEscrowDetail, err error)

func (*ShopeeClient) PaymentGetEscrowList added in v1.5.0

func (s *ShopeeClient) PaymentGetEscrowList(req *PaymentGetEscrowListRequest) (resp *PaymentGetEscrowList, err error)

func (*ShopeeClient) PaymentGetItemInstallmentStatus added in v1.5.0

func (s *ShopeeClient) PaymentGetItemInstallmentStatus(req *PaymentGetItemInstallmentStatusRequest) (resp *PaymentGetItemInstallmentStatus, err error)

func (*ShopeeClient) PaymentGetPaymentMethodList added in v1.5.0

func (s *ShopeeClient) PaymentGetPaymentMethodList(req *PaymentGetPaymentMethodListRequest) (resp []PaymentGetPaymentMethodList, err error)

func (*ShopeeClient) PaymentGetPayoutDetail added in v1.5.0

func (s *ShopeeClient) PaymentGetPayoutDetail(req *PaymentGetPayoutDetailRequest) (resp *PaymentGetPayoutDetail, err error)

func (*ShopeeClient) PaymentGetShopInstallmentStatus added in v1.5.0

func (s *ShopeeClient) PaymentGetShopInstallmentStatus(req *PaymentGetShopInstallmentStatusRequest) (resp *PaymentGetShopInstallmentStatus, err error)

func (*ShopeeClient) PaymentGetWalletTransactionList added in v1.5.0

func (s *ShopeeClient) PaymentGetWalletTransactionList(req *PaymentGetWalletTransactionListRequest) (resp *PaymentGetWalletTransactionList, err error)

func (*ShopeeClient) PaymentSetItemInstallmentStatus added in v1.5.0

func (s *ShopeeClient) PaymentSetItemInstallmentStatus(req *PaymentSetItemInstallmentStatusRequest) (resp *PaymentSetItemInstallmentStatus, err error)

func (*ShopeeClient) PaymentSetShopInstallmentStatus added in v1.5.0

func (s *ShopeeClient) PaymentSetShopInstallmentStatus(req *PaymentSetShopInstallmentStatusRequest) (resp *PaymentSetShopInstallmentStatus, err error)

func (*ShopeeClient) Performance

func (s *ShopeeClient) Performance(req *PerformanceRequest) (resp *PerformanceResponse, err error)

Performance Shop performance includes the indexes from "My Performance" of Seller Center.

func (*ShopeeClient) ProductAddItem added in v1.5.0

func (s *ShopeeClient) ProductAddItem(req *ProductAddItemRequest) (resp *ProductAddItem, err error)

func (*ShopeeClient) ProductAddModel added in v1.5.0

func (s *ShopeeClient) ProductAddModel(req *ProductAddModelRequest) (resp *ProductAddModel, err error)

func (*ShopeeClient) ProductBoostItem added in v1.5.0

func (s *ShopeeClient) ProductBoostItem(req *ProductBoostItemRequest) (resp *ProductBoostItem, err error)

func (*ShopeeClient) ProductCategoryRecommend added in v1.5.0

func (s *ShopeeClient) ProductCategoryRecommend(req *ProductCategoryRecommendRequest) (resp *ProductCategoryRecommend, err error)

func (*ShopeeClient) ProductDeleteItem added in v1.5.0

func (s *ShopeeClient) ProductDeleteItem(req *ProductDeleteItemRequest) (err error)

func (*ShopeeClient) ProductDeleteModel added in v1.5.0

func (s *ShopeeClient) ProductDeleteModel(req *ProductDeleteModelRequest) (err error)

func (*ShopeeClient) ProductGetAttributes added in v1.5.0

func (s *ShopeeClient) ProductGetAttributes(req *ProductGetAttributesRequest) (resp *ProductGetAttributes, err error)

func (*ShopeeClient) ProductGetBoostedList added in v1.5.0

func (s *ShopeeClient) ProductGetBoostedList(req *ProductGetBoostedListRequest) (resp *ProductGetBoostedList, err error)

func (*ShopeeClient) ProductGetBrandList added in v1.5.0

func (s *ShopeeClient) ProductGetBrandList(req *ProductGetBrandListRequest) (resp *ProductGetBrandList, err error)

func (*ShopeeClient) ProductGetCategory added in v1.5.0

func (s *ShopeeClient) ProductGetCategory(req *ProductGetCategoryRequest) (resp *ProductGetCategory, err error)

func (*ShopeeClient) ProductGetComment added in v1.5.0

func (s *ShopeeClient) ProductGetComment(req *ProductGetCommentRequest) (resp *ProductGetComment, err error)

func (*ShopeeClient) ProductGetDtsLimit added in v1.5.0

func (s *ShopeeClient) ProductGetDtsLimit(req *ProductGetDtsLimitRequest) (resp *ProductGetDtsLimit, err error)

func (*ShopeeClient) ProductGetItemBaseInfo added in v1.5.0

func (s *ShopeeClient) ProductGetItemBaseInfo(req *ProductGetItemBaseInfoRequest) (resp *ProductGetItemBaseInfo, err error)

func (*ShopeeClient) ProductGetItemExtraInfo added in v1.5.0

func (s *ShopeeClient) ProductGetItemExtraInfo(req *ProductGetItemExtraInfoRequest) (resp *ProductGetItemExtraInfo, err error)

func (*ShopeeClient) ProductGetItemLimit added in v1.5.0

func (s *ShopeeClient) ProductGetItemLimit(req *ProductGetItemLimitRequest) (resp *ProductGetItemLimit, err error)

func (*ShopeeClient) ProductGetItemList added in v1.5.0

func (s *ShopeeClient) ProductGetItemList(req *ProductGetItemListRequest) (resp *ProductGetItemList, err error)

func (*ShopeeClient) ProductGetItemPromotion added in v1.5.0

func (s *ShopeeClient) ProductGetItemPromotion(req *ProductGetItemPromotionRequest) (resp *ProductGetItemPromotion, err error)

func (*ShopeeClient) ProductGetModelList added in v1.5.0

func (s *ShopeeClient) ProductGetModelList(req *ProductGetModelListRequest) (resp *ProductGetModelList, err error)

func (*ShopeeClient) ProductGetRecommendAttribute added in v1.5.0

func (s *ShopeeClient) ProductGetRecommendAttribute(req *ProductGetRecommendAttributeRequest) (resp *ProductGetRecommendAttribute, err error)

func (*ShopeeClient) ProductInitTierVariation added in v1.5.0

func (s *ShopeeClient) ProductInitTierVariation(req *ProductInitTierVariationRequest) (resp *ProductInitTierVariation, err error)

func (*ShopeeClient) ProductRegisterBrand added in v1.5.0

func (s *ShopeeClient) ProductRegisterBrand(req *ProductRegisterBrandRequest) (resp *ProductRegisterBrand, err error)

func (*ShopeeClient) ProductReplyComment added in v1.5.0

func (s *ShopeeClient) ProductReplyComment(req *ProductReplyCommentRequest) (resp *ProductReplyComment, err error)

func (*ShopeeClient) ProductSearchItem added in v1.5.0

func (s *ShopeeClient) ProductSearchItem(req *ProductSearchItemRequest) (resp *ProductSearchItem, err error)

func (*ShopeeClient) ProductSupportSizeChart added in v1.5.0

func (s *ShopeeClient) ProductSupportSizeChart(req *ProductSupportSizeChartRequest) (resp *ProductSupportSizeChart, err error)

func (*ShopeeClient) ProductUnlistItem added in v1.5.0

func (s *ShopeeClient) ProductUnlistItem(req *ProductUnlistItemRequest) (resp *ProductUnlistItem, err error)

func (*ShopeeClient) ProductUpdateItem added in v1.5.0

func (s *ShopeeClient) ProductUpdateItem(req *ProductUpdateItemRequest) (resp *ProductUpdateItem, err error)

func (*ShopeeClient) ProductUpdateModel added in v1.5.0

func (s *ShopeeClient) ProductUpdateModel(req *ProductUpdateModelRequest) (err error)

func (*ShopeeClient) ProductUpdatePrice added in v1.5.0

func (s *ShopeeClient) ProductUpdatePrice(req *ProductUpdatePriceRequest) (resp *ProductUpdatePrice, err error)

func (*ShopeeClient) ProductUpdateSipItemPrice added in v1.5.0

func (s *ShopeeClient) ProductUpdateSipItemPrice(req *ProductUpdateSipItemPriceRequest) (err error)

func (*ShopeeClient) ProductUpdateSizeChart added in v1.5.0

func (s *ShopeeClient) ProductUpdateSizeChart(req *ProductUpdateSizeChartRequest) (err error)

func (*ShopeeClient) ProductUpdateStock added in v1.5.0

func (s *ShopeeClient) ProductUpdateStock(req *ProductUpdateStockRequest) (resp *ProductUpdateStock, err error)

func (*ShopeeClient) ProductUpdateTierVariation added in v1.5.0

func (s *ShopeeClient) ProductUpdateTierVariation(req *ProductUpdateTierVariationRequest) (err error)

func (*ShopeeClient) PublicGetMerchantsByPartner added in v1.5.0

func (s *ShopeeClient) PublicGetMerchantsByPartner(req *PublicGetMerchantsByPartnerRequest) (err error)

func (*ShopeeClient) PublicGetRefreshTokenByUpgradeCode added in v1.5.0

func (s *ShopeeClient) PublicGetRefreshTokenByUpgradeCode(req *PublicGetRefreshTokenByUpgradeCodeRequest) (resp *PublicGetRefreshTokenByUpgradeCode, err error)

func (*ShopeeClient) PublicGetShopsByPartner added in v1.5.0

func (s *ShopeeClient) PublicGetShopsByPartner(req *PublicGetShopsByPartnerRequest) (err error)

func (*ShopeeClient) PublicGetTokenByResendCode added in v1.5.0

func (s *ShopeeClient) PublicGetTokenByResendCode(req *PublicGetTokenByResendCodeRequest) (err error)

func (*ShopeeClient) PushGetPushConfig added in v1.5.0

func (s *ShopeeClient) PushGetPushConfig(req *PushGetPushConfigRequest) (err error)

func (*ShopeeClient) PushSetPushConfig added in v1.5.0

func (s *ShopeeClient) PushSetPushConfig(req *PushSetPushConfigRequest) (err error)

func (*ShopeeClient) RefreshAccessToken

func (s *ShopeeClient) RefreshAccessToken(req *RefreshAccessTokenRequest) (resp *RefreshAccessTokenResponse, err error)

RefreshAccessToken Use this API to refresh the access_token after it expires.

func (*ShopeeClient) ReturnsAcceptOffer added in v1.5.0

func (s *ShopeeClient) ReturnsAcceptOffer(req *ReturnsAcceptOfferRequest) (resp *ReturnsAcceptOffer, err error)

func (*ShopeeClient) ReturnsConfirm added in v1.5.0

func (s *ShopeeClient) ReturnsConfirm(req *ReturnsConfirmRequest) (resp *ReturnsConfirm, err error)

func (*ShopeeClient) ReturnsDispute added in v1.5.0

func (s *ShopeeClient) ReturnsDispute(req *ReturnsDisputeRequest) (resp *ReturnsDispute, err error)

func (*ShopeeClient) ReturnsGetAvailableSolutions added in v1.5.0

func (s *ShopeeClient) ReturnsGetAvailableSolutions(req *ReturnsGetAvailableSolutionsRequest) (resp *ReturnsGetAvailableSolutions, err error)

func (*ShopeeClient) ReturnsGetReturnDetail added in v1.5.0

func (s *ShopeeClient) ReturnsGetReturnDetail(req *ReturnsGetReturnDetailRequest) (resp *ReturnsGetReturnDetail, err error)

func (*ShopeeClient) ReturnsGetReturnList added in v1.5.0

func (s *ShopeeClient) ReturnsGetReturnList(req *ReturnsGetReturnListRequest) (resp []ReturnsGetReturnList, err error)

func (*ShopeeClient) ReturnsOffer added in v1.5.0

func (s *ShopeeClient) ReturnsOffer(req *ReturnsOfferRequest) (resp *ReturnsOffer, err error)

func (*ShopeeClient) SetAccessToken

func (s *ShopeeClient) SetAccessToken(t string) *ShopeeClient

func (*ShopeeClient) SetShopInstallmentStatus

func (s *ShopeeClient) SetShopInstallmentStatus(req *SetShopInstallmentStatusRequest) (resp *SetShopInstallmentStatusResponse, err error)

SetShopInstallmentStatus Only for TW whitelisted shop.Use this API to set the installment status of shop.

func (*ShopeeClient) ShopCategoryAddItemList added in v1.5.0

func (s *ShopeeClient) ShopCategoryAddItemList(req *ShopCategoryAddItemListRequest) (resp *ShopCategoryAddItemList, err error)

func (*ShopeeClient) ShopCategoryAddShopCategory added in v1.5.0

func (s *ShopeeClient) ShopCategoryAddShopCategory(req *ShopCategoryAddShopCategoryRequest) (resp *ShopCategoryAddShopCategory, err error)

func (*ShopeeClient) ShopCategoryDeleteItemList added in v1.5.0

func (s *ShopeeClient) ShopCategoryDeleteItemList(req *ShopCategoryDeleteItemListRequest) (resp *ShopCategoryDeleteItemList, err error)

func (*ShopeeClient) ShopCategoryDeleteShopCategory added in v1.5.0

func (s *ShopeeClient) ShopCategoryDeleteShopCategory(req *ShopCategoryDeleteShopCategoryRequest) (resp *ShopCategoryDeleteShopCategory, err error)

func (*ShopeeClient) ShopCategoryGetItemList added in v1.5.0

func (s *ShopeeClient) ShopCategoryGetItemList(req *ShopCategoryGetItemListRequest) (resp *ShopCategoryGetItemList, err error)

func (*ShopeeClient) ShopCategoryGetShopCategoryList added in v1.5.0

func (s *ShopeeClient) ShopCategoryGetShopCategoryList(req *ShopCategoryGetShopCategoryListRequest) (resp *ShopCategoryGetShopCategoryList, err error)

func (*ShopeeClient) ShopCategoryUpdateShopCategory added in v1.5.0

func (s *ShopeeClient) ShopCategoryUpdateShopCategory(req *ShopCategoryUpdateShopCategoryRequest) (resp *ShopCategoryUpdateShopCategory, err error)

func (*ShopeeClient) ShopGetProfile added in v1.5.0

func (s *ShopeeClient) ShopGetProfile(req *ShopGetProfileRequest) (resp *ShopGetProfile, err error)

func (*ShopeeClient) ShopGetShopInfo added in v1.5.0

func (s *ShopeeClient) ShopGetShopInfo(req *ShopGetShopInfoRequest) (err error)

func (*ShopeeClient) ShopGetWarehouseDetail added in v1.5.0

func (s *ShopeeClient) ShopGetWarehouseDetail(req *ShopGetWarehouseDetailRequest) (resp []ShopGetWarehouseDetail, err error)

func (*ShopeeClient) ShopUpdateProfile added in v1.5.0

func (s *ShopeeClient) ShopUpdateProfile(req *ShopUpdateProfileRequest) (resp *ShopUpdateProfile, err error)

func (*ShopeeClient) TopPicksAddTopPicks added in v1.5.0

func (s *ShopeeClient) TopPicksAddTopPicks(req *TopPicksAddTopPicksRequest) (resp *TopPicksAddTopPicks, err error)

func (*ShopeeClient) TopPicksDeleteTopPicks added in v1.5.0

func (s *ShopeeClient) TopPicksDeleteTopPicks(req *TopPicksDeleteTopPicksRequest) (resp *TopPicksDeleteTopPicks, err error)

func (*ShopeeClient) TopPicksGetTopPicksList added in v1.5.0

func (s *ShopeeClient) TopPicksGetTopPicksList(req *TopPicksGetTopPicksListRequest) (resp *TopPicksGetTopPicksList, err error)

func (*ShopeeClient) TopPicksUpdateTopPicks added in v1.5.0

func (s *ShopeeClient) TopPicksUpdateTopPicks(req *TopPicksUpdateTopPicksRequest) (resp *TopPicksUpdateTopPicks, err error)

func (*ShopeeClient) UpdateShopInfo

func (s *ShopeeClient) UpdateShopInfo(req *UpdateShopInfoRequest) (resp *UpdateShopInfoResponse, err error)

UpdateShopInfo Use this call to update information of shop

func (*ShopeeClient) VoucherAddVoucher added in v1.5.0

func (s *ShopeeClient) VoucherAddVoucher(req *VoucherAddVoucherRequest) (resp *VoucherAddVoucher, err error)

func (*ShopeeClient) VoucherDeleteVoucher added in v1.5.0

func (s *ShopeeClient) VoucherDeleteVoucher(req *VoucherDeleteVoucherRequest) (resp *VoucherDeleteVoucher, err error)

func (*ShopeeClient) VoucherEndVoucher added in v1.5.0

func (s *ShopeeClient) VoucherEndVoucher(req *VoucherEndVoucherRequest) (resp *VoucherEndVoucher, err error)

func (*ShopeeClient) VoucherGetVoucher added in v1.5.0

func (s *ShopeeClient) VoucherGetVoucher(req *VoucherGetVoucherRequest) (resp *VoucherGetVoucher, err error)

func (*ShopeeClient) VoucherGetVoucherList added in v1.5.0

func (s *ShopeeClient) VoucherGetVoucherList(req *VoucherGetVoucherListRequest) (resp *VoucherGetVoucherList, err error)

func (*ShopeeClient) VoucherUpdateVoucher added in v1.5.0

func (s *ShopeeClient) VoucherUpdateVoucher(req *VoucherUpdateVoucherRequest) (resp *VoucherUpdateVoucher, err error)

type SipItemPrice added in v1.5.1

type SipItemPrice struct {
	// model_id is 0 for no model item.
	ModelID int `json:"model_id,omitempty"`
	// sip_item_price is SIP item price.
	SipItemPrice float64 `json:"sip_item_price,omitempty,string"`
}

======================================================= Object Raw Type - SipItemPrice =======================================================

type SplitOrderRequestParcel

type SplitOrderRequestParcel struct {
	// Itemids that will be put into a fullfillment order.
	ItemID int64 `json:"item_id,omitempty"`
	// Variation_id that will be put into a fulfillment order, if no variation please input variation_id:0.
	VariationID int64 `json:"variation_id"`
}

type SplitOrderResponseForder

type SplitOrderResponseForder struct {
	// Shopee's unique identifier for a fulfillment order.
	ForderID string `json:"forder_id,omitempty"`
	// Item information contained in fulfillment orders.Number of items must be greater than or equal to 2. eg.[[{"item_id": 123}],[{"item_id": 456}]]
	Items []SplitOrderResponseForderItem `json:"items,omitempty"`
}

type SplitOrderResponseForderItem

type SplitOrderResponseForderItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
}

type StockList added in v1.5.1

type StockList struct {
	// model_id is 0 for no model item.
	ModelID int `json:"model_id,omitempty"`
	// normal_stock is <p>Normal stock.</p><p><b><font color="#c24f4a">Please use the seller_stock field instead, we will deprecate this field in the future.</font></b><br /></p>
	NormalStock int `json:"normal_stock,omitempty"`
	// seller_stock is <p>new stock info(Please notice that stock(including Seller Stock and Shopee Stock) should be larger than or equal to real-time reserved stock)<br /></p>
	SellerStock []StockListSellerStock `json:"seller_stock,omitempty"`
}

======================================================= Object Raw Type - StockList =======================================================

type StockListSellerStock added in v1.5.4

type StockListSellerStock struct {
	// location_id is <p>location id, you can get the location id from v2.shop.get_warehouse_detail api, if seller don't have any warehouse, you don't need to upload this field.<br /></p>
	LocationID string `json:"location_id,omitempty"`
	// stock is <p>stock</p>
	Stock int `json:"stock,omitempty"`
}

======================================================= Object Raw Type - StockListSellerStock =======================================================

type SubItemList added in v1.5.1

type SubItemList struct {
	// item_id is Shopee's unique identifier for an item.
	ItemID int `json:"item_id,omitempty"`
	// model_id is Shopee's unique identifier for a model.
	ModelID int `json:"model_id,omitempty"`
	// status is The status of add on deal item:enable = 1;disable =2
	Status int `json:"status,omitempty"`
	// sub_item_input_price is Add-on discount price before tax
	SubItemInputPrice float64 `json:"sub_item_input_price,omitempty,string"`
	// sub_item_limit is The purchase limit of sub item.
	SubItemLimit int `json:"sub_item_limit,omitempty"`
}

======================================================= Object Raw Type - SubItemList =======================================================

type TaxInfo added in v1.5.0

type TaxInfo struct {
	// ncm is Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region)
	Ncm string `json:"ncm,omitempty"`
	// same_state_cfop is Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at the time of issuing the invoice.(BR region)
	SameStateCfop string `json:"same_state_cfop,omitempty"`
	// diff_state_cfop is Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice.(BR region)
	DiffStateCfop string `json:"diff_state_cfop,omitempty"`
	// csosn is Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations.(BR region)
	CsoSN string `json:"csosn,omitempty"`
	// origin is Product source, domestic or foreig (BR region)
	Origin string `json:"origin,omitempty"`
	// cest is (BR region)
	Cest string `json:"cest,omitempty"`
	// measure_unit is (BR region)
	MeasureUnit string `json:"measure_unit,omitempty"`
	// invoice_option is Value shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region)
	InvoiceOption string `json:"invoice_option,omitempty"`
	// vat_rate is Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)
	VatRate string `json:"vat_rate,omitempty"`
	// hs_code is HS Code (Only for IN region)
	HsCode string `json:"hs_code,omitempty"`
	// tax_code is Tax Code (Only for IN region)
	TaxCode string `json:"tax_code,omitempty"`
}

======================================================= Object Raw Type - TaxInfo =======================================================

type TierVariation added in v1.5.1

type TierVariation struct {
	// name is Tier variation name
	Name string `json:"name,omitempty"`
	// option_list is Tier variation option info list
	OptionList []TierVariationOption `json:"option_list"`
}

======================================================= Object Raw Type - TierVariation =======================================================

type TierVariationOption added in v1.5.5

type TierVariationOption struct {
	// option is Option name
	Option string `json:"option,omitempty"`
	// image is Option image
	Image TierVariationOptionImage `json:"image,omitempty"`
}

======================================================= Object Raw Type - TierVariationOption =======================================================

type TierVariationOptionImage added in v1.5.5

type TierVariationOptionImage struct {
	// image_id is ID of image. You can choose to define or not define the option image. If you choose to define, you can only define an image for the first tier, and you need to define an image for all options of the first tier
	ImageID string `json:"image_id,omitempty"`
}

======================================================= Object Raw Type - TierVariationOptionImage =======================================================

type TopPicksAddTopPicks added in v1.5.1

type TopPicksAddTopPicks struct {
	// collection_list is The top picks list in this shop.
	CollectionList []TopPicksAddTopPicksCollection `json:"collection_list"`
}

======================================================= Object Raw Type - TopPicksAddTopPicks =======================================================

type TopPicksAddTopPicksCollection added in v1.5.5

type TopPicksAddTopPicksCollection struct {
	// is_activated is whether collection is activated.
	IsActivated bool `json:"is_activated,omitempty"`
	// item_list is The items of top picks
	ItemList []TopPicksAddTopPicksCollectionItem `json:"item_list"`
	// top_picks_id is Collection id.
	TopPicksID int `json:"top_picks_id,omitempty"`
	// name is The title of top picks.
	Name string `json:"name,omitempty"`
}

======================================================= Object Raw Type - TopPicksAddTopPicksCollection =======================================================

type TopPicksAddTopPicksCollectionItem added in v1.5.5

type TopPicksAddTopPicksCollectionItem struct {
	// item_name is The name of item.
	ItemName string `json:"item_name,omitempty"`
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// current_price is The price before tax of item.
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// inflated_price_of_current_price is The price after tax of item.
	InflatedPriceOfCurrentPrice float64 `json:"inflated_price_of_current_price,omitempty,string"`
	// sales is The sales of item.
	Sales int `json:"sales,omitempty"`
}

======================================================= Object Raw Type - TopPicksAddTopPicksCollectionItem =======================================================

type TopPicksAddTopPicksRequest added in v1.5.0

type TopPicksAddTopPicksRequest struct {
	V2RequestAuthenticationParams

	// name is
	Name string `json:"name"`
	// item_id_list is
	ItemIdList []int `json:"item_id_list"`
	// is_activated is
	IsActivated bool `json:"is_activated"`
}

======================================================= TopPicksAddTopPicksRequest =======================================================

type TopPicksAddTopPicksResponse added in v1.5.0

type TopPicksAddTopPicksResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response TopPicksAddTopPicks `json:"response"`
}

======================================================= TopPicksAddTopPicksResponse =======================================================

type TopPicksDeleteTopPicks added in v1.5.1

type TopPicksDeleteTopPicks struct {
	// top_picks_id is collection id
	TopPicksID int `json:"top_picks_id,omitempty"`
}

======================================================= Object Raw Type - TopPicksDeleteTopPicks =======================================================

type TopPicksDeleteTopPicksRequest added in v1.5.0

type TopPicksDeleteTopPicksRequest struct {
	V2RequestAuthenticationParams

	// top_picks_id is collection id
	TopPicksID int `json:"top_picks_id"`
}

======================================================= TopPicksDeleteTopPicksRequest =======================================================

type TopPicksDeleteTopPicksResponse added in v1.5.0

type TopPicksDeleteTopPicksResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response TopPicksDeleteTopPicks `json:"response"`
}

======================================================= TopPicksDeleteTopPicksResponse =======================================================

type TopPicksGetTopPicksList added in v1.5.1

type TopPicksGetTopPicksList struct {
	// collection_list is The top picks list in this shop.
	CollectionList []TopPicksGetTopPicksListCollection `json:"collection_list"`
}

======================================================= Object Raw Type - TopPicksGetTopPicksList =======================================================

type TopPicksGetTopPicksListCollection added in v1.5.5

type TopPicksGetTopPicksListCollection struct {
	// is_activated is whether collection is activated.
	IsActivated bool `json:"is_activated,omitempty"`
	// item_list is The items of top picks
	ItemList []TopPicksGetTopPicksListCollectionItem `json:"item_list"`
	// top_picks_id is collection id.
	TopPicksID int `json:"top_picks_id,omitempty"`
	// name is The title of  top picks.
	Name string `json:"name,omitempty"`
}

======================================================= Object Raw Type - TopPicksGetTopPicksListCollection =======================================================

type TopPicksGetTopPicksListCollectionItem added in v1.5.5

type TopPicksGetTopPicksListCollectionItem struct {
	// item_name is The name of item.
	ItemName string `json:"item_name,omitempty"`
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// current_price is The price before tax of item.
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// inflated_price_of_current_price is The price after tax of item.
	InflatedPriceOfCurrentPrice float64 `json:"inflated_price_of_current_price,omitempty,string"`
	// sales is The sales of  item.
	Sales int `json:"sales,omitempty"`
}

======================================================= Object Raw Type - TopPicksGetTopPicksListCollectionItem =======================================================

type TopPicksGetTopPicksListRequest added in v1.5.0

type TopPicksGetTopPicksListRequest struct {
	V2RequestAuthenticationParams
}

======================================================= TopPicksGetTopPicksListRequest =======================================================

type TopPicksGetTopPicksListResponse added in v1.5.0

type TopPicksGetTopPicksListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response TopPicksGetTopPicksList `json:"response"`
}

======================================================= TopPicksGetTopPicksListResponse =======================================================

type TopPicksUpdateTopPicks added in v1.5.1

type TopPicksUpdateTopPicks struct {
	// collection_list is The top picks list in this shop.
	CollectionList []TopPicksUpdateTopPicksCollection `json:"collection_list"`
}

======================================================= Object Raw Type - TopPicksUpdateTopPicks =======================================================

type TopPicksUpdateTopPicksCollection added in v1.5.5

type TopPicksUpdateTopPicksCollection struct {
	// is_activated is whether is activated
	IsActivated bool `json:"is_activated,omitempty"`
	// item_list is a list of item
	ItemList []TopPicksUpdateTopPicksCollectionItem `json:"item_list"`
	// top_picks_id is collection id
	TopPicksID int `json:"top_picks_id,omitempty"`
	// name is collection name
	Name string `json:"name,omitempty"`
}

======================================================= Object Raw Type - TopPicksUpdateTopPicksCollection =======================================================

type TopPicksUpdateTopPicksCollectionItem added in v1.5.5

type TopPicksUpdateTopPicksCollectionItem struct {
	// item_name is The name of item.
	ItemName string `json:"item_name,omitempty"`
	// item_id is The id of item.
	ItemID int `json:"item_id,omitempty"`
	// current_price is The price before tax of item.
	CurrentPrice float64 `json:"current_price,omitempty,string"`
	// inflated_price_of_current_price is The price after tax of item.
	InflatedPriceOfCurrentPrice float64 `json:"inflated_price_of_current_price,omitempty,string"`
	// sales is The sales of item.
	Sales int `json:"sales,omitempty"`
}

======================================================= Object Raw Type - TopPicksUpdateTopPicksCollectionItem =======================================================

type TopPicksUpdateTopPicksRequest added in v1.5.0

type TopPicksUpdateTopPicksRequest struct {
	V2RequestAuthenticationParams

	// top_picks_id is collection id
	TopPicksID int `json:"top_picks_id"`
	// name is collection name
	Name string `json:"name,omitempty"`
	// item_id_list is a list of item id, and we will cover old item_ids by new_item_ids
	ItemIdList []int `json:"item_id_list,omitempty"`
	// is_activated is if true, we will close other collection and open this collection
	IsActivated bool `json:"is_activated,omitempty"`
}

======================================================= TopPicksUpdateTopPicksRequest =======================================================

type TopPicksUpdateTopPicksResponse added in v1.5.0

type TopPicksUpdateTopPicksResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response TopPicksUpdateTopPicks `json:"response,omitempty"`
}

======================================================= TopPicksUpdateTopPicksResponse =======================================================

type UnlistItemRequestItem

type UnlistItemRequestItem struct {
	// Item's unique identifier.
	ItemID int64 `json:"item_id,omitempty"`
	// True: unlist this item; False: list this item.
	Unlist bool `json:"unlist,omitempty"`
}

type UnlistItemResponseFailed

type UnlistItemResponseFailed struct {
	// Item's unique identifier.
	ItemID int64 `json:"item_id,omitempty"`
	// Error message.
	ErrorDesciption string `json:"error_desciption,omitempty"`
}

type UnlistItemResponseSuccess

type UnlistItemResponseSuccess struct {
	// Item's unique identifier.
	ItemID int64 `json:"item_id,omitempty"`
	// True: item is unlisted; False: item is listed.
	Unlist bool `json:"unlist,omitempty"`
}

type UpdateDiscountItemsRequestItem

type UpdateDiscountItemsRequestItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// The max number of this product in the promotion price.
	PurchaseLimit int `json:"purchase_limit,omitempty"`
	// The discount price of the item.
	ItemOriginalPrice float64 `json:"item_original_price,omitempty,string"`
	//
	Variations []UpdateDiscountItemsRequestItemVariation `json:"variations,omitempty"`
}

type UpdateDiscountItemsRequestItemVariation

type UpdateDiscountItemsRequestItemVariation struct {
	// Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0.
	VariationID int64 `json:"variation_id,omitempty"`
	// The discount price of the item.
	VariationPromotionPrice float64 `json:"variation_promotion_price,omitempty,string"`
}

type UpdateItemRequestAttribute

type UpdateItemRequestAttribute struct {
	// related to shopee.item.GetAttributes result.attributes.attribute_id
	AttributesID int64 `json:"attributtes_id,omitempty"`
	// related to shopee.item.GetAttributes one of result.attributes.options
	Value string `json:"value,omitempty"`
}

type UpdateItemRequestLogistic

type UpdateItemRequestLogistic struct {
	// related to shopee.logistics.GetLogistics result.logistics.logistic_id
	LogisticID int64 `json:"logistic_id,omitempty"`
	// related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item
	Enabled bool `json:"enabled,omitempty"`
	// Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// If specify logistic fee_type is SIZE_SELECTION size_id is required
	SizeID int64 `json:"size_id,omitempty"`
	// when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
}

type UpdateItemRequestVariation

type UpdateItemRequestVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
}

type UpdateItemRequestWholesale

type UpdateItemRequestWholesale struct {
	// The min count of this tier wholesale. If the wholesale is not the first one, the min count must equal to max count of last tier plus one.
	Min int `json:"min,omitempty"`
	// The max count of this tier wholesale.
	Max int `json:"max,omitempty"`
	// The current price of the wholesale in the listing currency. The price must be cheaper than original price. And if the wholesale is not the first one, the price must be cheaper than previous tier.'
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

type UpdateItemResponseItem

type UpdateItemResponseItem struct {
	// Shopee's unique identifier for a shop.
	ShopID int64 `json:"shopid,omitempty"`
	// An item SKU (stock keeping unit) is an identifier defined by a seller, sometimes called parent SKU. Item SKU can be assigned to an item in Shopee Listings.
	ItemSKU string `json:"item_sku,omitempty"`
	// Enumerated type that defines the current status of the item. Applicable values: NORMAL, DELETED and BANNED.
	Status string `json:"status,omitempty"`
	// Name of the item in local language.
	Name string `json:"name,omitempty"`
	// Description of the item in local language.
	Description string `json:"description,omitempty"`
	// Image URLs of the item. It contains at most 9 URLs.
	Images []string `json:"images,omitempty"`
	// The three-digit code representing the currency unit used for the item in Shopee Listings.
	Currency string `json:"currency,omitempty"`
	// This is to indicate whether the item has variation(s).
	HasVariation bool `json:"has_variation,omitempty"`
	// The current price of the item in the listing currency. If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the item.
	Stock int `json:"stock,omitempty"`
	// Timestamp that indicates the date and time that the item was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the item, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// the net weight of this item, the unit is KG.
	Weight float64 `json:"weight,omitempty,string"`
	// Could call shopee.item.GetCategories to get category detail.Related to result.categories.category_id
	CategoryID int64 `json:"category_id,omitempty"`
	// The original price of the item in the listing currency.
	OriginalPrice float64 `json:"original_price,omitempty,string"`
	// The variation list of item
	Variations []UpdateItemResponseItemVariation `json:"variations,omitempty"`
	//
	Attritube []UpdateItemResponseItemAttribute `json:"attritube,omitempty"`
	// The logistics list.
	Logistics []UpdateItemResponseItemLogistic `json:"logistics,omitempty"`
	// The wholesales tier list.
	Wholesales []UpdateItemResponseItemWholesale `json:"wholesales,omitempty"`
	// The rating star scores of this item.
	RatingStar float64 `json:"rating_star,omitempty,string"`
	// Count of comments for the item.
	CMTCount int `json:"cmt_count,omitempty"`
	// The sales volume of item.
	Sales int `json:"sales,omitempty"`
	// The page view of item.
	Views int `json:"views,omitempty"`
	// The conllection number of item.
	Likes int `json:"likes,omitempty"`
	// The length of package for this single item, the unit is CM
	PackageLength int `json:"package_length,omitempty"`
	// The width of package for this single item, the unit is CM
	PackageWidth int `json:"package_width,omitempty"`
	// The height of package for this single item, the unit is CM
	PackageHeight int `json:"package_height,omitempty"`
	// The guaranteed days to ship orders. Update value to less than 7 will default the value to the respective standard per your shop location and make this item non pre-order.(e.g. 3 for CrossBorder)
	DaysToShip int `json:"days_to_ship,omitempty"`
	// This indicates whether the item is secondhand.
	Condition string `json:"condition,omitempty"`
	// The ID of discount activity the item is currently in. One item can only have one discount at a time. discount_id will be 0 if the item has no discount applied, or item has variation.
	DiscountID int64 `json:"discount_id,omitempty"`
	// Use this field to identify whether the item is pre-order. Applicable value: true/false.
	IsPreOrder bool `json:"is_pre_order,omitempty"`
}

type UpdateItemResponseItemAttribute

type UpdateItemResponseItemAttribute struct {
	// The Identify of each category
	AttributeID int64 `json:"attribute_id,omitempty"`
	// The name of each attribute
	AttributeName string `json:"attribute_name,omitempty"`
	// This is to indicate whether this attribute is mandantory
	IsMandatory bool `json:"is_mandatory,omitempty"`
	// Enumerated type that defines the type of the attribute. Applicable values: See Data Definition- AttributeType.
	AttributeType string `json:"attribute_type,omitempty"`
	// The value of this item attribute.
	AttribueValue string `json:"attribue_value,omitempty"`
}

type UpdateItemResponseItemLogistic

type UpdateItemResponseItemLogistic struct {
	// The identity of logistic channel
	LogisticID int64 `json:"logistic_id,omitempty"`
	// The name of logistic
	LogisticName string `json:"logistic_name,omitempty"`
	// related to shopee.logistics.GetLogistics result.logistics.enabled only affect current item
	Enabled bool `json:"enabled,omitempty"`
	// Only needed when logistics fee_type = CUSTOM_PRICE.
	ShippingFee float64 `json:"shipping_fee,omitempty,string"`
	// If specify logistic fee_type is SIZE_SELECTION size_id is required
	SizeID int64 `json:"size_id,omitempty"`
	// when seller chooses this option, the shipping fee of this channel on item will be set to 0. Default value is False.
	IsFree bool `json:"is_free,omitempty"`
	// Estimated shipping fee calculated by weight. Don't exist if channel is no-integrated.
	EstimatedShippingFee float64 `json:"estimated_shipping_fee,omitempty,string"`
}

type UpdateItemResponseItemVariation

type UpdateItemResponseItemVariation struct {
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// A variation SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the seller's use. Many sellers assign a SKU to an item of a specific type, size, and color, which are variations of one item in Shopee Listings.
	VariationSKU string `json:"variation_sku,omitempty"`
	// Name of the variation that belongs to the same item. A seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price.
	Name string `json:"name,omitempty"`
	// The current price of the variation in the listing currency.If item is in promotion, this value is discount price.
	Price float64 `json:"price,omitempty,string"`
	// The current stock quantity of the variation in the listing currency.
	Stock int `json:"stock,omitempty"`
	// Enumerated type that defines the current status of the variation. Applicable values: MODEL_NORMAL and MODEL_DELETED.
	Status string `json:"status,omitempty"`
	// Timestamp that indicates the date and time that the variation was created.
	CreateTime int `json:"create_time,omitempty"`
	// Timestamp that indicates the last time that there was a change in value of the variation, such as price/stock change.
	UpdateTime int `json:"update_time,omitempty"`
	// The original price of the variation in the listing currency.
	OriginalPirce float64 `json:"original_pirce,omitempty,string"`
	// The ID of discount activity the variation is currently in. One variation can only have one discount at a time. discount_id will be 0 if the variation has no discount applied.
	DiscountID int64 `json:"discount_id,omitempty"`
}

type UpdateItemResponseItemWholesale

type UpdateItemResponseItemWholesale struct {
	// The min count of this tier wholesale.
	Min int `json:"min,omitempty"`
	// The max count of this tier wholesale.
	Max int `json:"max,omitempty"`
	// The current price of the wholesale in the listing currency.If item is in promotion, this price is useless.
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

type UpdatePriceBatchRequestItem

type UpdatePriceBatchRequestItem struct {
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
	// New price value for this item.
	Price int `json:"price,omitempty"`
}

type UpdatePriceBatchResponseBatchResult

type UpdatePriceBatchResponseBatchResult struct {
	// List of item_id which have been updated successfully.
	Modifications []string `json:"modifications,omitempty"`
	// Informations for failed stock updating.
	Failures []UpdatePriceBatchResponseBatchResultFailure `json:"failures,omitempty"`
}

type UpdatePriceBatchResponseBatchResultFailure

type UpdatePriceBatchResponseBatchResultFailure struct {
	// Shopee's unique identifier for an item. Indicating items which failed to update.
	ItemID int64 `json:"item_id,omitempty"`
	// Detailed information for the failed updating.
	ErrorDescription string `json:"error_description,omitempty"`
}

type UpdatePriceResponseItem

type UpdatePriceResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// The time when price of the item is updated.
	ModifiedTime int `json:"modified_time,omitempty"`
	// Specify the revised price of the item.
	Price float64 `json:"price,omitempty,string"`
}

type UpdateShopInfoRequest

type UpdateShopInfoRequest struct {
	// Shop name of this shop.
	ShopName string `json:"shop_name,omitempty"`
	// List of images url of shop banners.
	Images []string `json:"images,omitempty"`
	// List of videos url of shop banners.
	Videos []string `json:"videos,omitempty"`
	// Allow negotiations or not, 1: don't allow, 0: allow.
	DisableMakeOffer int `json:"disable_make_offer,omitempty"`
	// Display pickup address or not.
	EnableDisplayUnitNo bool `json:"enable_display_unit_no,omitempty"`
	// Description of the shop.
	ShopDescription string `json:"shop_description,omitempty"`
	// Partner ID is assigned upon registration is successful. Required for all requests.
	PartnerID int64 `json:"partner_id,omitempty"`
	// Shopee's unique identifier for a shop. Required for all requests.
	ShopID int64 `json:"shopid,omitempty"`
	// This is to indicate the timestamp of the request. Required for all requests.
	Timestamp int `json:"timestamp,omitempty"`
}

type UpdateShopInfoResponse

type UpdateShopInfoResponse struct {
	// Shopee's unique identifier for a shop. Required for all requests.
	ShopID int64 `json:"shopid,omitempty"`
	// Shop name of this shop.
	ShopName string `json:"shop_name,omitempty"`
	// List of images url of shop banners.
	Images []string `json:"images,omitempty"`
	// List of videos url of shop banners. Only accept youtube video urls.
	Videos []string `json:"videos,omitempty"`
	// Allow negotiations or not, 1: don't allow, 0: allow.
	DisableMakeOffer int `json:"disable_make_offer,omitempty"`
	// Display pickup address or not.
	EnableDisplayUnitNo bool `json:"enable_display_unit_no,omitempty"`
	// Warning message if parts of image/video uploads failed.
	Warning string `json:"warning,omitempty"`
	// Description of the shop.
	ShopDescription string `json:"shop_description,omitempty"`
	// The two-digit code representing the country where the order was made.
	Country string `json:"country,omitempty"`
	// The identifier for an API request for error tracking
	RequestID string `json:"request_id,omitempty"`
}

type UpdateStockBatchRequestItem

type UpdateStockBatchRequestItem struct {
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
	// New stock value for this item.
	Stock int `json:"stock,omitempty"`
}

type UpdateStockBatchResponseBatchResult

type UpdateStockBatchResponseBatchResult struct {
	// List of item_id which have been updated successfully.
	Modifications []string `json:"modifications,omitempty"`
	// Informations for failed stock updating.
	Failures []UpdateStockBatchResponseBatchResultFailure `json:"failures,omitempty"`
}

type UpdateStockBatchResponseBatchResultFailure

type UpdateStockBatchResponseBatchResultFailure struct {
	// Shopee's unique identifier for an item. Indicating items which failed to update.
	ItemID int64 `json:"item_id,omitempty"`
	// Detailed information for the failed updating.
	ErrorDescription string `json:"error_description,omitempty"`
}

type UpdateStockResponseItem

type UpdateStockResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// The time when price of the item is updated.
	ModifiedTime int `json:"modified_time,omitempty"`
	// Specify the updated stock quantity.
	Stock int `json:"stock,omitempty"`
}

type UpdateTierVariationIndexRequestVariation

type UpdateTierVariationIndexRequestVariation struct {
	// A list of tier variation indexes, which indicate variation's options in tier_variation['options'] list.
	TierIndex []int `json:"tier_index,omitempty"`
	// The identity of product item variation.
	VariationID []int `json:"variation_id,omitempty"`
}

type UpdateTierVariationListRequestTierVariation

type UpdateTierVariationListRequestTierVariation struct {
	// Tier variation name.
	Name string `json:"name,omitempty"`
	// Tier variation value options list. Lenght should be under 20. Combinations of 2 level options should be under 50.
	Options []string `json:"options,omitempty"`
	// Tier variation images. Can only be applied for the first level options. Urls sequence match the options sequence and urls number cannot exceed options number.
	ImagesURL []string `json:"images_url,omitempty"`
}

type UpdateTopPicksResponseItem

type UpdateTopPicksResponseItem struct {
	// Item ID
	ItemID int64 `json:"item_id,omitempty"`
	// Item name
	ItemName string `json:"item_name,omitempty"`
	// Item discounted price(original price if no discount). Item level price will return if it has variation.
	ItemPrice float64 `json:"item_price,omitempty,string"`
	// The sales of the item
	Sales int `json:"sales,omitempty"`
}

type UpdateVariationPriceBatchRequestVariation

type UpdateVariationPriceBatchRequestVariation struct {
	// Shopee's unique identifier for a variation of an item. Please input the variation_id of a variation to be changed. The variation_id and item_id pair must be matched in order to perform the update.
	VariationID int64 `json:"variation_id,omitempty"`
	// New price value of this variation.
	Price int `json:"price,omitempty"`
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
}

type UpdateVariationPriceBatchResponseBatchResult

type UpdateVariationPriceBatchResponseBatchResult struct {
	// List of item_id which have been updated successfully.
	Modifications []UpdateVariationPriceBatchResponseBatchResultModification `json:"modifications,omitempty"`
	// Informations for failed stock updating.
	Failures []UpdateVariationPriceBatchResponseBatchResultFailure `json:"failures,omitempty"`
}

type UpdateVariationPriceBatchResponseBatchResultFailure

type UpdateVariationPriceBatchResponseBatchResultFailure struct {
	// Shopee's unique identifier for an item. Indicating items which failed to update.
	ItemID int64 `json:"item_id,omitempty"`
	// Detailed information for the failed updating.
	ErrorDescription string `json:"error_description,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type UpdateVariationPriceBatchResponseBatchResultModification

type UpdateVariationPriceBatchResponseBatchResultModification struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type UpdateVariationPriceResponseItem

type UpdateVariationPriceResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// The time when price of the item is updated.
	ModifiedTime int `json:"modified_time,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
	// Specify the revised price of one variation of the item.
	Price float64 `json:"price,omitempty,string"`
}

type UpdateVariationStockBatchRequestVariation

type UpdateVariationStockBatchRequestVariation struct {
	// Shopee's unique identifier for a variation of an item. Please input the variation_id of a variation to be changed. The variation_id and item_id pair must be matched in order to perform the update.
	VariationID int64 `json:"variation_id,omitempty"`
	// New stock value of this variation.
	Stock int `json:"stock,omitempty"`
	// Shopee's unique identifier for an item. Please input the item_id of an item to be changed.
	ItemID int64 `json:"item_id,omitempty"`
}

type UpdateVariationStockBatchResponseBatchResult

type UpdateVariationStockBatchResponseBatchResult struct {
	// List of item_id which have been updated successfully.
	Modifications []UpdateVariationStockBatchResponseBatchResultModification `json:"modifications,omitempty"`
	// Informations for failed stock updating.
	Failures []UpdateVariationStockBatchResponseBatchResultFailure `json:"failures,omitempty"`
}

type UpdateVariationStockBatchResponseBatchResultFailure

type UpdateVariationStockBatchResponseBatchResultFailure struct {
	// Shopee's unique identifier for an item. Indicating items which failed to update.
	ItemID int64 `json:"item_id,omitempty"`
	// Detailed information for the failed updating.
	ErrorDescription string `json:"error_description,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type UpdateVariationStockBatchResponseBatchResultModification

type UpdateVariationStockBatchResponseBatchResultModification struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type UpdateVariationStockResponseItem

type UpdateVariationStockResponseItem struct {
	// Shopee's unique identifier for an item.
	ItemID int64 `json:"item_id,omitempty"`
	// The time when price of the item is updated.
	ModifiedTime int `json:"modified_time,omitempty"`
	// Specify the updated stock quantity.
	Stock int `json:"stock,omitempty"`
	// Shopee's unique identifier for a variation of an item.
	VariationID int64 `json:"variation_id,omitempty"`
}

type UploadImgResponseImage

type UploadImgResponseImage struct {
	// origin image url
	ImageURL string `json:"image_url,omitempty"`
	// Shopee image url
	ShopeeImageURL string `json:"shopee_image_url,omitempty"`
}

type V2I added in v1.5.0

type V2I interface {
	ProductGetCategory(*ProductGetCategoryRequest) (*ProductGetCategory, error)

	ProductGetAttributes(*ProductGetAttributesRequest) (*ProductGetAttributes, error)

	ProductGetBrandList(*ProductGetBrandListRequest) (*ProductGetBrandList, error)

	ProductGetDtsLimit(*ProductGetDtsLimitRequest) (*ProductGetDtsLimit, error)

	ProductGetItemLimit(*ProductGetItemLimitRequest) (*ProductGetItemLimit, error)

	ProductGetItemList(*ProductGetItemListRequest) (*ProductGetItemList, error)

	ProductGetItemBaseInfo(*ProductGetItemBaseInfoRequest) (*ProductGetItemBaseInfo, error)

	ProductGetItemExtraInfo(*ProductGetItemExtraInfoRequest) (*ProductGetItemExtraInfo, error)

	ProductAddItem(*ProductAddItemRequest) (*ProductAddItem, error)

	ProductUpdateItem(*ProductUpdateItemRequest) (*ProductUpdateItem, error)

	ProductDeleteItem(*ProductDeleteItemRequest) error

	ProductInitTierVariation(*ProductInitTierVariationRequest) (*ProductInitTierVariation, error)

	ProductUpdateTierVariation(*ProductUpdateTierVariationRequest) error

	ProductGetModelList(*ProductGetModelListRequest) (*ProductGetModelList, error)

	ProductAddModel(*ProductAddModelRequest) (*ProductAddModel, error)

	ProductUpdateModel(*ProductUpdateModelRequest) error

	ProductDeleteModel(*ProductDeleteModelRequest) error

	ProductSupportSizeChart(*ProductSupportSizeChartRequest) (*ProductSupportSizeChart, error)

	ProductUpdateSizeChart(*ProductUpdateSizeChartRequest) error

	ProductUnlistItem(*ProductUnlistItemRequest) (*ProductUnlistItem, error)

	ProductUpdatePrice(*ProductUpdatePriceRequest) (*ProductUpdatePrice, error)

	ProductUpdateStock(*ProductUpdateStockRequest) (*ProductUpdateStock, error)

	ProductBoostItem(*ProductBoostItemRequest) (*ProductBoostItem, error)

	ProductGetBoostedList(*ProductGetBoostedListRequest) (*ProductGetBoostedList, error)

	ProductGetItemPromotion(*ProductGetItemPromotionRequest) (*ProductGetItemPromotion, error)

	ProductUpdateSipItemPrice(*ProductUpdateSipItemPriceRequest) error

	ProductSearchItem(*ProductSearchItemRequest) (*ProductSearchItem, error)

	ProductGetComment(*ProductGetCommentRequest) (*ProductGetComment, error)

	ProductReplyComment(*ProductReplyCommentRequest) (*ProductReplyComment, error)

	ProductCategoryRecommend(*ProductCategoryRecommendRequest) (*ProductCategoryRecommend, error)

	ProductRegisterBrand(*ProductRegisterBrandRequest) (*ProductRegisterBrand, error)

	ProductGetRecommendAttribute(*ProductGetRecommendAttributeRequest) (*ProductGetRecommendAttribute, error)

	GlobalProductGetCategory(*GlobalProductGetCategoryRequest) (*GlobalProductGetCategory, error)

	GlobalProductGetAttributes(*GlobalProductGetAttributesRequest) (*GlobalProductGetAttributes, error)

	GlobalProductGetBrandList(*GlobalProductGetBrandListRequest) (*GlobalProductGetBrandList, error)

	GlobalProductGetGlobalItemLimit(*GlobalProductGetGlobalItemLimitRequest) (*GlobalProductGetGlobalItemLimit, error)

	GlobalProductGetDtsLimit(*GlobalProductGetDtsLimitRequest) (*GlobalProductGetDtsLimit, error)

	GlobalProductGetGlobalItemList(*GlobalProductGetGlobalItemListRequest) (*GlobalProductGetGlobalItemList, error)

	GlobalProductGetGlobalItemInfo(*GlobalProductGetGlobalItemInfoRequest) (*GlobalProductGetGlobalItemInfo, error)

	GlobalProductAddGlobalItem(*GlobalProductAddGlobalItemRequest) (*GlobalProductAddGlobalItem, error)

	GlobalProductUpdateGlobalItem(*GlobalProductUpdateGlobalItemRequest) (*GlobalProductUpdateGlobalItem, error)

	GlobalProductDeleteGlobalItem(*GlobalProductDeleteGlobalItemRequest) (*GlobalProductDeleteGlobalItem, error)

	GlobalProductInitTierVariation(*GlobalProductInitTierVariationRequest) error

	GlobalProductUpdateTierVariation(*GlobalProductUpdateTierVariationRequest) error

	GlobalProductAddGlobalModel(*GlobalProductAddGlobalModelRequest) error

	GlobalProductUpdateGlobalModel(*GlobalProductUpdateGlobalModelRequest) error

	GlobalProductDeleteGlobalModel(*GlobalProductDeleteGlobalModelRequest) (*GlobalProductDeleteGlobalModel, error)

	GlobalProductGetGlobalModelList(*GlobalProductGetGlobalModelListRequest) (*GlobalProductGetGlobalModelList, error)

	GlobalProductSupportSizeChart(*GlobalProductSupportSizeChartRequest) (*GlobalProductSupportSizeChart, error)

	GlobalProductUpdateSizeChart(*GlobalProductUpdateSizeChartRequest) error

	GlobalProductCreatePublishTask(*GlobalProductCreatePublishTaskRequest) (*GlobalProductCreatePublishTask, error)

	GlobalProductGetPublishableShop(*GlobalProductGetPublishableShopRequest) (*GlobalProductGetPublishableShop, error)

	GlobalProductGetPublishTaskResult(*GlobalProductGetPublishTaskResultRequest) (*GlobalProductGetPublishTaskResult, error)

	GlobalProductGetPublishedList(*GlobalProductGetPublishedListRequest) (*GlobalProductGetPublishedList, error)

	GlobalProductUpdatePrice(*GlobalProductUpdatePriceRequest) error

	GlobalProductUpdateStock(*GlobalProductUpdateStockRequest) error

	GlobalProductSetSyncField(*GlobalProductSetSyncFieldRequest) error

	GlobalProductGetGlobalItemID(*GlobalProductGetGlobalItemIDRequest) (*GlobalProductGetGlobalItemID, error)

	GlobalProductCategoryRecommend(*GlobalProductCategoryRecommendRequest) (*GlobalProductCategoryRecommend, error)

	GlobalProductGetRecommendAttribute(*GlobalProductGetRecommendAttributeRequest) (*GlobalProductGetRecommendAttribute, error)

	MediaSpaceInitVideoUpload(*MediaSpaceInitVideoUploadRequest) (*MediaSpaceInitVideoUpload, error)

	MediaSpaceUploadVideoPart(*MediaSpaceUploadVideoPartRequest) error

	MediaSpaceCompleteVideoUpload(*MediaSpaceCompleteVideoUploadRequest) error

	MediaSpaceGetVideoUploadResult(*MediaSpaceGetVideoUploadResultRequest) (*MediaSpaceGetVideoUploadResult, error)

	MediaSpaceCancelVideoUpload(*MediaSpaceCancelVideoUploadRequest) error

	MediaSpaceUploadImage(*MediaSpaceUploadImageRequest) (*MediaSpaceUploadImage, error)

	ShopGetShopInfo(*ShopGetShopInfoRequest) error

	ShopGetProfile(*ShopGetProfileRequest) (*ShopGetProfile, error)

	ShopUpdateProfile(*ShopUpdateProfileRequest) (*ShopUpdateProfile, error)

	ShopGetWarehouseDetail(*ShopGetWarehouseDetailRequest) ([]ShopGetWarehouseDetail, error)

	MerchantGetMerchantInfo(*MerchantGetMerchantInfoRequest) error

	MerchantGetShopListByMerchant(*MerchantGetShopListByMerchantRequest) error

	OrderGetOrderList(*OrderGetOrderListRequest) (*OrderGetOrderList, error)

	OrderGetShipmentList(*OrderGetShipmentListRequest) (*OrderGetShipmentList, error)

	OrderGetOrderDetail(*OrderGetOrderDetailRequest) (*OrderGetOrderDetail, error)

	OrderSplitOrder(*OrderSplitOrderRequest) (*OrderSplitOrder, error)

	OrderUnsplitOrder(*OrderUnsplitOrderRequest) error

	OrderCancelOrder(*OrderCancelOrderRequest) (*OrderCancelOrder, error)

	OrderHandleBuyerCancellation(*OrderHandleBuyerCancellationRequest) (*OrderHandleBuyerCancellation, error)

	OrderSetNote(*OrderSetNoteRequest) error

	OrderAddInvoiceData(*OrderAddInvoiceDataRequest) error

	OrderGetPendingBuyerInvoiceOrderList(*OrderGetPendingBuyerInvoiceOrderListRequest) (*OrderGetPendingBuyerInvoiceOrderList, error)

	OrderUploadInvoiceDoc(*OrderUploadInvoiceDocRequest) error

	OrderDownloadInvoiceDoc(*OrderDownloadInvoiceDocRequest) error

	OrderGetBuyerInvoiceInfo(*OrderGetBuyerInvoiceInfoRequest) error

	LogisticsGetShippingParameter(*LogisticsGetShippingParameterRequest) (*LogisticsGetShippingParameter, error)

	LogisticsGetTrackingNumber(*LogisticsGetTrackingNumberRequest) (*LogisticsGetTrackingNumber, error)

	LogisticsShipOrder(*LogisticsShipOrderRequest) error

	LogisticsUpdateShippingOrder(*LogisticsUpdateShippingOrderRequest) error

	LogisticsGetShippingDocumentParameter(*LogisticsGetShippingDocumentParameterRequest) (*LogisticsGetShippingDocumentParameter, error)

	LogisticsCreateShippingDocument(*LogisticsCreateShippingDocumentRequest) (*LogisticsCreateShippingDocument, error)

	LogisticsGetShippingDocumentResult(*LogisticsGetShippingDocumentResultRequest) (*LogisticsGetShippingDocumentResult, error)

	LogisticsDownloadShippingDocument(saveFilePath string) func(req *LogisticsDownloadShippingDocumentRequest) (err error)

	LogisticsGetShippingDocumentInfo(*LogisticsGetShippingDocumentInfoRequest) (*LogisticsGetShippingDocumentInfo, error)

	LogisticsGetTrackingInfo(*LogisticsGetTrackingInfoRequest) (*LogisticsGetTrackingInfo, error)

	LogisticsGetAddressList(*LogisticsGetAddressListRequest) (*LogisticsGetAddressList, error)

	LogisticsSetAddressConfig(*LogisticsSetAddressConfigRequest) error

	LogisticsDeleteAddress(*LogisticsDeleteAddressRequest) error

	LogisticsGetChannelList(*LogisticsGetChannelListRequest) (*LogisticsGetChannelList, error)

	LogisticsUpdateChannel(*LogisticsUpdateChannelRequest) (*LogisticsUpdateChannel, error)

	LogisticsBatchShipOrder(*LogisticsBatchShipOrderRequest) (*LogisticsBatchShipOrder, error)

	FirstMileGetUnbindOrderList(*FirstMileGetUnbindOrderListRequest) (*FirstMileGetUnbindOrderList, error)

	FirstMileGetDetail(*FirstMileGetDetailRequest) (*FirstMileGetDetail, error)

	FirstMileGenerateFirstMileTrackingNumber(*FirstMileGenerateFirstMileTrackingNumberRequest) (*FirstMileGenerateFirstMileTrackingNumber, error)

	FirstMileBindFirstMileTrackingNumber(*FirstMileBindFirstMileTrackingNumberRequest) (*FirstMileBindFirstMileTrackingNumber, error)

	FirstMileUnbindFirstMileTrackingNumber(*FirstMileUnbindFirstMileTrackingNumberRequest) (*FirstMileUnbindFirstMileTrackingNumber, error)

	FirstMileGetTrackingNumberList(*FirstMileGetTrackingNumberListRequest) (*FirstMileGetTrackingNumberList, error)

	FirstMileGetWaybill(*FirstMileGetWaybillRequest) error

	FirstMileGetChannelList(*FirstMileGetChannelListRequest) (*FirstMileGetChannelList, error)

	PaymentGetEscrowDetail(*PaymentGetEscrowDetailRequest) (*PaymentGetEscrowDetail, error)

	PaymentSetShopInstallmentStatus(*PaymentSetShopInstallmentStatusRequest) (*PaymentSetShopInstallmentStatus, error)

	PaymentGetShopInstallmentStatus(*PaymentGetShopInstallmentStatusRequest) (*PaymentGetShopInstallmentStatus, error)

	PaymentGetPayoutDetail(*PaymentGetPayoutDetailRequest) (*PaymentGetPayoutDetail, error)

	PaymentSetItemInstallmentStatus(*PaymentSetItemInstallmentStatusRequest) (*PaymentSetItemInstallmentStatus, error)

	PaymentGetItemInstallmentStatus(*PaymentGetItemInstallmentStatusRequest) (*PaymentGetItemInstallmentStatus, error)

	PaymentGetPaymentMethodList(*PaymentGetPaymentMethodListRequest) ([]PaymentGetPaymentMethodList, error)

	PaymentGetWalletTransactionList(*PaymentGetWalletTransactionListRequest) (*PaymentGetWalletTransactionList, error)

	PaymentGetEscrowList(*PaymentGetEscrowListRequest) (*PaymentGetEscrowList, error)

	DiscountAddDiscount(*DiscountAddDiscountRequest) (*DiscountAddDiscount, error)

	DiscountAddDiscountItem(*DiscountAddDiscountItemRequest) (*DiscountAddDiscountItem, error)

	DiscountDeleteDiscount(*DiscountDeleteDiscountRequest) (*DiscountDeleteDiscount, error)

	DiscountDeleteDiscountItem(*DiscountDeleteDiscountItemRequest) (*DiscountDeleteDiscountItem, error)

	DiscountGetDiscount(*DiscountGetDiscountRequest) (*DiscountGetDiscount, error)

	DiscountGetDiscountList(*DiscountGetDiscountListRequest) (*DiscountGetDiscountList, error)

	DiscountUpdateDiscount(*DiscountUpdateDiscountRequest) (*DiscountUpdateDiscount, error)

	DiscountUpdateDiscountItem(*DiscountUpdateDiscountItemRequest) (*DiscountUpdateDiscountItem, error)

	DiscountEndDiscount(*DiscountEndDiscountRequest) (*DiscountEndDiscount, error)

	BundleDealAddBundleDeal(*BundleDealAddBundleDealRequest) (*BundleDealAddBundleDeal, error)

	BundleDealAddBundleDealItem(*BundleDealAddBundleDealItemRequest) (*BundleDealAddBundleDealItem, error)

	BundleDealGetBundleDealList(*BundleDealGetBundleDealListRequest) (*BundleDealGetBundleDealList, error)

	BundleDealGetBundleDeal(*BundleDealGetBundleDealRequest) (*BundleDealGetBundleDeal, error)

	BundleDealGetBundleDealItem(*BundleDealGetBundleDealItemRequest) (*BundleDealGetBundleDealItem, error)

	BundleDealUpdateBundleDeal(*BundleDealUpdateBundleDealRequest) (*BundleDealUpdateBundleDeal, error)

	BundleDealUpdateBundleDealItem(*BundleDealUpdateBundleDealItemRequest) (*BundleDealUpdateBundleDealItem, error)

	BundleDealEndBundleDeal(*BundleDealEndBundleDealRequest) (*BundleDealEndBundleDeal, error)

	BundleDealDeleteBundleDeal(*BundleDealDeleteBundleDealRequest) (*BundleDealDeleteBundleDeal, error)

	BundleDealDeleteBundleDealItem(*BundleDealDeleteBundleDealItemRequest) (*BundleDealDeleteBundleDealItem, error)

	AddOnDealAddAddOnDeal(*AddOnDealAddAddOnDealRequest) (*AddOnDealAddAddOnDeal, error)

	AddOnDealAddAddOnDealMainItem(*AddOnDealAddAddOnDealMainItemRequest) (*AddOnDealAddAddOnDealMainItem, error)

	AddOnDealAddAddOnDealSubItem(*AddOnDealAddAddOnDealSubItemRequest) (*AddOnDealAddAddOnDealSubItem, error)

	AddOnDealDeleteAddOnDeal(*AddOnDealDeleteAddOnDealRequest) (*AddOnDealDeleteAddOnDeal, error)

	AddOnDealDeleteAddOnDealMainItem(*AddOnDealDeleteAddOnDealMainItemRequest) (*AddOnDealDeleteAddOnDealMainItem, error)

	AddOnDealDeleteAddOnDealSubItem(*AddOnDealDeleteAddOnDealSubItemRequest) (*AddOnDealDeleteAddOnDealSubItem, error)

	AddOnDealGetAddOnDealList(*AddOnDealGetAddOnDealListRequest) (*AddOnDealGetAddOnDealList, error)

	AddOnDealGetAddOnDeal(*AddOnDealGetAddOnDealRequest) (*AddOnDealGetAddOnDeal, error)

	AddOnDealGetAddOnDealMainItem(*AddOnDealGetAddOnDealMainItemRequest) (*AddOnDealGetAddOnDealMainItem, error)

	AddOnDealGetAddOnDealSubItem(*AddOnDealGetAddOnDealSubItemRequest) (*AddOnDealGetAddOnDealSubItem, error)

	AddOnDealUpdateAddOnDeal(*AddOnDealUpdateAddOnDealRequest) (*AddOnDealUpdateAddOnDeal, error)

	AddOnDealUpdateAddOnDealMainItem(*AddOnDealUpdateAddOnDealMainItemRequest) (*AddOnDealUpdateAddOnDealMainItem, error)

	AddOnDealUpdateAddOnDealSubItem(*AddOnDealUpdateAddOnDealSubItemRequest) (*AddOnDealUpdateAddOnDealSubItem, error)

	AddOnDealEndAddOnDeal(*AddOnDealEndAddOnDealRequest) (*AddOnDealEndAddOnDeal, error)

	VoucherAddVoucher(*VoucherAddVoucherRequest) (*VoucherAddVoucher, error)

	VoucherDeleteVoucher(*VoucherDeleteVoucherRequest) (*VoucherDeleteVoucher, error)

	VoucherEndVoucher(*VoucherEndVoucherRequest) (*VoucherEndVoucher, error)

	VoucherUpdateVoucher(*VoucherUpdateVoucherRequest) (*VoucherUpdateVoucher, error)

	VoucherGetVoucher(*VoucherGetVoucherRequest) (*VoucherGetVoucher, error)

	VoucherGetVoucherList(*VoucherGetVoucherListRequest) (*VoucherGetVoucherList, error)

	FollowPrizeAddFollowPrize(*FollowPrizeAddFollowPrizeRequest) (*FollowPrizeAddFollowPrize, error)

	FollowPrizeDeleteFollowPrize(*FollowPrizeDeleteFollowPrizeRequest) (*FollowPrizeDeleteFollowPrize, error)

	FollowPrizeEndFollowPrize(*FollowPrizeEndFollowPrizeRequest) (*FollowPrizeEndFollowPrize, error)

	FollowPrizeUpdateFollowPrize(*FollowPrizeUpdateFollowPrizeRequest) (*FollowPrizeUpdateFollowPrize, error)

	FollowPrizeGetFollowPrizeDetail(*FollowPrizeGetFollowPrizeDetailRequest) (*FollowPrizeGetFollowPrizeDetail, error)

	FollowPrizeGetFollowPrizeList(*FollowPrizeGetFollowPrizeListRequest) (*FollowPrizeGetFollowPrizeList, error)

	TopPicksGetTopPicksList(*TopPicksGetTopPicksListRequest) (*TopPicksGetTopPicksList, error)

	TopPicksAddTopPicks(*TopPicksAddTopPicksRequest) (*TopPicksAddTopPicks, error)

	TopPicksUpdateTopPicks(*TopPicksUpdateTopPicksRequest) (*TopPicksUpdateTopPicks, error)

	TopPicksDeleteTopPicks(*TopPicksDeleteTopPicksRequest) (*TopPicksDeleteTopPicks, error)

	ShopCategoryAddShopCategory(*ShopCategoryAddShopCategoryRequest) (*ShopCategoryAddShopCategory, error)

	ShopCategoryGetShopCategoryList(*ShopCategoryGetShopCategoryListRequest) (*ShopCategoryGetShopCategoryList, error)

	ShopCategoryDeleteShopCategory(*ShopCategoryDeleteShopCategoryRequest) (*ShopCategoryDeleteShopCategory, error)

	ShopCategoryUpdateShopCategory(*ShopCategoryUpdateShopCategoryRequest) (*ShopCategoryUpdateShopCategory, error)

	ShopCategoryAddItemList(*ShopCategoryAddItemListRequest) (*ShopCategoryAddItemList, error)

	ShopCategoryGetItemList(*ShopCategoryGetItemListRequest) (*ShopCategoryGetItemList, error)

	ShopCategoryDeleteItemList(*ShopCategoryDeleteItemListRequest) (*ShopCategoryDeleteItemList, error)

	ReturnsGetReturnDetail(*ReturnsGetReturnDetailRequest) (*ReturnsGetReturnDetail, error)

	ReturnsGetReturnList(*ReturnsGetReturnListRequest) ([]ReturnsGetReturnList, error)

	ReturnsConfirm(*ReturnsConfirmRequest) (*ReturnsConfirm, error)

	ReturnsDispute(*ReturnsDisputeRequest) (*ReturnsDispute, error)

	ReturnsGetAvailableSolutions(*ReturnsGetAvailableSolutionsRequest) (*ReturnsGetAvailableSolutions, error)

	ReturnsOffer(*ReturnsOfferRequest) (*ReturnsOffer, error)

	ReturnsAcceptOffer(*ReturnsAcceptOfferRequest) (*ReturnsAcceptOffer, error)

	AccountHealthShopPerformance(*AccountHealthShopPerformanceRequest) error

	AccountHealthShopPenalty(*AccountHealthShopPenaltyRequest) error

	PublicGetShopsByPartner(*PublicGetShopsByPartnerRequest) error

	PublicGetMerchantsByPartner(*PublicGetMerchantsByPartnerRequest) error

	PublicGetTokenByResendCode(*PublicGetTokenByResendCodeRequest) error

	PublicGetRefreshTokenByUpgradeCode(*PublicGetRefreshTokenByUpgradeCodeRequest) (*PublicGetRefreshTokenByUpgradeCode, error)

	PushGetPushConfig(*PushGetPushConfigRequest) error

	PushSetPushConfig(*PushSetPushConfigRequest) error
}

type V2RequestAuthenticationParams added in v1.6.1

type V2RequestAuthenticationParams struct {
	AccessToken string `json:"access_token"`
	PartnerID   int    `json:"partner_id"`
	Timestamp   int    `json:"timestamp"`
	ShopID      int    `json:"shop_id"`
}

for building Authorization params

type V2UnityResponse added in v1.5.1

type V2UnityResponse struct {
	// error is Indicate error type if hit error. Empty if no error happened.
	Error string `json:"error,omitempty"`
	// message is Indicate error details if hit error. Empty if no error happened.
	Message string `json:"message,omitempty"`
	// request_id is The identifier of the API request for error tracking
	RequestID string `json:"request_id,omitempty"`
	// Warning message.
	Warning string `json:"warning,omitempty"`
}

統一的 API 回應介面

type VoucherAddVoucher added in v1.5.1

type VoucherAddVoucher struct {
	// voucher_id is The unique identifier for the created voucher.
	VoucherID int `json:"voucher_id,omitempty"`
}

======================================================= Object Raw Type - VoucherAddVoucher =======================================================

type VoucherAddVoucherRequest added in v1.5.0

type VoucherAddVoucherRequest struct {
	V2RequestAuthenticationParams

	// voucher_name is The name of the voucher.
	VoucherName string `json:"voucher_name"`
	// voucher_code is The code of the voucher.
	VoucherCode string `json:"voucher_code"`
	// start_time is <p>The timing from when the voucher is valid; so buyer is allowed to claim and to use. Field can only be updated if voucher has not started.</p>
	StartTime int `json:"start_time"`
	// end_time is The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.
	EndTime int `json:"end_time"`
	// voucher_type is The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.
	VoucherType int `json:"voucher_type"`
	// reward_type is The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher.
	RewardType int `json:"reward_type"`
	// usage_quantity is The number of times for this particular voucher could be used.
	UsageQuantity int `json:"usage_quantity"`
	// min_basket_price is The minimum spend required for using this voucher.
	MinBasketPrice float64 `json:"min_basket_price,string"`
	// discount_amount is The discount amount set for this particular voucher. Only fill in when you are creating a fix amount voucher.
	DiscountAmount float64 `json:"discount_amount,omitempty,string"`
	// percentage is The discount percentage set for this particular voucher. Only fill in when you are creating a discount percentage voucher or coins cashback voucher.
	Percentage int `json:"percentage,omitempty"`
	// max_price is The max amount of discount/value a user can enjoy by using this particular voucher. Only fill in when you are creating a discount percentage voucher or coins cashback voucher.
	MaxPrice float64 `json:"max_price,omitempty,string"`
	// display_channel_list is The FE channel where the voucher will be displayed. The available values are: 1: display_all, 2: order page, 3: feed, 4: live streaming,   [] (empty - which is hidden).
	DisplayChannelList []int `json:"display_channel_list,omitempty"`
	// item_id_list is The list of items which is applicable for the voucher. Only fill in when you are creating a product type of voucher.
	ItemIdList []int `json:"item_id_list,omitempty"`
	// display_start_time is The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.
	DisplayStartTime int `json:"display_start_time,omitempty"`
}

======================================================= VoucherAddVoucherRequest =======================================================

type VoucherAddVoucherResponse added in v1.5.0

type VoucherAddVoucherResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detailed informations you are querying.
	Response VoucherAddVoucher `json:"response,omitempty"`
}

======================================================= VoucherAddVoucherResponse =======================================================

type VoucherDeleteVoucher added in v1.5.1

type VoucherDeleteVoucher struct {
	// voucher_id is The unique identifier for the voucher it is being deleted.
	VoucherID int `json:"voucher_id,omitempty"`
}

======================================================= Object Raw Type - VoucherDeleteVoucher =======================================================

type VoucherDeleteVoucherRequest added in v1.5.0

type VoucherDeleteVoucherRequest struct {
	V2RequestAuthenticationParams

	// voucher_id is The unique identifier for the voucher you want to delete.
	VoucherID int `json:"voucher_id"`
}

======================================================= VoucherDeleteVoucherRequest =======================================================

type VoucherDeleteVoucherResponse added in v1.5.0

type VoucherDeleteVoucherResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detail informations you are querying.
	Response VoucherDeleteVoucher `json:"response"`
}

======================================================= VoucherDeleteVoucherResponse =======================================================

type VoucherEndVoucher added in v1.5.1

type VoucherEndVoucher struct {
	// voucher_id is The unique identifier for the voucher it is being ended.
	VoucherID int `json:"voucher_id,omitempty"`
}

======================================================= Object Raw Type - VoucherEndVoucher =======================================================

type VoucherEndVoucherRequest added in v1.5.0

type VoucherEndVoucherRequest struct {
	V2RequestAuthenticationParams

	// voucher_id is The unique identifier for the voucher you want to end now.
	VoucherID int `json:"voucher_id"`
}

======================================================= VoucherEndVoucherRequest =======================================================

type VoucherEndVoucherResponse added in v1.5.0

type VoucherEndVoucherResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detailed informations you are querying.
	Response VoucherEndVoucher `json:"response"`
}

======================================================= VoucherEndVoucherResponse =======================================================

type VoucherGetVoucher added in v1.5.1

type VoucherGetVoucher struct {
	// voucher_id is The unique identifier of the voucher whose details are returned.
	VoucherID int `json:"voucher_id,omitempty"`
	// voucher_code is Voucher Code
	VoucherCode string `json:"voucher_code,omitempty"`
	// voucher_name is Voucher Name
	VoucherName string `json:"voucher_name,omitempty"`
	// voucher_type is The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.
	VoucherType int `json:"voucher_type,omitempty"`
	// reward_type is The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher.
	RewardType int `json:"reward_type,omitempty"`
	// usage_quantity is The number of times for this particular voucher could be used.
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// current_usage is Up till now, how many times has this particular voucher already been used.
	CurrentUsage int `json:"current_usage,omitempty"`
	// start_time is The timing from when the voucher is valid; so buyer is allowed to claim and to use.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.
	EndTime int `json:"end_time,omitempty"`
	// is_admin is If the voucher is created by Shopee or not.
	IsAdmin bool `json:"is_admin,omitempty"`
	// voucher_purpose is The use case for the voucher. The available values are: 0: normal; 1: welcome, 2: referral; 3: shop_follow; 4:shop_game, 5: free_gift, 6: membership
	VoucherPurpose int `json:"voucher_purpose,omitempty"`
	// display_channel_list is The FE channel where the voucher will be displayed. The available values are: 1: display_all, 2: order page, 3: feed, 4: live streaming,   [] (empty - which is hidden).
	DisplayChannelList []int `json:"display_channel_list,omitempty"`
	// min_basket_price is The minimum spend required for using this voucher.
	MinBasketPrice float64 `json:"min_basket_price,omitempty,string"`
	// percentage is The discount percentage set for this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.
	Percentage int `json:"percentage,omitempty"`
	// max_price is The max amount of discount/value a user can enjoy by using this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.
	MaxPrice float64 `json:"max_price,omitempty,string"`
	// discount_amount is The discount amount set for this particular voucher. Only when it is a fix amount voucher, api will return a value.
	DiscountAmount float64 `json:"discount_amount,omitempty,string"`
	// cmt_voucher_status is The voucher status in CMT. The available values are: 1:review, 2: approved, 3:reject. Only when this voucher is attending CMT campaign and not being rejected, api will return a value.
	CmtVoucherStatus int `json:"cmt_voucher_status,omitempty"`
	// item_id_list is The list of items which is applicable for the voucher. Only return a value when it is a product type of voucher.
	ItemIdList []int `json:"item_id_list,omitempty"`
	// display_start_time is The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.
	DisplayStartTime int `json:"display_start_time,omitempty"`
}

======================================================= Object Raw Type - VoucherGetVoucher =======================================================

type VoucherGetVoucherList added in v1.5.1

type VoucherGetVoucherList struct {
	// more is This is to indicate whether the comment list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of comments.
	More bool `json:"more,omitempty"`
	// voucher_list is The list of voucher.
	VoucherList []VoucherGetVoucherListVoucher `json:"voucher_list"`
}

======================================================= Object Raw Type - VoucherGetVoucherList =======================================================

type VoucherGetVoucherListRequest added in v1.5.0

type VoucherGetVoucherListRequest struct {
	V2RequestAuthenticationParams

	// page_no is Specifies the page number of data to return in the current call. Default to be 1 and allowed input is from 1 - 5000.
	PageNo int `json:"page_no,omitempty"`
	// page_size is Use the 'page_size' filters to control the maximum number of entries to retrieve per page (i.e., per call). Default to be 20 and allowed input is from 1- 100.
	PageSize int `json:"page_size,omitempty"`
	// status is The status filter for retrieving voucher list. Available value: upcoming/ongoing/expired/all.
	Status string `json:"status"`
}

======================================================= VoucherGetVoucherListRequest =======================================================

type VoucherGetVoucherListResponse added in v1.5.0

type VoucherGetVoucherListResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detailed informations you are querying.
	Response VoucherGetVoucherList `json:"response"`
}

======================================================= VoucherGetVoucherListResponse =======================================================

type VoucherGetVoucherListVoucher added in v1.5.5

type VoucherGetVoucherListVoucher struct {
	// voucher_id is The unique identifier for a voucher.
	VoucherID int `json:"voucher_id,omitempty"`
	// voucher_code is Voucher Code
	VoucherCode string `json:"voucher_code,omitempty"`
	// voucher_name is Voucher Name
	VoucherName string `json:"voucher_name,omitempty"`
	// voucher_type is The type of the voucher. The available values are: 1: shop voucher, 2: product voucher.
	VoucherType int `json:"voucher_type,omitempty"`
	// reward_type is The reward type of the voucher. The available values are: 1: fix_amount voucher, 2: discount_percentage voucher, 3: coin_cashback voucher.
	RewardType int `json:"reward_type,omitempty"`
	// usage_quantity is The number of times for this particular voucher could be used.
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// current_usage is Up till now, how many times has this particular voucher already been used.
	CurrentUsage int `json:"current_usage,omitempty"`
	// start_time is The timing from when the voucher is valid; so buyer is allowed to claim and to use.
	StartTime int `json:"start_time,omitempty"`
	// end_time is The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.
	EndTime int `json:"end_time,omitempty"`
	// is_admin is If the voucher is created by Shopee or not.
	IsAdmin bool `json:"is_admin,omitempty"`
	// voucher_purpose is The use case for the voucher. The available values are: 0: normal; 1: welcome, 2: referral; 3: shop_follow; 4:shop_game, 5: free_gift, 6: membership
	VoucherPurpose int `json:"voucher_purpose,omitempty"`
	// discount_amount is The discount amount set for this particular voucher. Only when it is a fix amount voucher, api will return a value.
	DiscountAmount float64 `json:"discount_amount,omitempty,string"`
	// percentage is The discount percentage set for this particular voucher. Only when it is a discount percentage voucher or coins cashback voucher, api will return a value.
	Percentage int `json:"percentage,omitempty"`
	// cmt_voucher_status is The voucher status in CMT. The available values are: 1:review, 2: approved, 3:reject. Only when this voucher is attending CMT campaign and not being rejected, api will return a value.
	CmtVoucherStatus int `json:"cmt_voucher_status,omitempty"`
	// display_start_time is The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.
	DisplayStartTime int `json:"display_start_time,omitempty"`
}

======================================================= Object Raw Type - VoucherGetVoucherListVoucher =======================================================

type VoucherGetVoucherRequest added in v1.5.0

type VoucherGetVoucherRequest struct {
	V2RequestAuthenticationParams

	// voucher_id is The unique identifier of a voucher used to query the voucher details.
	VoucherID int `json:"voucher_id"`
}

======================================================= VoucherGetVoucherRequest =======================================================

type VoucherGetVoucherResponse added in v1.5.0

type VoucherGetVoucherResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detailed informations you are querying.
	Response VoucherGetVoucher `json:"response"`
}

======================================================= VoucherGetVoucherResponse =======================================================

type VoucherUpdateVoucher added in v1.5.1

type VoucherUpdateVoucher struct {
	// voucher_id is The unique identifier of the voucher which is being updated.
	VoucherID int `json:"voucher_id,omitempty"`
}

======================================================= Object Raw Type - VoucherUpdateVoucher =======================================================

type VoucherUpdateVoucherRequest added in v1.5.0

type VoucherUpdateVoucherRequest struct {
	V2RequestAuthenticationParams

	// voucher_id is The unique identifier of the voucher which is going to be updated.
	VoucherID int `json:"voucher_id"`
	// voucher_name is The name of the voucher
	VoucherName string `json:"voucher_name,omitempty"`
	// start_time is <p>The timing from when the voucher is valid; so buyer is allowed to claim and to use. Field can only be updated if voucher has not started.</p>
	StartTime int `json:"start_time,omitempty"`
	// end_time is The timing until when the voucher is still valid. Any time after this end_time, buyer is not allowed to claim or to use.
	EndTime int `json:"end_time,omitempty"`
	// usage_quantity is The number of times for this particular voucher could be used.
	UsageQuantity int `json:"usage_quantity,omitempty"`
	// min_basket_price is The minimum spend required for using this voucher.
	MinBasketPrice float64 `json:"min_basket_price,omitempty,string"`
	// discount_amount is The discount amount set for this particular voucher. Only fill in when you are updating a fix amount voucher.
	DiscountAmount float64 `json:"discount_amount,omitempty,string"`
	// percentage is The discount percentage set for this particular voucher. Only fill in when you are updating a discount percentage voucher or coins cashback voucher.
	Percentage int `json:"percentage,omitempty"`
	// max_price is The max amount of discount/value a user can enjoy by using this particular voucher. Only fill in when you are updating a discount percentage voucher or coins cashback voucher.
	MaxPrice float64 `json:"max_price,omitempty,string"`
	// display_channel_list is The FE channel where the voucher will be displayed. The available values are: 1: display_all, 2: order page, 3: feed, 4: live streaming,   [] (empty - which is hidden).
	DisplayChannelList []int `json:"display_channel_list,omitempty"`
	// item_id_list is The list of items which is applicable for the voucher. Only fill in when you are updating a product type of voucher.
	ItemIdList []int `json:"item_id_list,omitempty"`
	// display_start_time is The timing of when voucher is displayed on shop pages; so buyer is allowed to claim.
	DisplayStartTime int `json:"display_start_time,omitempty"`
}

======================================================= VoucherUpdateVoucherRequest =======================================================

type VoucherUpdateVoucherResponse added in v1.5.0

type VoucherUpdateVoucherResponse struct {
	// 通用的 Response 回傳參數
	V2UnityResponse

	// response is Detailed informations you are querying.
	Response VoucherUpdateVoucher `json:"response,omitempty"`
}

======================================================= VoucherUpdateVoucherResponse =======================================================

type Wholesale added in v1.5.1

type Wholesale struct {
	// min_count is Minimum count of this tier
	MinCount int `json:"min_count,omitempty"`
	// max_count is Maximum count of this tier
	MaxCount int `json:"max_count,omitempty"`
	// unit_price is <p>Unit price of this tier.</p><p><b><font color="#c24f4a">For&nbsp;SG/MY/BR/MX/PL/ES/AR seller</font></b>:&nbsp;Sellers can set the price with two decimal place,&nbsp;other regions can only set the price as an integer.<br /></p>
	UnitPrice float64 `json:"unit_price,omitempty,string"`
}

======================================================= Object Raw Type - Wholesale =======================================================

Jump to

Keyboard shortcuts

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