TikTok Shop connection for LinkyFlow

LinkyFlow brings TikTok Shop ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

223

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

After-sales

Approve Cancellation

Accepts the buyer’s cancellation: the order is cancelled and the buyer refunded.

Create

Approve Cancellation

Route: POST /mutation/cancellationApprove

Inputs you can set

Name	Type	Required	Description
`cancel_id`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Approve Return

Accepts the buyer’s request: a refund, a return of the item, the item received, or a replacement.

Create

Approve Return

Route: POST /mutation/returnApprove

Inputs you can set

Name	Type	Required	Description
`buyer_keep_item`	boolean	No	-
`decision`	enum	Yes	Values: APPROVE_REFUND, APPROVE_RETURN, APPROVE_RECEIVED_PACKAGE, APPROVE_REPLACEMENT
`return_id`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancellations

The cancellations of a shop’s orders, asked by the buyer or made by the seller, and what each refunds.

Read

Cancellations

The cancellations of a shop’s orders, asked by the buyer or made by the seller, and what each refunds.

Route: GET /cancellations

Excel formula: =LF.tiktokshop.cancellations("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`cancel_status`	enum	No	Only the cancellations in this status. Values: CANCELLATION_REQUEST_PENDING, CANCELLATION_REQUEST_SUCCESS, CANCELLATION_REQUEST_CANCEL, CANCELLATION_REQUEST_COMPLETE
`order_id`	id	No	Only this order’s.
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 50). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`order_id` default	id	→ orders	-
`cancel_status` default	string	—	-
`cancel_type` default	string	—	-
`cancel_reason_text` default	string	—	-
`refund_total` default	string	—	-
`update_time` default	date	—	-

Reject Cancellation

Refuses the buyer’s cancellation, with a reason TikTok Shop accepts: the order goes on.

Create

Reject Cancellation

Route: POST /mutation/cancellationReject

Inputs you can set

Name	Type	Required	Description
`cancel_id`	id	Yes	-
`comment`	string	No	-
`reject_reason`	string	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reject Reasons

The reasons TikTok Shop accepts for refusing one cancellation or return: the keys a rejection names.

Read

Reject Reasons

The reasons TikTok Shop accepts for refusing one cancellation or return: the keys a rejection names.

Route: GET /rejectReasons

