Skip to main content

Create SKU.io Product From Store Product

POST 
/api/storefront/instances/:id/products/:id2/create-sku-product

Create ONE SKU.io catalog product from this store product and map the two together.

Not yet available to API tokens

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

If a SKU.io product with the same SKU already exists, it is LINKED instead of duplicated. The response says which happened: linked_existing is true for a link, false for a fresh creation.

Body (all fields optional):

  • field_mappings — array of objects, each {storefront_field | listing_field, sku_field, parsers}. storefront_field and listing_field are interchangeable names for the store-side source; sku_field is the SKU.io target; parsers is an array (send [] when you have none). Any row whose source or target is not one this connection advertises is DROPPED, so a crafted request can never write an arbitrary column into a product.
    • Valid store-side sources: the mirrored columns sku, name, slug, price, compare_at_price, description_html, short_description_html, position, store_available — plus any attribute code this connection's imported products actually carry (see store_attributes on the product detail response).
    • Valid SKU.io targets: sku, item_name, price, weight, length, width, height, plus price.{pricing tier name}.value for each product pricing tier and attributes.{attribute name} for each product attribute.
  • save_as_default — boolean. false/omitted: the mappings drive THIS creation only and are not stored. true: they also become the connection's stored default field mappings.

Send no field_mappings at all to use the connection's stored mappings, falling back to the defaults (store sku to SKU, store name to name, store price to price).

Returns 422 when the product is already mapped — unmap it first. Returns 404 when the product belongs to a different connection. On success the status is 201.

Permission: integrations.update.

Authentication: Bearer token (session or PAT).

Request​

Responses​

Created

Response Headers
    Content-Type