Flavours API
Bulk jobExport

Export Customers

GET
/api/v2/bulk/customers/export

Generate a round-trip customer workbook pre-filled with the market customers and return a temporary download URL. The file can be edited and re-imported as an upsert.

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

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/bulk/customers/export" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Customer export generated successfully."
  },
  "data": {
    "url": "http://localhost:8000/exports/customer/customer-d33a5f53-b105-41f6-b19e-e4040ed31292-1787446687258.xlsx?expiration=1787447587"
  }
}
{
  "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
}

Retry Bulk Job POST

Re-drive a bulk job from its stored cursor. Only a FAILED or COMPLETED_WITH_ERRORS job can be retried.

Export Ingredients GET

Generate a round-trip ingredient workbook pre-filled with the market ingredients and their per-branch opening stock, and return a temporary download URL. The file can be edited and re-imported as an upsert.