Endpoints: สินค้าและออเดอร์

Fetches canonical products with their current Shopee binding data. Returns one row per (canonical, binding) pair—canonicals with multiple Shopee listings produce multiple results. Useful for Shopee-keyed product lookups and reconciliation workflows.

Request body

Array of CanonicalProductWithShopeeBindingSearchParams — filter by canonical id, name, SKU, model SKU, or by Shopee item/model/shop id and region.

Response — Array of CanonicalProductWithShopeeBindingView

List of canonical products with their Shopee binding details (price, stock, margin, images). Each canonical can appear multiple times if it has multiple Shopee bindings.

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

Fetches canonical products and attaches ALL platform bindings (Shopee, Lazada, TikTok) in a platforms array. One row per canonical, regardless of how many platforms it's bound to. Used for neutral, multi-platform product lists.

Request body

Array of CanonicalProductSearchParams — filter by canonical id, name, SKU, model SKU, or by platform and platform shop id.

Response — Array of CanonicalProductWithPlatforms

List of canonical products, each carrying margin distribution stats and a platforms array of all bound marketplace items.

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

Cursor-paginated canonical product list with the same platform-bindings metadata as the non-paginated variant. Pass the returned nextCursor.canonicalId back as cursorCanonicalId for the next page. Supports optional platform/shop scoping.

Request body

CanonicalProductPaginatedFetchRequest

Response — CursorPaginatedResult<CanonicalProductCursor, CanonicalProductWithPlatforms>

Offset-based pagination (page number + size) over canonical products with platform bindings. Supports sorting (name, SKU, COGS, stock) and per-column filters. Preferred for UI product tables that need page numbers and sort controls.

Request body

CanonicalProductPaginatedV2FetchRequest

Response — OffsetPaginatedResult<CanonicalProductWithPlatforms>

Computes margin distribution (min, max, median, quartiles) over the filtered canonical product set. Uses the same filters as the paginated fetch; pagination parameters are ignored. Products with no margined binding are excluded.

Request body

CanonicalProductPaginatedV2FetchRequest — only the filter/platform/platformShopId fields are used.

Response — ProductMarginStats

Reads the detailed per-component cost breakdown (manufacturing, labor, shipping, packaging) and VAT-inclusivity flags for one or more canonical variants. Backs the product Cost Breakdown editor.

Request body

Array of integer — canonical variant ids.

Response — Array of CanonicalProductCostRow

Searches canonical products by name, SKU, model SKU, and (if numeric) platform item ids using trigram similarity. Results are ranked by relevance and hard-capped at 50 hits. Optional platform/shop filters narrow results.

Request body

CanonicalProductSearchRequest

Response — Array of CanonicalProductSearchHit

Top-50 results ranked by relevance.

Checks whether any canonical product variant has COGS set for a given Shopee shop. Used to gate features (like the financial breakdown) until the seller has populated cost data.

Query parameters

Response — HasCogsResponse

Checks whether any canonical product variant has COGS set for a given Lazada seller.

Query parameters

Response — HasCogsResponse

Checks whether any canonical product variant has COGS set for a given TikTok shop.

Query parameters

Response — HasCogsResponse

Cursor-paginated list of orders across all the user's shops on every connected platform (Shopee, Lazada, TikTok). Returns order id, platform, status, buyer-paid total, and timestamps. Pass the returned nextCursor.canonicalOrderId back as cursorCanonicalOrderId for the next page.

Request body

CanonicalOrderPaginatedFetchRequest

Response — CursorPaginatedResult<CanonicalOrderCursor, CanonicalOrder>

Fetches one complete order with all line items, quantities, prices, and fees — including the per-line and order-level financial breakdown (revenue, COGS, profit, margin).

Path parameters

Response — CanonicalOrder

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

Counts total orders across all the user's shops for an optional platform and date range. Returns a single integer. Useful for dashboards, health checks, and sync progress.

Query parameters

Response — integer — total order count matching the filters.

Counts orders awaiting shipment over a rolling recent window — a real-time fulfillment backlog indicator.

Query parameters

Response — integer — count of orders in pending-shipment status in the last N days.

Fetches the latest computed reorder policies for all SKUs: when to reorder and how much, with reorder point, order-now quantity, and order-by date.

Response — Array of InventoryReorderPolicyDto

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

Fetches the demand forecast for one or all canonical products over the planning horizon. Returns forecast rows with predictive bands (q10/q90), expected-demand center line (q50), credible band (muQ10/muQ90), and a trailing-week baseline (ma8) for charting.

Query parameters

Response — InventoryForecastResponseDto

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

Fetches realized weekly demand history and the latest forecast (with all confidence bands) in one call, ready for plotting. Partial in-progress weeks are flagged.

Query parameters

Response — InventoryDemandChartDto

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

Fetches inventory settings: lead time, service target, MOQ/lot size, capital budget, alert toggles, plus any per-variant reorder-point overrides.

Response — Array of InventoryPolicyParamsDto

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

Fetches live and resolved inventory alerts. An alert fires when stock reaches the reorder point and auto-resolves once stock recovers.

Query parameters

Response — Array of InventoryAlertDto

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

Fetches purchase orders the merchant has logged as in flight. Open orders feed the next model run as pipeline arrivals and count into the position checked by alerts.

Query parameters

Response — Array of InventoryOpenOrderDto

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

A user-wide realized-profit overview rolled up across ALL your shops (Shopee + TikTok + Lazada) over a lookback window. Returns total profit, revenue-weighted average margin, top/worst products, the cost-breakdown P&L waterfall, and per-platform subtotals. The optional body tunes the window, top-N, and VAT treatment.

Request body

UnifiedFinancialOverviewFetchRequest (optional)

Response — UnifiedUserFinancialOverview

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

Fetches all Shopee shops connected to your account. Call this first to discover which shops you own — most shop-scoped endpoints need a shopId from here.

Response — Array of ShopeeShop

Fetches authorization status for each Shopee (shop, app-type) grant. A non-null deauthorizedAt means the grant is revoked/expired and needs re-auth — handy for diagnosing why a shop's orders or ads data is missing.

Response — Array of ShopeeAccountEntry

Compares empirical commission rates (computed from order data) against the rates declared in Shopee Seller Centre — useful for auditing when displayed and calculated rates diverge.

Query parameters

Response — ShopeeCommissionRateCheckResult

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

Fetches shop profile details (name, logo, description) from Shopee.

Query parameters

Response — ShopeeShopProfile

Fetches all Lazada sellers (accounts) connected to your account. Call this first to discover which Lazada accounts you own — seller-scoped endpoints need the sellerId from here.

Response — Array of LazadaShop

Fetches all TikTok Shops connected to your account. TikTok shop ids are 19-digit numbers larger than JavaScript's safe-integer max — treat them as opaque strings end-to-end.

Response — Array of TikTokShopResponse