Get Supplier Summary
POST/api/inventory-forecasting/suppliers/summary
Product counts per supplier for the forecast's supplier tabs, before the full build. The count is the number of products the build will list for that supplier.
purchase-orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Body
supplier_ids(required)product_filters— the build's product filters (filter_groups + flagshas_moq,has_leadtime,supplier_in_stock,has_sales_history).forecast_type—fill_backorderscounts backordered products only (the flags don't apply to it).sales_history_daysorsales_start_date+sales_end_date— the build's sales window (default: last 30 days).sales_filters,destination_warehouse_id— the build's sales filters and warehouse.
Send the same window, sales filters and warehouse as the build: period-scoped product filters and Has sales (has_sales_history — only products with sales in the window, units sold inside kits counting for their components) depend on them, and the counts then match the rows the build shows.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.