Cancel an import
POST/api/service/products/bulk/:importId/cancel
Abandons 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.
Request
Responses
- 201
- 400
- 401
- 403
- 429
The import is cancelled.
Response Headers
Requests per minute this API key is allowed.
Requests left in the current one-minute window.
Seconds until the current window ends and the count resets.
Identifier of this request. Send your own x-request-id to have it echoed back; otherwise one is generated. Quote it when contacting support.
The import id is unknown, or the import has already started committing or completed.
Response Headers
Requests per minute this API key is allowed.
Requests left in the current one-minute window.
Seconds until the current window ends and the count resets.
Identifier of this request. Send your own x-request-id to have it echoed back; otherwise one is generated. Quote it when contacting support.
The API key is missing, malformed, revoked or expired, the user who created the key is no longer active, the request comes from an address the key does not allow, or the key is read-only and the route writes. The rate-limit headers are not sent.
Response Headers
Identifier of this request. Send your own x-request-id to have it echoed back; otherwise one is generated. Quote it when contacting support.
The key is valid but not allowed to do this: the workspace's plan does not include API access, or the user who created the key lacks the permission this route needs. The rate-limit headers are not sent when the plan is the reason.
Response Headers
Identifier of this request. Send your own x-request-id to have it echoed back; otherwise one is generated. Quote it when contacting support.
The API key exceeded its requests-per-minute limit; wait Retry-After seconds. A 429 can also come from the separate per-address limit (600 requests a minute), which sends X-RateLimit-* headers instead of the X-ApiKey-RateLimit-* ones.
Response Headers
Requests per minute this API key is allowed.
Requests left in the current one-minute window.
Seconds until the current window ends and the count resets.
Identifier of this request. Send your own x-request-id to have it echoed back; otherwise one is generated. Quote it when contacting support.
Seconds to wait before retrying.