Preview Cost Line Type Impact

POST 
/api/shipstation/integration-instances/:integrationInstance/cost-line-type/preview

Preview how many ShipStation 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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Request body:

• new_type_id (optional, int|null): Proposed cost financial line type id. null = auto default. Must exist.

Drives the confirmation modal before saving the setting.

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

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.