Schema Reference

本頁列出 Platform API 的主要 request、response 與 enum。為保護供應商代稱，本頁使用 Ch01 與 Ch02 作為顯示名稱；API path 與 JSON 欄位名稱仍維持合約原樣。

警告

JSON 欄位名稱與 enum value 是 API 合約的一部分，請依本頁列出的大小寫與底線格式送出。

Request Schemas

CreateCh01OrderRequest

Field	Type	Required	Description
quantity	integer(int32)	No	數量。範圍 1 到 10000000。
link	string(uri)	No	直播連結。
product_id	string(uuid)	No	商品 ID。

CreateCh02DefaultOrderRequest

Field	Type	Required	Description
quantity	integer(int32)	No	數量。範圍 1 到 10000000。
runs	integer(int32)	No	分次處理次數。範圍 1 到 10000000。
interval_minutes	integer(int32)	No	分次處理時間間隔，單位為分鐘。範圍 1 到 10000000。
link	string(uri)	Conditional	貼文連結。產品類別不是 instagram_story 時必填，且不可與 username 同時有值。
username	string	Conditional	使用者名稱。產品類別是 instagram_story 時必填，且不可與 link 同時有值。
product_id	string(uuid)	No	商品 ID。

CreateCh02CommentLikesOrderRequest

Field	Type	Required	Description
quantity	integer(int32)	No	數量。範圍 1 到 10000000。
username	string	No	被按讚的帳號。
link	string(uri)	No	貼文連結。
product_id	string(uuid)	No	商品 ID。

CreateCh02CustomCommentOrderRequest

Field	Type	Required	Description
comments	string	No	留言內容。
link	string(uri)	No	貼文連結。
product_id	string(uuid)	No	商品 ID。

CreateCh02SubscriptionsOrderRequest

Field	Type	Required	Description
max_quantity	integer(int32)	No	最大數量。範圍 1 到 10000000。
min_quantity	integer(int32)	No	最小數量。範圍 1 到 10000000。
delay_minutes	enum	No	延遲分鐘數。
new_post_count	integer(int32)	No	新貼文數量。範圍 1 到 10000000。
old_post_count	integer(int32)	No	舊貼文數量。範圍 1 到 10000000。
expiry_date	string(date-time)	No	任務到期時間。
username	string	No	帳號名稱。
product_id	string(uuid)	No	商品 ID。

Response Schemas

OrderResponse

Field	Type	Required	Description
order_id	string(uuid)	Yes	訂單 ID。
order_number	string	No	訂單編號。
payment_type	enum	Yes	付款方式。
order_status	enum	Yes	訂單狀態。
payment_status	enum	Yes	付款狀態。
total	number(double)	Yes	總價。
order_detail	array	No	訂單細節。
create_date_time	string(date-time)	Yes	建立時間。
update_date_time	string(date-time)	No	最後更新時間。

OrderDetailResponse

Field	Type	Required	Description
order_detail_id	string(uuid)	Yes	訂單細節 ID。
product	object	Yes	產品資料。
parameter	string	No	參數。
quantity	integer(int32)	Yes	數量。
price_snapshot	number(double)	Yes	商品價格快照。
sub_total	number(double)	Yes	商品總金額。
title_snapshot	string	No	商品標題快照。
description_snapshot	string	No	商品描述快照。
ch1_order	array	No	Ch01 訂單內容。
ch2_order	array	No	Ch02 訂單內容。
create_date_time	string(date-time)	Yes	建立時間。
update_date_time	string(date-time)	No	最後更新時間。

ProductResponse

Field	Type	Required	Description
product_id	string(uuid)	Yes	產品 ID。
title	string	No	標題。
description	string	No	詳細資料。
product_type	enum	Yes	產品類型。
product_category	enum	Yes	產品分類。
main_product_category	enum	Yes	主要產品分類。
price	number(double)	Yes	價格。
min	integer(int32)	No	最小值。
max	integer(int32)	No	最大值。
order_no	integer(int32)	No	排序序號。
dynamic_probability	enum	Yes	動態機率。
increase_speed	enum	Yes	增長速度。
service_type	enum	Yes	服務類型。
create_date_time	string(date-time)	Yes	建立時間。
update_date_time	string(date-time)	No	最後更新時間。
ch2_product	object	No	Ch02 產品內容。
ch1_product	object	No	Ch01 產品內容。

