Flavours API
Bulk job

Detail Bulk Job

GET
/api/v2/bulk-jobs/{bulkJobId}

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

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

curl -X GET "https://api.flavours.sa/dev/api/v2/bulk-jobs/nostrum" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Bulk job details retrieved successfully."
  },
  "data": {
    "id": 1,
    "type": "IMPORT",
    "resource": "product",
    "status": "COMPLETED",
    "user_id": "183bcfb1-0684-4fe3-b073-c7ade1768361",
    "market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
    "branch_id": null,
    "batch_id": null,
    "total_rows": 120,
    "processed_rows": 120,
    "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": null,
    "created_at": 1787446686623,
    "updated_at": 1787446686623,
    "success_count": 0,
    "original_filename": null,
    "progress_percent": 100
  }
}
{
  "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": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Cancel Bulk Job POST

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

Download Bulk Job File GET

Stream an import template or error report from the configured storage disk. The signed, expiring link is issued only when that disk cannot presign a download of its own, so a deployment without S3 can still hand the user its files.