Skip to content

Data types

Fujin Shuttle works with seven data types, each available for both import and export. The type is the --type value on the CLI and the Type field on an admin profile. The exact set is the one the fujin:shuttle:run command advertises:

product | product_variants | category | entities_metadata | product_extra | inventory | rules

For the columns each type accepts, see the CSV reference. To get a valid starting file for any type, download its template (header only) or example (header + sample rows) from the admin or the API.

product

The headline type: wide-column product records. One CSV row is one product, carrying its scalar fields, prices, locale-suffixed translations, and multi-value associations (categories, visibility, properties, media). Missing categories, property options and custom fields can be auto-created during the run.

→ Product columns

product_variants

Variant (child) products. Each row references its parent_product_number and the variant_options (Group:Option) that distinguish it, plus the variant's own price, stock and overrides. Optionally creates a stub parent if one is missing (config: autoCreateVariantParents).

→ Variant columns

category

Category hierarchies expressed as paths (Example Catalog > Electronics > Phones). Each segment is created if absent (under a configurable parent — default the storefront root), and the row carries the leaf's active/visible flags, type, image and translatable SEO fields.

→ Category columns

inventory

The lightest type: product_number, stock. It updates stock on existing products only — it never creates products — which makes it the fast path for frequent stock syncs.

→ Inventory columns

entities_metadata

Defines the metadata entities that products reference: property groups, property group options, custom field sets and custom fields. It is a multi-row-type file — a _row_type column tags each row as PROPERTY_GROUP, PROPERTY_GROUP_OPTION, CUSTOM_FIELD_SET or CUSTOM_FIELD — so one file can define a whole metadata vocabulary in dependency order.

→ Entity-metadata columns

product_extra

Attaches extra data to existing products, also via a _row_type column:

  • PRODUCT_PROPERTY — link a product to a property Group / Option.
  • PRODUCT_CUSTOM_FIELD — set one custom-field value on a product (merged into its translation's custom_fields JSON; processed sequentially to avoid clobbering concurrent writes).

→ Product-extra columns

rules

Rule-builder rules. Each row is name, priority, description plus a JSON conditions tree (a flat array is auto-wrapped into an AND container; a full nested tree is used as-is). Rules are matched by name, so re-importing updates an existing rule's condition tree.

→ Rule columns

Marketplace seller_offer

The base plugin's seven types are extensible. The Flyokai Marketplace plugin contributes a seller_offer type (and a per-seller ownership guard) via the fujin_shuttle.template_contributor / handler tags, without modifying this plugin.