BioTech Open Platform Docs
Type to search documentation.

Douyin Selected Alliance Orders

List Douyin Selected Alliance settlement orders with pagination, filtering, sorting, and complete field definitions.

Endpoint information

ItemValue
MethodGET
Request URLhttps://backend.biotech-mkt.com/openapi/v1/doudian/order/union-settlement-orders
Path/openapi/v1/doudian/order/union-settlement-orders
AuthenticationBearer Access Token
PermissionEndpoint must be enabled and granted to the application
Rate limitConfigured per application and endpoint
Acceptapplication/json

Response

The HTTP status, duration, and response body appear here after the request is sent.

Returns Douyin Selected Alliance orders that have already been synchronized into the platform database.

Authentication and grant

This endpoint requires an Access Token. A platform administrator must register and enable the endpoint and grant it to the current application.

Request parameters

Pagination and sorting

ParameterTypeDefaultDescription
pageinteger1Page number, starting at 1
page_sizeinteger10Number of records per page
order_bystringidSort field; id and update_time are recommended
order_by_directionstringdescasc or desc

Text filters

The following parameters use contains matching:

ParameterDescription
order_idOrder number
shop_nameMerchant name
product_idProduct ID
product_nameProduct name
product_imgProduct image URL
media_typeCommerce media type code
flow_pointOrder status code
appApplication name
author_buyin_idCreator Buyin ID
author_short_idCreator Douyin handle
author_accountCreator account nickname
distributor_buyin_idIndependent distributor Buyin ID
distributor_nameIndependent distributor nickname

Exact and multi-value filters

The following parameters use exact matching when sent once and set matching when sent as field[]=a&field[]=b:

ParameterDescription
media_idVideo or live-room ID
app_idContent application ID
buyer_app_idBuyer application ID
shop_idShop ID
item_numItem quantity
total_pay_amountTotal payment amount in yuan
pay_goods_amountEstimated settlement-eligible amount in yuan
settled_goods_amountActual settlement-eligible amount in yuan
estimated_commissionEstimated creator commission in yuan
real_commissionActual creator commission in yuan
estimated_total_commissionEstimated total commission in yuan
shop_estimated_commissionEstimated merchant commission expense in yuan
shop_real_commissionActual merchant commission expense in yuan
ads_estimated_commissionEstimated distributor promotion fee in yuan
ads_real_commissionActual distributor promotion fee in yuan
settled_tech_service_feePlatform settlement service fee in yuan
commission_rateCreator commission rate as a percentage value
ads_promotion_rateDistributor promotion rate as a percentage value
tenant_idTenant ID
dept_idDepartment ID
created_byCreator user ID
updated_byLast updater user ID

Time filters

The following parameters use exact matching when sent once and an inclusive range when sent as two array values:

ParameterDescription
pay_success_timePayment time
confirm_timeReceipt confirmation time
settle_timeSettlement time
refund_timeRefund time
update_timeAlliance-side order update time
created_atLocal record creation time

Use the YYYY-MM-DD HH:mm:ss format and URL-encode spaces.

Request example

Terminal window
curl --get "https://backend.biotech-mkt.com/openapi/v1/doudian/order/union-settlement-orders" \
--header "Authorization: Bearer $OPENAPI_ACCESS_TOKEN" \
--data-urlencode "page=1" \
--data-urlencode "page_size=20" \
--data-urlencode "shop_id=10001" \
--data-urlencode "flow_point=SETTLE" \
--data-urlencode "update_time[]=2026-08-01 00:00:00" \
--data-urlencode "update_time[]=2026-08-26 23:59:59"

Response fields

Fields in each data.list item are serialized from the current database model, and data.total is the total number of matching records. Decimal values such as amounts and rates are typically returned as strings with two decimal places. The four *_text fields are currently generated by the server in Chinese; clients should use the underlying codes when they need locale-independent values.

Response structure

FieldReturn typeDescription
codeintegerBusiness status code; 200 on success
messagestringResponse message
dataobjectPaginated response data
data.listarray<object>Order records on the current page
data.totalintegerTotal number of matching order records

Order and platform fields

