VendorBulk Import
Download Sample CSV Template
Download Sample CSV Template — vendor REST API endpoint.
GET
/vendor/products/import/sample-templateVendor bearer token requiredDownload Sample CSV Template
Download the CSV template for bulk product import.
What this means in plain English
Returns a CSV file with the expected column headers for bulk product import.
When to use this
- Preparing a catalog CSV for upload.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Vendor-Id | string (UUID) | Yes | UUID of the vendor context. Required for vendor-scoped endpoints when your account has multiple vendor memberships. Use the vendor.id from the login response. |
Request example
curl -X GET 'http://localhost:8080/api/v1/vendor/products/import/sample-template' \
-H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010'Response examples
200Success
CSV file download (text/csv)Status codes
200
OK
Request succeeded.
401
Unauthorized
Missing or invalid bearer token.
403
Forbidden
Insufficient permissions for this action.
400
Bad Request
Validation failed or invalid parameters.
404
Not Found
Resource not found.
500
Internal Server Error
Unexpected server error.
403
Forbidden
Invalid X-Vendor-Id, no vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).
Response is a CSV file attachment, not JSON.
Try it
Edit values below to generate a cURL command. This endpoint requires multipart upload — run in your terminal.
Copy-only
Multipart and file-download endpoints cannot be executed from the browser panel. Copy the cURL command and run it in your terminal.