Update Field Mappings
PUT/api/magento2/integration-instances/:magento2IntegrationInstance/products/field-mappings
Replaces the stored field mappings for this store. Send the full list — the server overwrites rather than merges, and an empty array clears every mapping.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body: { mappings: [{ magento_field, sku_field }] }. mappings is required and may be empty; magento_field and sku_field are required strings on each entry.
Entries whose magento_field this store does not offer (see available_magento_fields on the GET) are discarded rather than stored — a mapping that can never be applied would otherwise look saved and silently do nothing. The response returns what was actually stored plus skipped_count, the number of submitted entries that were dropped.
Path params:
magento2IntegrationInstance(required, integer).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.