Skip to main content

Update mappings for integration instance

PUT 
/api/amazon/:integrationInstance/mappings

Persists the full set of custom field mappings for the given Amazon integration instance. The payload completely replaces the previously stored custom mappings for the listings mapping group.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Request body (validated via UpdateAmazonFieldMappingsData):

  • mappings (array, required): list of mapping entries. Each entry contains:
    • listing_field (string, required): the Amazon listing field name (e.g. seller_sku, item_name, brand, price). Must match one of the keys returned by GET /api/amazon/mappings/available-fields under amazon_fields.
    • sku_field (string, required): the SKU.io target field. Either a static field (e.g. sku, name, vendor), a pricing tier path (e.g. price.Default.value), a supplier pricing tier path (e.g. supplier_pricing.Wholesale.value), or an attribute path (e.g. attributes.Color).
    • parsers (array, required): zero or more parser transformations applied in order to the incoming Amazon value before it is written to the SKU.io field. Each parser has a rule (must be one of the supported FieldParserFactory::SUPPORTED_PARSERS rules) and a stringified args payload.

The response echoes back the integration instance id/name plus the updated mappings and effective_mappings (custom merged on top of defaults).

Request​

Responses​

OK

Response Headers
    Content-Type