Generate Landed Cost Breakdown Report

POST 
/api/reporting/landed-cost-breakdown

Dispatch a filtered, hierarchically-grouped report (brand > product) restricted to a specific sales channel and warehouse. Returns a tracked_job_log_id; fetch the payload from the result endpoint once the job completes.

Required scope: reports:write

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

Demonstrates hierarchical grouping combined with filtering — useful for drilling into specific segments of the business.

Request

Responses

200

Successful response

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.