Get Field Mappings
GET/api/big-commerce/:integrationInstance/mappings
Get the product field mappings for a BigCommerce integration instance - which BigCommerce product fields populate which SKU.io product fields when products are created or updated from listings.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The response includes the default mappings, any custom overrides, the effective (merged) mappings, and the catalog of available fields on both sides.
Route name: big-commerce.mappings.show
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.