Endpoints: financial breakdown

Computes financial breakdowns for a list of specific product model IDs. Each model gets a detailed profit analysis — revenue, costs, fees, and net profit. Use this for bulk variant analysis or to compare profitability across models within a product. True profit nets out platform fees, commission, ads cost, and COGS.

Request body

ShopeeGetModelBreakdownsByModelIdsDto

Response — Array of ShopeeModelBreakdownFlatEntry

One entry per model: item/model id, original price, the full cost breakdown, metadata (rates, VAT, inferred COGS, profit), and product-level aggregates.

…and more — see the full schema in the OpenAPI spec.

Analyzes one product's profit across all variants (models): aggregates revenue and costs across models sold in the lookback window, then returns a single per-unit profit breakdown — gross revenue, platform fees, commission, VAT, COGS, ads spend, and net margin.

Request body

ShopeeGetUnitFinancialBreakdownDto

Response — ShopeeFinancialBreakdown

A signed, line-by-line itemization (positive = revenue, negative = cost); summing all lines yields net profit per unit.

…and more — see the full schema in the OpenAPI spec.

Estimates profit for a product before listing. Supply price, category, COGS, and VAT mode and get the projected margin given your cost structure and the platform's fee schedule — useful for pricing strategy.

Request body

ShopeeGetNewProductFinancialBreakdownDto

Response — ShopeeFinancialBreakdownWithMetadata

Reverse-calculates the listing price needed to hit a target profit (or margin) given COGS and a discount strategy, after all platform fees. Use before listing or repricing.

Request body

ShopeeComputeRequiredPriceDto

Response — ShopeeRequiredPriceResult

Projects the profit impact of changing a product's price, discount, or seller-funded promotions before applying them. Input proposed values and see the resulting margin and profit per unit. Does NOT change anything on Shopee.

Request body

ShopeeProfitImpactSimulationDto — shopId, region, itemId required; the rest are optional overrides.

Response — ShopeeFinancialBreakdownWithMetadata — the simulated breakdown and resulting margin/profit.

Fetches the realized financial breakdown for a product, aggregating actual sales and costs across all variants in the lookback window (based on real sales data, not hypothetical pricing).

Path parameters

Request body

ShopeeItemFinancialBreakdownFetchRequest (optional — defaults applied if omitted)

Response — ShopeeFinancialBreakdownWithMetadata — per-unit breakdown aggregated across models, plus per-model entries.

Per-product breakdowns for the entire shop, cursor-paginated. Each product's breakdown is aggregated across its variants from actual sales. Use for dashboard tables ranking profitability.

Path parameters

Request body

ShopeeProductLevelFinancialBreakdownFetchRequest (optional)

Response — CursorPaginatedResult<RtShopeeProductCursor, ShopeeProductFinancialBreakdownEntry>

Computes ROAS adjusted for actual profit (not just GMV), accounting for COGS, fees, and discounts — i.e. true profitability per ad dollar. Returns three frames: raw (as Shopee reports), cleaned, and deflated.

Path parameters

Request body

ShopeeProductProfitAdjustedRoasFetchRequest (optional)

Response — ShopeeProductProfitAdjustedRoasSummary

…and more — see the full schema in the OpenAPI spec.

Like the profit-adjusted ROAS endpoint, but applies ad-cancellation dedup: it distinguishes chain-rebuy cancels from solo cancels and returns three confidence levels — raw, cleaned (chain-rebuys removed), and deflated (net settled) — so you see true ad effectiveness after cancellations.

Path parameters

Request body

ShopeeProductProfitAdjustedRoasFetchRequest (optional) — same fields as above.

Response — ShopeeProductProfitAdjustedRoasSummary

…and more — see the full schema in the OpenAPI spec.

Shop-level ad ROAS corrected for ad-cancellation dedup but without the profit-margin adjustment (based on GMV after fees, not after COGS). One entry per requested item — useful when COGS data is incomplete.

Path parameters

Request body

ShopeeCorrectedRoasFetchRequest

Response — Array of ShopeeProductAdsCorrectedSummary

…and more — see the full schema in the OpenAPI spec.

Ranks all shop products by realized profit (highest first) over the lookback window — for spotting top earners and loss-makers. Offset-paginated.

Path parameters

Request body

ShopeeSortedProductBreakdownFetchRequest (optional)

Response — OffsetPaginatedResult<ShopeeProductProfitSortedEntry> — products ranked by total profit, with page metadata and dataFreshAt.

