Bulk product importBulk product importUpload, preview, approve and roll back a bulk product import. Start a bulk product importCreates an import and returns a time-limited upload URL. Upload your CSV or Excel file to that URL with an HTTP PUT, then call the stage route. A workspace can have one active import at a time; starting another while one is unfinished is refused. Needs a read-write API key.Stage an uploaded fileReads the uploaded file and checks every row in the background. Call it once the upload has finished, then poll the status route until the import reaches `PREVIEW`. Needs a read-write API key.Cancel an importAbandons an import that has not started committing — uploaded, staging or in preview — so the workspace can start another one. The import moves to `FAILED` with the reason `Cancelled by user`. An import that is committing or completed cannot be cancelled; roll a completed import back instead. Needs a read-write API key.Preview what an import will doReturns the counts, a sample of failing rows and a sample of the rows that will be written. Review it before approving. Available once the import is in `PREVIEW`.Approve an importApproves a previewed import and starts writing the products in the background. Poll the status route until it reaches `COMPLETED`. Rows that failed validation are left out. Needs a read-write API key.Roll back an importRemoves the products an import created. Products the import only updated are left as the import wrote them and are counted in `notRevertedCount`. Needs a read-write API key.Get an importReturns the import and its progress counts. Poll it while the import is staging or being written.
Start a bulk product importCreates an import and returns a time-limited upload URL. Upload your CSV or Excel file to that URL with an HTTP PUT, then call the stage route. A workspace can have one active import at a time; starting another while one is unfinished is refused. Needs a read-write API key.
Stage an uploaded fileReads the uploaded file and checks every row in the background. Call it once the upload has finished, then poll the status route until the import reaches `PREVIEW`. Needs a read-write API key.
Cancel an importAbandons an import that has not started committing — uploaded, staging or in preview — so the workspace can start another one. The import moves to `FAILED` with the reason `Cancelled by user`. An import that is committing or completed cannot be cancelled; roll a completed import back instead. Needs a read-write API key.
Preview what an import will doReturns the counts, a sample of failing rows and a sample of the rows that will be written. Review it before approving. Available once the import is in `PREVIEW`.
Approve an importApproves a previewed import and starts writing the products in the background. Poll the status route until it reaches `COMPLETED`. Rows that failed validation are left out. Needs a read-write API key.
Roll back an importRemoves the products an import created. Products the import only updated are left as the import wrote them and are counted in `notRevertedCount`. Needs a read-write API key.
Get an importReturns the import and its progress counts. Poll it while the import is staging or being written.