FieldReturn typeDescription
idintegerLocal record ID
order_idstringOrder number
shop_idintegerShop ID
shop_namestringMerchant name
product_idstringProduct ID
product_namestringProduct name
product_imgstringProduct image URL
item_numintegerItem quantity
media_idintegerVideo or live-room ID
media_typestringshop_list, video, live, or others
media_type_textstringChinese label for the media type
appstringContent application name
app_idinteger1128 Douyin, 1112 Huoshan, 32 Xigua, or 13 Toutiao
app_id_textstringChinese label for the content application
buyer_app_idintegerBuyer application ID; also supports 2329 for Douyin Lite
buyer_app_id_textstringChinese label for the buyer application
extrastringOther upstream data

Status and time fields

FieldReturn typeDescription
flow_pointstringPAY_SUCC, REFUND, SETTLE, or CONFIRM
flow_point_textstringChinese label for paid, refunded, settled, or confirmed
pay_success_timestring/nullPayment time
confirm_timestring/nullReceipt confirmation time
settle_timestring/nullSettlement time
refund_timestring/nullRefund time
update_timestring/nullAlliance-side order update time
created_atstring/nullLocal creation time
updated_atstring/nullLocal update time

Amount and rate fields

During synchronization, upstream amounts in fen are divided by 100 and stored in yuan. Upstream rates expressed in ten-thousandths are divided by 100 and stored as percentage values. For example, an upstream amount of 12345 is returned as 123.45 yuan, and an upstream rate of 450 is returned as 4.50.

FieldReturn typeDescription
total_pay_amountstringTotal payment amount, yuan
pay_goods_amountstringEstimated settlement-eligible amount, yuan
settled_goods_amountstringActual settlement-eligible amount, yuan
estimated_commissionstringEstimated creator commission, yuan
real_commissionstringActual creator commission, yuan
estimated_total_commissionstringEstimated total commission, yuan
shop_estimated_commissionstringEstimated merchant commission expense, yuan
shop_real_commissionstringActual merchant commission expense, yuan
ads_estimated_commissionstringEstimated distributor promotion fee, yuan
ads_real_commissionstringActual distributor promotion fee, yuan
settled_tech_service_feestringPlatform settlement service fee, yuan
commission_ratestringCreator commission rate as a percentage value
ads_promotion_ratestringDistributor promotion rate as a percentage value
colonel_estimated_commissionstringEstimated group-leader service fee, yuan
colonel_real_commissionstringSettled group-leader service fee, yuan
colonel_commission_ratestringGroup-leader service fee rate as a percentage value

Creator, distributor, and group-leader fields

FieldReturn typeDescription
author_buyin_idstringCreator Buyin ID
author_short_idstringCreator Douyin handle
author_accountstringCreator account nickname
aweme_idstringDouyin UID
distributor_buyin_idstringIndependent distributor Buyin ID
distributor_namestringIndependent distributor nickname
colonel_activity_idstringGroup-leader campaign ID
colonel_institution_idstringGroup-leader institution ID
colonel_institution_namestringGroup-leader institution name
colonel_colonel_buyin_idstringGroup-leader Buyin ID
tenant_idintegerTenant ID
dept_idintegerDepartment ID
created_byinteger/nullCreator user ID
updated_byinteger/nullLast updater user ID

Data freshness

This endpoint reads data that has already been synchronized into the platform. It does not call DouDian in real time. Use each record’s update_time and the platform synchronization status to evaluate freshness.

Response example

json
{
"code": 200,
"message": "Success",
"data": {
"list": [
{
"id": 101,
"order_id": "U202608260001",
"shop_id": 10001,
"shop_name": "Example Shop",
"product_id": "90001",
"product_name": "Example Product",
"item_num": 1,
"media_type": "video",
"media_type_text": "视频",
"flow_point": "SETTLE",
"flow_point_text": "结算",
"total_pay_amount": "123.45",
"commission_rate": "4.50",
"pay_success_time": "2026-08-20 10:00:00",
"update_time": "2026-08-26 12:00:00"
}
],
"total": 1
}
}

Errors and rate limits

This endpoint can return 401, 403, 404, 405, 429, or 503. Limits are counted independently by application ID and endpoint ID. See Errors and Rate Limits for response headers and handling guidance.

Last updated Aug 27, 2026