Flavours API
Bulk job

Cancel Bulk Job

POST
/api/v2/bulk-jobs/{bulkJobId}/cancel

Cancel a non-terminal bulk job. Chunks already committed stay committed and the response states how many records were kept.

Authorization

default
AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

bulkJobId*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.flavours.sa/dev/api/v2/bulk-jobs/praesentium/cancel" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "The import was canceled. 80 records already imported were kept."
  },
  "data": {
    "id": 5,
    "type": "IMPORT",
    "resource": "product",
    "status": "CANCELED",
    "user_id": "183bcfb1-0684-4fe3-b073-c7ade1768361",
    "market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
    "branch_id": null,
    "batch_id": null,
    "total_rows": 200,
    "processed_rows": 80,
    "error_count": 0,
    "cursor": null,
    "source_path": null,
    "artifact_path": null,
    "error_report_path": null,
    "delivery": "DOWNLOAD",
    "email": null,
    "params": [],
    "expires_at": null,
    "started_at": null,
    "finished_at": 1787446686826,
    "created_at": 1787446686768,
    "updated_at": 1787446686826,
    "success_count": 80,
    "original_filename": null,
    "progress_percent": 40
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 422,
    "status": "error",
    "message": "This bulk job cannot be cancelled."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Bulk Job Error Report GET

Get a temporary download URL for the error report of a bulk job. Returns a null payload when the job produced no report, 409 while the report of a job that has just finished with errors is still being rendered, and 410 once the file has been deleted by retention.

Detail Bulk Job GET

Get the status and counters of a single bulk job. A job belonging to another market is reported as not found.