Ranks all shop products by profit-adjusted ROAS (highest first) — which products deliver the best return on ad spend, after real margins.

Path parameters

Request body

ShopeeSortedProductBreakdownFetchRequest (optional) — same fields as sorted-by-profit.

Response — OffsetPaginatedResult<ShopeeProductProfitAdjustedRoasSummary> — products ranked by profit-adjusted ROAS, with page metadata.

A comprehensive shop-level profit overview in one payload: total profit, average margin, top/worst products, cost breakdown, channel split (organic/ads/affiliate), margin distribution, and a money-flow Sankey. For better performance, prefer the focused sub-endpoints below.

Path parameters

Request body

ShopeeShopFinancialOverviewFetchRequest (optional)

Response — ShopeeShopFinancialOverview

…and more — see the full schema in the OpenAPI spec.

The headline slice of the shop overview: total profit, average margin, COGS coverage, and period-over-period comparison. Lightweight — ideal for dashboard tiles. Same path params and body as the full overview.

Path parameters

Request body — ShopeeShopFinancialOverviewFetchRequest (optional; same as the full overview).

Response — ShopeeShopOverviewSummary

The four ranked product lists from the overview (top/worst × profit/margin). Same path params and body as the full overview.

Path parameters

Request body — ShopeeShopFinancialOverviewFetchRequest (optional).

Response — ShopeeShopOverviewProducts

The cost-breakdown P&L waterfall, costs-only pie, and most-profitable categories. Same path params and body as the full overview.

Path parameters

Request body — ShopeeShopFinancialOverviewFetchRequest (optional).

Response — ShopeeShopOverviewBreakdowns

The channel breakdown (organic/ads/affiliate) and the money-flow Sankey showing how gross revenue flows through costs to net profit. Same path params and body as the full overview.

Path parameters

Request body — ShopeeShopFinancialOverviewFetchRequest (optional).

Response — ShopeeShopOverviewFlow

The per-product margin box-and-whisker distribution — the spread of profitability across your catalog. Same path params and body as the full overview.

Path parameters

Request body — ShopeeShopFinancialOverviewFetchRequest (optional).

Response — ShopeeShopOverviewDistribution

Estimates the profit impact of an upcoming commission-rate change, broken down by category with the most-affected products. Use when Shopee announces a commission change to assess the financial risk.

Path parameters

Request body

ShopeeCommissionImpactSummaryFetchRequest

Response — ShopeeCommissionImpactSummary

…and more — see the full schema in the OpenAPI spec.

Summarizes current commission rates and their impact across product categories — commission as a percentage of revenue, with top-commission products. Use to audit current commission exposure.

Path parameters

Request body

ShopeeCommissionOverviewFetchRequest (optional)

Response — ShopeeCommissionOverview

…and more — see the full schema in the OpenAPI spec.

Calculates the seller discount and voucher needed to hit a target margin (or fixed profit) on one or more models. A preview only — it does not apply anything. Backs the margin-tool UI.

Request body

ShopeeSetMarginDto

Response — ShopeeSetMarginResult

…and more — see the full schema in the OpenAPI spec.

Calculates the seller discount and voucher needed to achieve a target final buyer price (what the customer pays after discounts). A preview only. Useful for campaign planning.

Request body

ShopeeSetBuyerPriceDto

Response — ShopeeSetMarginResult — adjustedItems (discount/voucher + resulting margin + simulated breakdown) and unadjustableItems (infeasible targets, with reason).

Returns per-SKU financial breakdowns for a hand-picked set of SKU IDs — for bulk-pricing tools analyzing profitability across specific variants. Each entry includes commission, payment fees, and any LazCoins deductions.

Request body

LazadaGetSkuBreakdownsBySkuIdsDto

Response — Array of LazadaSkuBreakdownFlatEntry — SKU id, seller SKU, original price, and a full breakdown (revenue, commission, payment, LazCoins, COGS, VAT, net margin). …and more — see the full schema in the OpenAPI spec.

Computes the breakdown for one product or SKU. With skuId null, returns the volume-weighted aggregate across all SKUs; with skuId set, the single-variant breakdown. Backs the product profit screen.

Request body

LazadaGetUnitFinancialBreakdownDto

Response — LazadaFinancialBreakdownWithMetadata — the line-by-line breakdown (original price, special-price discount, voucher, commission, payment fee, COGS, VAT, return cost, LazCoins, free-shipping commission), metadata (margin, revenue, COGS status), and per-SKU detail when product-level.

