Preview Warehouse Import
POST/api/warehouses/import/preview
Parses an uploaded CSV file and returns a preview before importing: parsed records, detected file headers, the list of importable fields, unmatched columns (difference), missing required columns (required_difference) and columns that cannot be imported (not_importable).
warehouses:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Required fields: original_name (the file's original name), stored_name (the stored upload reference returned by the file upload). Optional: mapping (array of {file_field, expected_field} pairs to map CSV columns to warehouse fields), separator, escape, meta, task_id.
Authentication: Requires Bearer token.
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.