Flavours API
Bulk job

Download Bulk Job File

GET
/api/v2/bulk-jobs/downloads

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.

Authorization

default
AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

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

curl -X GET "https://api.flavours.sa/dev/api/v2/bulk-jobs/downloads" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "This download link has expired. Open the import centre and download the file again."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

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.

List Bulk Jobs GET

Paginated bulk job history, filterable by resource and status. Market administrators and merchants see every job in their market; everyone else sees their own.