Get Field Mappings
GET/api/magento2/integration-instances/:magento2IntegrationInstance/products/field-mappings
Returns the Magento 2 attribute → SKU.io product field mappings for this store, together with the vocabulary needed to edit them.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
available_magento_fields is store-specific: alongside the fixed product fields it lists every custom attribute code discovered on this store's synced products, grouped under Custom Attributes and ordered by how many products carry a value for them. available_sku_fields lists only SKU.io product fields that can actually be written on create.
mappings are the rules in effect (the saved rules, or the system defaults when none have been saved); custom_mappings are only the saved ones; default_mappings are the system defaults.
Path params:
magento2IntegrationInstance(required, integer).
Request
Responses
- 200
- 401
- 403
- 404
- 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.
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.