Search SKU COGS Health

POST 
/api/cogs/sku-health

Returns the same paginated per-SKU COGS health table as the GET version of this endpoint, but accepts its parameters in a JSON request body. Each row aggregates a product's cost-of-goods statistics (min, max, median, average, and percentage variation) across its active FIFO cost layers, alongside current inventory totals.

Required scope: inventory:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Unlike the other advanced list endpoints, this one does not accept a filter_groups tree. It reads a small, fixed set of fields:

• search: matches against SKU or product name.
• variation_min / variation_max: bound the COGS variation percentage.
• sort_by: column to sort by (defaults to sku).
• sort_direction: asc or desc (defaults to asc).
• page / per_page: pagination (per_page defaults to 50).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

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.

429

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.