OrganizationResponse

Field	Type	Required	Description
organization_id	string(uuid)	Yes	組織 ID。
name	string	No	組織名稱。

OrganizationCreditBalanceResponse

Field	Type	Required	Description
balance	number(double)	Yes	信用餘額。

OrganizationCreditRecordResponse

Field	Type	Required	Description
organization_credit_record_id	string(uuid)	Yes	組織信用紀錄 ID。
organization_credit_record_number	string	No	組織信用紀錄編號。
quantity	number(double)	Yes	信用點數。
type	enum	Yes	紀錄類型。
order	object	No	相關訂單。
create_date_time	string(date-time)	Yes	建立時間。

PagedResponse

Field	Type	Required	Description
value	array	No	資料集合。
@odata.count	integer(int32)	Yes	資料總數。

Ch01OrderResponse

Field	Type	Required	Description
code	integer(int32)	No	代碼。
order_identity	string	No	訂單識別代碼。
business_name	string	No	業務名稱。
home_page_link	string	No	主頁連結。
start	integer(int32)	No	開始人數。
current	integer(int32)	No	當前人數。
room_no	string	No	房間號碼。
live_status	string	No	直播狀態。
order_quantity	integer(int32)	No	訂單數量。
order_status	string	No	訂單狀態。
remark	string	No	備註。
nt	string	No	錯誤原因。
create_date_time	string(date-time)	Yes	建立時間。
update_date_time	string(date-time)	No	最後更新時間。

Ch02OrderResponse

Field	Type	Required	Description
order_id	integer(int32)	Yes	訂單編號。
charge	string	No	收費。
start_count	string	No	開始數量。
status	enum	Yes	訂單狀態。
username	string	No	被按讚的帳號。
comments	string	No	留言內容。
runs	integer(int32)	No	分次處理次數。
interval	integer(int32)	No	分次處理次數每次間隔，單位為分鐘。
max_quantity	integer(int32)	No	最大數量。
min_quantity	integer(int32)	No	最小數量。
delay_minutes	enum	Yes	延遲分鐘數。
new_post_count	integer(int32)	No	新貼文數量。
old_post_count	integer(int32)	No	舊貼文數量。
expiry_date	string(date-time)	No	任務到期時間。
remains	string	No	剩餘數量。
currency	string	No	貨幣類型。
error	string	No	錯誤訊息。

Enums

Enums.CustomProductType

ch1_facebook_live
ch1_tik_tok_live
ch1_instagram_live
ch1_youtube_live
ch1_twitch_live
ch1_shopee_live
ch1_bigo_live
ch2_default
ch2_comment_likes
ch2_custom_comments
ch2_subscriptions

Enums.CustomServiceType

channel1
channel2

Enums.DelayMinutes

min0
min5
min10
min15
min20
min30
min40
min50
min60
min90
min120
min150
min180
min210
min240
min270
min300
min360
min420
min480
min540
min600

Enums.DynamicProbability

low
medium
high

Enums.IncreaseSpeed

slow
medium
fast

Enums.MainProductCategory

facebook
instagram
google_map
line
xiaohongshu
threads
tiktok
youtube
twitter
other

Enums.OrderStatus

establish
cancel
complete
failed
exception

Enums.OrganizationCreditRecordType

increase
decrease

Enums.PaymentStatus

complete
failed

Enums.PaymentType

credit

Enums.ProductCategory

facebook_live
tik_tok_live
instagram_live
youtube_live
twitch_live
shopee_live
bigo_live
facebook_fans
facebook_post_symbol
facebook_post_share
facebook_video_view
tik_tok_fans
tik_tok_video_symbol
tik_tok_media_share
tik_tok_live_comment
tik_tok_video_view
instagram_fans
instagram_post_symbol
instagram_comment_symbol
instagram_video_view
instagram_comment
youtube_video_view
youtube_video_symbol
youtube_comment_symbol
youtube_share
rednote_fans
google_map
twitter
threads
line
instagram_story
facebook_video_symbol
rednote_comment
rednote_post

Enums.Ch02OrderStatus

exception
pending
In progress
completed
Partial
processing
canceled
active
paused
expired