Guides

Task-based walkthroughs that take you end-to-end across the Flowkiwi APIs - from an empty account to working product data. Unlike the API reference, each guide follows a single goal step by step.

Getting started

Follow these in order - each one builds on the last.

1. Create your organization and instance

   Set up the account and workspace your catalog lives in. You’ll come away with an organization id and an instance handle.

2. Create your first product

   Use that organization and instance to create your first product, ready to enrich with options and variants.

   Optional Add an image - upload an image and attach it to the product and/or its variants.

   Optional Add a custom field - declare a metafield definition and store a custom value on the product.

   Optional Model custom objects - define a reusable object type with metaobjects and create records from it.

   Optional Categorize products - build a category tree, add an attribute, and classify a product.

3. Set a selling price

   Price one of the product’s variants with a sale offer, then read back the resolved price a buyer sees.

More guides are on the way. In the meantime, browse the Product Management and Identity API references.