Skip to main content

List Inventory Comparison

GET 

/api/tiktok-shop/integration-instances/:integration_instance_id/inventory

Paginated inventory comparison for this connection — one row per SKU × TikTok warehouse. Each row pairs the SKU.io computed available quantity (sku_quantity) with the last-observed TikTok quantity (sales_channel_quantity) and derives a status:

  • needs_recalc — the cache is flagged for recomputation (is_sku_recalculation_needed).
  • synced — computed quantity equals the channel quantity (null treated as 0; negatives clamp-aware when negative inventory is disallowed).
  • variance — the two differ (see variance = sku_quantity - sales_channel_quantity).
  • not_managed — SKU.io is not the master of stock for this warehouse, so its inventory is neither computed nor pushed; the row is excluded from the in-sync / variance / needs-recalc counts.

Filters: filter[search] (listing SKU / title / product SKU / offering name / offering SKU), filter[status] (synced|variance|needs_recalc; is / is_one_of / is_not), filter[location_id] (local warehouse PK; is / is_one_of), filter[sku_quantity] & filter[sales_channel_quantity] (numeric operators), filter[sales_channel_quantity_updated_at] & filter[sales_channel_quantity_synced_at] (datetime operators), filter[listing_sku], filter[title].

Sorts (prefix - for DESC; default -id): id, sku_quantity, sales_channel_quantity, created_at, updated_at.

Pagination: page, per_page (default 10). Requires a Bearer token.

Request

Responses

OK

Response Headers
    Content-Type