Previews the breakdown for a product before listing — supply price, category, and optional COGS without an existing record. Useful during the product-creation wizard.

Request body

LazadaGetNewProductFinancialBreakdownDto

Response — LazadaFinancialBreakdownWithMetadata — the full breakdown at the proposed price (commission resolved from category, payment fee, VAT, profit margin).

Solves for the listing price needed to achieve a target margin given COGS and any planned discounts, after all fees and VAT.

Request body

LazadaComputeRequiredPriceDto

Response — LazadaRequiredPriceResult — the requiredListingPrice and a full breakdown at that price.

Applies overrides (price, discount, COGS, commission rate, return cost, free-shipping enrollment, LazCoins settings) to the baseline breakdown and recomputes margin and profit. Backs the what-if simulator.

Request body

LazadaProfitImpactSimulationDto — sellerId, region, itemId required; the rest are optional overrides (e.g. skuId, originalPrice, specialPriceDiscount, sellerVoucher, manufacturingCogs, commissionRate, returnCostPerSale, isInFreeShipping, effectiveDate).

Response — LazadaFinancialBreakdownWithMetadata — the recomputed breakdown at the simulated parameters.

Aggregates the breakdown across all SKUs for a product, returning volume-weighted metrics.

Path parameters

Request body

LazadaItemFinancialBreakdownFetchRequest (optional)

Response — LazadaFinancialBreakdownWithMetadata — the product-level breakdown with volume-weighted fees, margin, and per-SKU detail.

Per-product breakdowns for the whole shop, cursor-paginated; each shows volume-weighted metrics across its SKUs.

Path parameters

Request body

LazadaProductLevelFinancialBreakdownFetchRequest (optional)

Response — CursorPaginatedResult<RtLazadaProductCursor, LazadaProductFinancialBreakdownEntry> — product entries (id, name, aggregated breakdown) plus the pagination cursor.

Returns per-SKU breakdowns for every SKU in the shop — a flat list keyed by (itemId, skuId). Intended for offline bulk analysis (not paginated).

Path parameters

Request body

LazadaAllSkuBreakdownsFetchRequest (optional) — sellerType, hasVat, effectiveDate.

Response — Array of LazadaSkuBreakdownFlatEntry — every shop SKU with its breakdown, original price, and metadata.

Returns profit-adjusted ROAS with raw ad attribution. Not yet active — pending the Lazada hidden-cost pipeline.

Path parameters

Request body

LazadaProductProfitAdjustedRoasFetchRequest (optional) — sellerType, hasVat, lookbackDays (default 180), effectiveDate.

Response — LazadaProductProfitAdjustedRoasSummary — RAW frame (ad attribution, profit per ad order, profit-adjusted ROAS, true GMV) and per-SKU details; cleaned/deflated frames null until the pipeline lands.

Cancellation-deduped profit-adjusted ROAS (raw/cleaned/deflated frames). Not yet active — pending the Lazada hidden-cost pipeline.

Path parameters

Request body

LazadaProductProfitAdjustedRoasFetchRequest (optional) — same fields as above.

Response — LazadaProductProfitAdjustedRoasSummary — RAW, CLEANED, and DEFLATED frames once available (invariant RAW ≥ CLEANED ≥ DEFLATED).

Per-item corrected ROAS with ad-cancellation dedup, excluding COGS. Not yet active — pending the Lazada cleaned-ads summary pipeline.

Path parameters

Request body

LazadaCorrectedRoasFetchRequest

Response — Array of LazadaProductAdsCorrectedSummary — per-item ad metrics with dedup applied (empty pending pipeline).

All shop products sorted by true profit (descending), offset-paginated — for spotting top earners and loss-makers.

Path parameters

Request body

LazadaSortedProductBreakdownFetchRequest (optional)

Response — OffsetPaginatedResult<LazadaProductProfitSortedEntry> — products ranked by profit (id, name, true profit, breakdown) with page metadata.

Products ranked by profit-adjusted ROAS (descending). Not yet active — pending the Lazada ROAS pipeline.

Path parameters

Request body

LazadaSortedProductBreakdownFetchRequest (optional) — same fields as sorted-by-profit.

Response — OffsetPaginatedResult<LazadaProductProfitAdjustedRoasSummary> — products ranked by profit-adjusted ROAS (currently not populated).

Computes the seller-funded discount/voucher needed to hit a target margin for specified SKUs. A preview only.

Request body

LazadaSetMarginDto

