j1.2.0
API Overview
The Store Redirect Mappings API provides access to store redirect mapping data within the Store API family. Use this API to manage redirect mappings that configure redirects from one store ID to another. This is typically used for SEO purposes when URL patterns require traffic to be redirected to different stores.
Features
- Get Store Redirect Mappings: Retrieve a paginated list of all store redirect mappings in an organization.
- Get Specific Mapping: Retrieve a specific store redirect mapping by source store ID.
- Bulk Operations: Create or update multiple store redirect mappings in a single request (only returns counts for performance).
- Batch Deletion: Delete multiple store redirect mappings in a single request (only returns counts for performance).
- Pagination: Built-in pagination support with configurable limits and offsets
- Sorting: Sort results by
sourceStoreIdortargetStoreIdin ascending or descending order
Authentication & Authorization
For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
The API client must also have the following OAuth scopes:
sfcc.store-redirect-mappings- Read access to store redirect mapping resourcessfcc.store-redirect-mappings.rw- Read and write access to store redirect mapping resources
You must include the relevant scope(s) in the client ID used to generate the token. For details, see the [Authorization Scopes Catalog[(https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html).
For detailed setup instructions, see the [Authorization for Admin APIs guide[(https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html).
Mapping Fields
Each store redirect mapping contains the following fields:
sourceStoreId- The source store ID that should redirect (String, 1-256 characters)targetStoreId- The target store ID to redirect to (String, 1-256 characters)
Use Cases
- Store Consolidation: When merging stores, redirect old store IDs to new store IDs.
- SEO Management: Maintain search engine rankings when store IDs change.
- URL Migration: Handle redirects during store reorganization or rebranding.
Let us know so we can improve!