Flavours API

Bulk Job

APIs for tracking background bulk jobs

List Bulk JobsGET

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

Detail Bulk JobGET

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

Bulk Job Error ReportGET

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.

Retry Bulk JobPOST

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

Cancel Bulk JobPOST

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

Download Bulk Job FileGET

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.

Import Products TemplateGET

Download a fresh product import template spreadsheet.

Import Products Upload URLPOST

Get a presigned S3 POST for uploading a large product spreadsheet directly to storage.

Import ProductsPOST

Upload a product spreadsheet and queue it for background import.

Import Product Categories TemplateGET

Download a fresh product category import template spreadsheet.

Import Product Categories Upload URLPOST

Get a presigned S3 POST for uploading a large product category spreadsheet directly to storage.

Import Product CategoriesPOST

Upload a product category spreadsheet and queue it for background import.

Import Customers TemplateGET

Download a fresh customer import template spreadsheet.

Import Customers Upload URLPOST

Get a presigned S3 POST for uploading a large customer spreadsheet directly to storage.

Import CustomersPOST

Upload a customer spreadsheet and queue it for background import. Error reports never carry row values, and no customer field reaches the logs.

Import Ingredients TemplateGET

Download a fresh ingredient import template spreadsheet.

Import Ingredients Upload URLPOST

Get a presigned S3 POST for uploading a large ingredient spreadsheet directly to storage.

Import IngredientsPOST

Upload an ingredient spreadsheet and queue it for background import.

Export ProductsGET

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

Export Product CategoriesGET

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

Export IngredientsGET

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.

Export CustomersGET

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.