Response — LazadaSetMarginResult — adjustedItems (required discount + simulated breakdown) and unadjustableItems (with typed reasons like unreachable_margin, sku_not_found).

Computes the seller-funded discount so the buyer pays exactly a target price — the price-anchored inverse of preview-set-margin.

Request body

LazadaSetBuyerPriceDto

Response — LazadaSetMarginResult — adjustable SKUs (discount + simulated breakdown) and unadjustable SKUs with reasons. COGS is optional and affects displayed profit only.

A shop-wide forward-profit overview: total profit, average margin, cost breakdown, top/worst products, top products by margin, and category breakdown.

Path parameters

Request body

LazadaShopFinancialOverviewFetchRequest (optional)

Response — LazadaShopFinancialOverview — total profit, revenue, COGS coverage, cost-breakdown waterfall, top/worst products, category breakdown, margin distribution, prior-period comparison, and optional VAT position.

Computes the breakdown for one TikTok product or SKU. With skuId null, returns the volume-weighted aggregate across all SKUs; with skuId set, the single-variant breakdown.

Request body

TikTokGetUnitFinancialBreakdownDto

Response — TikTokFinancialBreakdownWithMetadata — original price, seller discount, commission, platform fee (CGF), COGS, VAT, return cost, net margin, metadata, and per-SKU detail at product level.

Returns the volume-weighted aggregated breakdown for a product (always cross-SKU). Mirror of the Shopee/Lazada product-level surface.

Request body

TikTokGetUnitFinancialBreakdownDto — shopId, productId required; skuId is ignored (always cross-SKU). Same optional fields as the product endpoint.

Response — TikTokFinancialBreakdownWithMetadata — aggregated fees, margin, and per-SKU detail breakdown.

Returns per-SKU breakdowns for a hand-picked set of SKU IDs — for bulk-pricing tools.

Request body

TikTokGetSkuBreakdownsBySkuIdsDto

Response — Array of TikTokSkuBreakdownFlatEntry — product id, SKU id, original price, and a full breakdown (commission, CGF fee, COGS, VAT, net margin). …and more — see the full schema in the OpenAPI spec.

Previews the breakdown for a product before listing — supply price, category path, and optional COGS without an existing record.

Request body

TikTokGetNewProductFinancialBreakdownDto

Response — TikTokFinancialBreakdownWithMetadata — the full breakdown at the proposed price (commission resolved from category, CGF fee, VAT, profit margin).

Applies overrides (price, discount, COGS, flags, ads cost, return cost) to the baseline breakdown and recomputes margin and profit.

Request body

TikTokProfitImpactSimulationDto — shopId, productId required; the rest are optional overrides (skuId, originalPrice, sellerDiscount, sellerVoucher, platformDiscount, manufacturingCogs, adsCostPerSale, returnCostPerSale, flags, effectiveDate).

Response — TikTokFinancialBreakdownWithMetadata — the recomputed breakdown at the simulated parameters.

Solves for the listing price needed to achieve a target margin given COGS, category, and any planned discounts.

Request body

TikTokComputeRequiredPriceDto

Response — TikTokRequiredPriceResult — the requiredListingPrice and a full breakdown at that price.

Returns breakdowns for a list of products; each shows volume-weighted metrics across its SKUs. Per-product failures are isolated (one bad productId doesn't abort the rest).

Request body

TikTokGetBatchProductLevelBreakdownDto

Response — Array of TikTokProductFinancialBreakdownEntry (omitting failed lookups) — product id, title, aggregated breakdown.

Computes the seller-funded discount needed to hit a target margin for specified SKUs. A preview only. Note: computedSellerVoucher is always 0 (TikTok coupons aren't API-creatable).

Request body

TikTokSetMarginDto

Response — TikTokSetMarginResult — adjustedItems (required discount + simulated breakdown) and unadjustableItems (with typed reasons).

Computes the seller-funded discount so the buyer pays exactly a target price — the price-anchored inverse of preview-set-margin.

Request body

TikTokSetBuyerPriceDto

Response — TikTokSetMarginResult — adjustable SKUs (discount + simulated breakdown) and unadjustable SKUs with reasons.

A shop-wide profit overview computed from settled-statement data: total profit, average margin, cost breakdown, top/worst products, top products by margin, and category breakdown.

Path parameters

Request body

TikTokShopFinancialOverviewFetchRequest (optional)

Response — TikTokShopFinancialOverview — total profit, revenue, COGS coverage, cost-breakdown waterfall, top/worst products, category breakdown, margin distribution, prior-period comparison, and optional VAT position.