Excel formula: =LF.tiktokshop.rejectReasons("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`return_or_cancel_id`	id	Yes	The return or the cancellation to refuse.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`locale`	string	No	The language of the reasons (fr-FR).
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`text` default	string	—	-

Reject Return

Refuses the buyer’s request, with a reason TikTok Shop accepts: the buyer may ask TikTok Shop to arbitrate.

Create

Reject Return

Route: POST /mutation/returnReject

Inputs you can set

Name	Type	Required	Description
`comment`	string	No	-
`decision`	enum	Yes	Values: REJECT_REFUND, REJECT_RETURN, REJECT_RECEIVED_PACKAGE, REJECT_REPLACEMENT
`reject_reason`	string	Yes	-
`return_id`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Returns

The returns and refunds the shop’s buyers asked for: their status, reason, tracking and what each refunds.

Read

Returns

The returns and refunds the shop’s buyers asked for: their status, reason, tracking and what each refunds.

Route: GET /returns

Excel formula: =LF.tiktokshop.returns("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`return_status`	enum	No	Only the returns in this status. Values: RETURN_OR_REFUND_REQUEST_PENDING, REFUND_OR_RETURN_REQUEST_REJECT, AWAITING_BUYER_SHIP, BUYER_SHIPPED_ITEM, REJECT_RECEIVE_PACKAGE
`return_type`	enum	No	Values: REFUND, RETURN_AND_REFUND, REPLACEMENT, EXCHANGE
`order_id`	id	No	Only this order’s.
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 50). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`order_id` default	id	→ orders	-
`return_type` default	string	—	-
`return_status` default	string	—	-
`return_reason_text` default	string	—	-
`refund_total` default	string	—	-
`update_time` default	date	—	-

Analytics

Product Performance

How each product sold over a period of days: its sales, orders and views, in all and by channel.

Read

Product Performance

How each product sold over a period of days: its sales, orders and views, in all and by channel.

Route: GET /productPerformance

Excel formula: =LF.tiktokshop.productPerformance("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date_ge`	string	Yes	The first day, in the shop’s time zone (2026-01-31).
`end_date_lt`	string	Yes	The day after the last one, in the shop’s time zone (2026-02-28).
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`product_status_filter`	enum	No	Values: LIVE, INACTIVE, ALL
`sort_field`	string	No	The metric products are sorted on (gmv, the default).
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`total_performance` default	string	—	-
`seller_live_performance`	string	—	-
`seller_video_performance`	string	—	-
`seller_product_card_performance`	string	—	-
`affiliate_total_performance`	string	—	-
`shop_tab_performance`	string	—	-

Catalog

Activate Product

Puts this product deactivated by the seller back on sale on TikTok Shop.

Create

Activate Product

Route: POST /mutation/productActivate

Inputs you can set

Name	Type	Required	Description
`productId`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Brands

The brands a shop may name on a product, and whether it is authorized to sell each.

Read

Brands

The brands a shop may name on a product, and whether it is authorized to sell each.

Route: GET /brands

Excel formula: =LF.tiktokshop.brands("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`brand_name`	string	No	Only the brands whose name begins so.
`category_id`	id	No	-
`is_authorized`	boolean	No	Only the authorized ones, or not.
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`authorized_status` default	string	—	-
`brand_status`	string	—	-
`is_t1_brand`	boolean	—	-

This action returns a confirmation rather than a selectable table.

Products

The products of a shop: title, status, audit, the SKUs each holds with its price and its stock by warehouse.

Used as filter by

Stock Commitments · product_id

Read

Products

The products of a shop: title, status, audit, the SKUs each holds with its price and its stock by warehouse.

Route: GET /products

Excel formula: =LF.tiktokshop.products("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`status`	enum	No	Only the products in this status. Empty: every status. Values: DRAFT, PENDING, FAILED, ACTIVATE, SELLER_DEACTIVATED
`seller_sku`	string	No	Only the products holding one of these seller SKUs, comma-separated (up to 10), as the seller spelled them.
`sku_id`	id	No	Only the products holding one of these SKU IDs, comma-separated (up to 10).
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`status` default	string	—	-
`audit`	string	—	-
`status` default	string	—	-
`skus`	string	—	-
`sales_regions`	string	—	-
`is_not_for_sale`	boolean	—	-
`has_draft`	boolean	—	-
`listing_quality_tier`	string	—	-
`create_time`	date	—	-
`update_time` default	date	—	-
`can_activate`	boolean	—	-
`can_deactivate`	boolean	—	-

SKUs

Every SKU of the shop’s products, one row each: its seller SKU, its price and its product. Its stock is in Stock.

Used as filter by

Stock Commitments · sku_id

Read

SKUs

Every SKU of the shop’s products, one row each: its seller SKU, its price and its product. Its stock is in Stock.

Route: GET /skus

Excel formula: =LF.tiktokshop.skus("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`status`	enum	No	Only the products in this status. Empty: every status. Values: DRAFT, PENDING, FAILED, ACTIVATE, SELLER_DEACTIVATED
`seller_sku`	string	No	Only the products holding one of these seller SKUs, comma-separated (up to 10), as the seller spelled them.
`sku_id`	id	No	Only the products holding one of these SKU IDs, comma-separated (up to 10).
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`seller_sku` default	string	—	-
`product_title` default	string	—	-
`product_id` default	id	→ products	-
`currency` default	string	—	-
`tax_exclusive_price` default	string	—	-
`update_time` default	date	—	-

Edit

Set Price

Route: PATCH /mutation/skus

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`price.amount`	string	No	-
`price.currency`	string	No	-
`price.sale_price`	string	No	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Stock

The stock of each SKU in each warehouse: the quantity TikTok Shop can ship at once. A SKU is read here as the seller spells it.

Read

Stock

The stock of each SKU in each warehouse: the quantity TikTok Shop can ship at once. A SKU is read here as the seller spells it.

Route: GET /inventoryLevels

Excel formula: =LF.tiktokshop.inventoryLevels("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`warehouse_id`	id	No	Only the stock of this warehouse.
`status`	enum	No	Only the products in this status. Empty: every status. Values: DRAFT, PENDING, FAILED, ACTIVATE, SELLER_DEACTIVATED
`seller_sku`	string	No	Only the products holding one of these seller SKUs, comma-separated (up to 10), as the seller spelled them.
`sku_id`	id	No	Only the products holding one of these SKU IDs, comma-separated (up to 10).
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`seller_sku` default	string	—	-
`product_title` default	string	—	-
`warehouse_id` default	id	→ warehouses	-
`quantity` default	number	—	-
`update_time` default	date	—	-

Edit

Set Stock

Route: PATCH /mutation/inventoryLevels

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-
`quantity`	number	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Stock Commitments

What each SKU has available and what open orders hold of it, in all and by warehouse: read for named products or SKUs.

Read

Stock Commitments

What each SKU has available and what open orders hold of it, in all and by warehouse: read for named products or SKUs.

Route: GET /inventory

Excel formula: =LF.tiktokshop.inventory("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`product_id`	id	No	The products whose SKUs are read, comma-separated. This or SKU ID is required.
`sku_id`	id	No	The SKUs read, comma-separated. This or Product is required.
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`seller_sku` default	string	—	-
`product_id` default	id	→ products	-
`total_available_quantity` default	number	—	-
`total_committed_quantity` default	number	—	-
`warehouse_inventory`	string	—	-

Finance

Balance Movements

Every movement of the seller’s TikTok Shop balance: settlements, withdrawals, transfers, reversals.

Read

Balance Movements

Every movement of the seller’s TikTok Shop balance: settlements, withdrawals, transfers, reversals.

Route: GET /withdrawals

Excel formula: =LF.tiktokshop.withdrawals("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`types`	string	No	The movements read, comma-separated: WITHDRAW, SETTLE, TRANSFER, REVERSE, PAYMENT, REFUND. Default: WITHDRAW,SETTLE,TRANSFER,REVERSE
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`type` default	string	—	-
`amount` default	string	—	-
`currency` default	string	—	-
`status` default	string	—	-
`create_time` default	date	—	-

Order Settlement

How one order was settled, SKU by SKU: its revenue, TikTok Shop’s fees and taxes, shipping, what is paid.

Read

Order Settlement

How one order was settled, SKU by SKU: its revenue, TikTok Shop’s fees and taxes, shipping, what is paid.

Route: GET /orderTransactions

Excel formula: =LF.tiktokshop.orderTransactions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`order_id`	id	Yes	The order whose settlement is read.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`order_id` default	id	→ orders	-
`sku_id` default	string	—	-
`product_name` default	string	—	-
`quantity` default	string	—	-
`settlement_amount` default	string	—	-
`revenue_amount` default	string	—	-
`fee_tax_amount` default	string	—	-

Payments

What TikTok Shop paid out to the seller’s bank account: amount, exchange, status and when.

Read

Payments

What TikTok Shop paid out to the seller’s bank account: amount, exchange, status and when.

Route: GET /payments

Excel formula: =LF.tiktokshop.payments("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	string	—	-
`amount`	string	—	-
`value` default	string	—	-
`currency` default	string	—	-
`settlement_amount`	string	—	-
`value`	string	—	-
`currency`	string	—	-
`exchange_rate`	string	—	-
`bank_account`	string	—	-
`create_time` default	date	—	-
`paid_time`	date	—	-

Statement Transactions

What one statement settles, one transaction each: an order’s revenue, fees and shipping, a reserve, an adjustment.

Read

Statement Transactions

What one statement settles, one transaction each: an order’s revenue, fees and shipping, a reserve, an adjustment.

Route: GET /statementTransactions

Excel formula: =LF.tiktokshop.statementTransactions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`statement_id`	id	Yes	The statement whose transactions are read.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`statement_id` default	id	→ statements	-
`type` default	string	—	-
`order_id` default	id	→ orders	-
`settlement_amount` default	string	—	-
`revenue_amount` default	string	—	-
`fee_tax_amount` default	string	—	-

Statements

The statements TikTok Shop settles a shop by: revenue, fees, shipping, adjustments and what it pays.

Used as filter by

Statement Transactions · statement_id

Read

Statements

The statements TikTok Shop settles a shop by: revenue, fees, shipping, adjustments and what it pays.

Route: GET /statements

Excel formula: =LF.tiktokshop.statements("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`statement_from`	string	No	Statements generated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`statement_to`	string	No	Statements generated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`payment_status`	enum	No	Only the statements in this payment status. Values: PAID, FAILED, PROCESSING
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`statement_time` default	date	—	-
`currency` default	string	—	-
`settlement_amount` default	string	—	-
`revenue_amount` default	string	—	-
`fee_amount` default	string	—	-
`payment_status` default	string	—	-

Marketing

Deactivate Promotion

Ends this promotion now: its products go back to their usual price.

Create

Deactivate Promotion

Route: POST /mutation/promotionDeactivate

Inputs you can set

Name	Type	Required	Description
`activity_id`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Promotions

The promotion activities of a shop: flash sales, discounts, shipping discounts, their dates and status.

Read

Promotions

The promotion activities of a shop: flash sales, discounts, shipping discounts, their dates and status.

Route: GET /promotions

Excel formula: =LF.tiktokshop.promotions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`status`	enum	No	Only the activities in this status. Values: NOT_START, ONGOING, EXPIRED, DEACTIVATED
`activity_type`	enum	No	Values: FIXED_PRICE, DIRECT_DISCOUNT, FLASHSALE, SHIPPING_DISCOUNT, BUY_MORE_SAVE_MORE
`activity_title`	string	No	Only the activities whose title holds these words.
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`activity_type` default	string	—	-
`status` default	string	—	-
`begin_time` default	date	—	-
`end_time` default	date	—	-

Sales

Aftersale Eligibility

What the seller may still do on an order’s lines — cancel, refund, return — and the reasons TikTok Shop accepts for each.

Read

Aftersale Eligibility

What the seller may still do on an order’s lines — cancel, refund, return — and the reasons TikTok Shop accepts for each.

Route: GET /orderEligibility

Excel formula: =LF.tiktokshop.orderEligibility("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`orderId`	id	Yes	The order whose records are read.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`request_types`	enum	No	Only this kind of request. Empty: every kind. Values: CANCEL, REFUND, RETURN_AND_REFUND
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`orderId` default	id	→ orders	-
`sku_id` default	string	—	-
`request_type` default	string	—	-
`eligible` default	boolean	—	-
`available_reason_names` default	string	—	-

Cancel Order

Cancels this order, or the lines named, as the seller: TikTok Shop refunds what the buyer paid. Its reasons: Aftersale Eligibility.

Create

Cancel Order

Route: POST /mutation/orderCancel

Inputs you can set

Name	Type	Required	Description
`cancel_reason`	string	Yes	-
`order_line_item_ids`	string	No	-
`orderId`	id	Yes	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Mark Shipped

Records a shipment the seller made by itself, with its tracking number: the order’s lines named, or every line.

Create

Mark Shipped

Route: POST /mutation/orderMarkShipped

Inputs you can set

Name	Type	Required	Description
`order_line_item_ids`	string	No	-
`orderId`	id	Yes	-
`shipping_provider_id`	string	Yes	-
`shop_id`	id	No	-
`tracking_number`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Orders

The orders of a shop: status, payment, fulfillment, the buyer’s note and their lines — one line per unit sold.

Used as filter by

Cancellations · order_id

Aftersale Eligibility · orderId

Order Settlement · order_id

Returns · order_id

Read

Orders

The orders of a shop: status, payment, fulfillment, the buyer’s note and their lines — one line per unit sold.

Route: GET /orders

Excel formula: =LF.tiktokshop.orders("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`order_status`	enum	No	Only the orders in this status. Values: UNPAID, ON_HOLD, AWAITING_SHIPMENT, PARTIALLY_SHIPPING, AWAITING_COLLECTION
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`sort_field`	enum	No	The moment the orders are sorted on: creation (the default) or last change. Values: create_time, update_time
`sort_order`	enum	No	Oldest first, or latest first (the default). Values: ASC, DESC
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	string	—	-
`currency` default	string	—	-
`total_amount` default	string	—	-
`fulfillment_type` default	string	—	-
`create_time` default	date	—	-
`update_time` default	date	—	-

Packages

The packages of a shop’s orders: their status, tracking number and carrier, and the lines each holds.

Read

Packages

The packages of a shop’s orders: their status, tracking number and carrier, and the lines each holds.

Route: GET /packages

Excel formula: =LF.tiktokshop.packages("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is TikTok Shop’s refusal.
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`package_status`	enum	No	Values: TO_FULFILL, PROCESSING, FULFILLING, COMPLETED, CANCELLED
`updated_from`	string	No	Updated at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`updated_to`	string	No	Updated before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_from`	string	No	Created at or after this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`created_to`	string	No	Created before this moment (ISO 8601, 2026-01-31T00:00:00Z, or a Unix time in seconds).
`sort_order`	enum	No	Oldest first, or latest first. Values: ASC, DESC
`page_size`	number	No	Rows per page (max 50). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	string	—	-
`tracking_number` default	string	—	-
`shipping_provider_name` default	string	—	-
`shipping_provider_id`	string	—	-
`orders`	string	—	-
`order_line_item_ids`	string	—	-
`create_time`	date	—	-
`update_time` default	date	—	-
`can_ship`	boolean	—	-

Ship Package

Arranges this package’s shipment: TikTok Shop’s carrier picks it up or it is dropped off — or, shipped by the seller, its tracking.

Create

Ship Package

Route: POST /mutation/packageShip

Inputs you can set

Name	Type	Required	Description
`handover_method`	enum	No	Values: PICKUP, DROP_OFF
`package_id`	id	Yes	-
`self_shipment.shipping_provider_id`	string	No	-
`self_shipment.tracking_number`	string	No	-
`shop_id`	id	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Shop

Shops

The shops the seller authorized LinkyFlow on: a local seller has one, a cross-border seller one per market.

Used as filter by

Read

Shops

The shops the seller authorized LinkyFlow on: a local seller has one, a cross-border seller one per market.

Route: GET /shops

Excel formula: =LF.tiktokshop.shops("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`region` default	string	—	-
`seller_type` default	string	—	-
`code`	string	—	-

Warehouses

The warehouses of a shop: where its stock is held, and whether it sells from each.

Used as filter by

Stock · warehouse_id

Read

Warehouses

The warehouses of a shop: where its stock is held, and whether it sells from each.

Route: GET /warehouses

Excel formula: =LF.tiktokshop.warehouses("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`shop_id`	id	No	The shop to read or write, among those the seller authorized. Empty: the connection’s first shop.
`page_size`	number	No	Rows per page (max 100). Default: 50
`page_token`	string	No	The token the previous page answered (next_page_token): empty for the first page.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`effect_status` default	string	—	-
`type` default	string	—	-
`sub_type`	string	—	-
`is_default` default	boolean	—	-
`address`	string	—	-
`region_code`	string	—	-
`city`	string	—	-
`postal_code`	string	—	-

← PreviousTikTok Shop stock and orders Next →LinkyFlow for Shopify Partners

Field	Type	Relations	Description
`id` default	id	—	-
`local_name` default	string	—	-
`parent_id` default	string	→ categories	-
`is_leaf` default	boolean	—	-
`permission_statuses`	string	—	-

TikTok Shop connection for LinkyFlow

Workflows you can move into Excel

After-sales

Approve Cancellation

Approve Cancellation

Inputs you can set

Data returned in Excel

Approve Return

Approve Return

Inputs you can set

Data returned in Excel

Cancellations

Cancellations

Inputs you can set

Data returned in Excel

Reject Cancellation

Reject Cancellation

Inputs you can set

Data returned in Excel

Reject Reasons

Reject Reasons

Inputs you can set

Data returned in Excel

Reject Return

Reject Return

Inputs you can set

Data returned in Excel

Returns

Returns

Inputs you can set

Data returned in Excel

Analytics

Product Performance

Product Performance

Inputs you can set

Data returned in Excel

Catalog

Activate Product

Activate Product

Inputs you can set

Data returned in Excel

Brands

Brands

Inputs you can set

Data returned in Excel

Categories

Categories

Inputs you can set

Data returned in Excel

Deactivate Product

Deactivate Product

Inputs you can set

Data returned in Excel

Products

Products

Inputs you can set

Data returned in Excel

SKUs

SKUs

Inputs you can set

Data returned in Excel

Set Price

Inputs you can set

Data returned in Excel

Stock

Stock

Inputs you can set

Data returned in Excel

Set Stock

Inputs you can set

Data returned in Excel

Stock Commitments

Stock Commitments

Inputs you can set

Data returned in Excel

Finance

Balance Movements

Balance Movements

Inputs you can set

Data returned in Excel