Get Channel Attribute Mappings
GET/api/integration-instances/:integrationInstance/channel-attribute-mappings
List the channel-native attributes this integration instance has actually synced, together with the SKU product fields they can be mapped onto, so channel content can be governed by content sync like any other field.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Different channels speak different attribute vocabularies: some emit flat attribute codes (manufacturer, country_of_manufacture), others emit metafields keyed namespace.key (custom.care_instructions). Both arrive here as a code with a suggested human-readable label. supported: false when the connected channel exposes no attribute vocabulary at all. The candidate list is then empty and there is nothing to map. candidates are ranked by product_count (how many synced products carry that code), most-used first, and each carries a few sample_values so a high-signal code is easy to tell apart from an internal one. mapped_attribute_id / mapped_attribute_name are populated when the code is already mapped onto a catalog attribute. mapped_sku_field reports the target in the same vocabulary accepted when saving: attributes.{id} for a catalog attribute, or a product field such as brand or price.Retail.value. enabled reports whether that mapping is currently applied on sync.
targets lists every SKU field a code may be mapped onto, grouped as Basic Info, Physical, Supplier, Pricing Tiers, Supplier Pricing Tiers and Product Attributes. Pricing tiers, supplier pricing tiers and catalog attributes are read live, so tiers and attributes created after this integration was connected appear without a release. Each group carries governed, and each target carries governed_field. Content sync compares eight fields only: barcode, mpn, name, brand, attributes, images, weight and dimensions. A target whose governed_field is null — unit cost, default supplier, and every pricing tier target — is still written to the product on every sync, but drift is never reported on it.
Mapping is opt-in per integration instance. Until at least one mapping is enabled, the channel's attributes are never applied and no attribute drift is raised. Requires Bearer token.
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.