Skip to main content

Download Recipe Import Template

GET 

/api/v2/products/import-recipes/template

Download the manufacturing recipe (BOM) import template XLSX.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The workbook has three sheets: Import Here (the columns to fill in, with required columns highlighted), Field Guide (what every column does, its accepted values and an example), and Reference Data (existing recipes and product SKUs from your account).

The template is one row per component. Repeat product_sku and recipe_name on every row of the same recipe - rows are grouped by that pair. Leaving recipe_name blank names the recipe "<product_sku> Recipe".

Re-importing an unchanged recipe does nothing; changing one saves a new version of it; a new recipe_name creates a separate recipe, since a product can have several.

Validating and running the import use the shared data import endpoints with the entity type recipes.

Authentication: Requires Bearer token.

Response: XLSX file download.

Responses

OK

Response Headers
    Content-Type