Skip to main content

Submit Inbound Plan

POST 
/api/tiktok-shop/:integrationInstance/fbt/inbound-plans/:plan/submit

Send a draft inbound plan to TikTok.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body

  • inbound_type (string, optional, nullable) — CARTON_SPLITTING or UNIT_SPLITTING. A last-mile override of the plan's splitting mode, applied before the plan is sent.

Submission is idempotent on the plan's own reference, so retrying after an unknown outcome adopts the plan already created at TikTok rather than minting a duplicate.

Before anything is sent, the persisted plan is checked and any failure is returned as 422 against a real field path:

  • at least one line — reported on lines
  • a resolved source, warehouse or supplier — reported on source_warehouse_id
  • at least 10 units per SKU, TikTok's per-SKU inbound minimum — reported on lines.{index}.quantity
  • carton conservation, every unit on a line packed exactly once — reported on lines.{index}.cartons. Mandatory for CARTON_SPLITTING; for UNIT_SPLITTING it is checked only once cartons exist, since those plans may declare cartons at ship time
  • a CARTON_SPLITTING plan must declare cartons at all — reported on cartons

A refusal from TikTok comes back as 422 (or 409 when the plan's state is the problem) with a written explanation in message.

The plan must belong to the integration instance in the path; a plan owned by another instance answers 404.

Requires the integrations.update permission.

Request​

Responses​

OK

Response Headers
    Content-Type