Skip to main content

Get Field Mappings

GET 
/api/storefront/instances/:id/mappings

Which store field fills which SKU.io field when a catalog product is created from a store product, plus the option lists a mapping is chosen from.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Response:

  • mappings / custom_mappings — this instance's own mappings (identical arrays).
  • default_mappings — what applies when nothing custom is set: store sku → sku, store name → item_name, store price → price.
  • effective_mappings — what the importer will actually apply: the defaults with any custom mapping overriding the default that targets the SAME sku_field, plus every custom mapping that targets a field no default covers.
  • available_storefront_fields — every source a mapping may point at: the fixed mirror columns (sku, name, slug, price, compare_at_price, description_html, short_description_html, position, store_available, each source: "column") plus the attribute codes this instance's imported products actually carry (source: "attribute", sorted). Nothing else is offered — a source the importer cannot resolve would create products with silently empty values.
  • available_sku_fields — the targets, each with a group: core fields (sku, item_name, price), dimensions (weight, length, width, height), one entry per pricing level as price.{level name}.value, and one per unarchived attribute as attributes.{attribute name}.

Both option lists are rebuilt on every call, so a pricing level or attribute created a moment ago in another window appears immediately.

Authentication: Bearer token (session or PAT).

Request​

Responses​

OK

Response Headers
    Content-Type