Preview Cost Line Type Impact
POST/api/trackstar/integration-instances/:integrationInstance/cost-line-type/preview
Preview how many Trackstar cost financial lines and sales orders would be touched if the fulfillment-cost financial line type changed to new_type_id. Read-only. Requires Bearer token.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Request body:
- new_type_id (optional, int|null): Proposed cost financial line type id. null = auto default. Must exist.
backfill_lines counts Trackstar fulfillments whose stored payload carries shipping_cost but have no line yet.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.