Store Redirect Mappings

GET Get all store redirect mappings.

GET /organizations/{organizationId}/store-redirect-mappings

Operation ID: getAllStoreRedirectMappings. Tags: Store Redirect Mappings. Security: AmOAuth2 (sfcc.store-redirect-mappings, sfcc.store-redirect-mappings.rw).

Retrieve all store redirect mappings for the specified organization and site. Use the offset and limit parameters for pagination, or omit them to return all mappings. You can also sort results using the sortBy and sortOrder parameters.

Parameters

organizationId (path, OrganizationId, required) An identifier for the organization the request is being made by
Example
```
f_ecom_zzxy_prd
```
siteId (query, SiteId, required) The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
Example: SiteId
```
RefArch
```
sortBy (query, string) Field for sorting
Allowed values: sourceStoreId, targetStoreId. Default: sourceStoreId. Example: sourceStoreId.
sortOrder (query, string) Sort direction
Allowed values: asc, desc. Default: asc. Example: asc.
limit (query, integer (int32)) Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
Default: 25. Maximum: 200.
offset (query, integer (int32)) Used to retrieve the results based on a particular resource offset.
Default: 0. Minimum: 0.

Responses

200 Store redirect mappings returned successfully.
Media type: application/json. Schema: StoreRedirectMappingsResult.

Example: StoreRedirectMappingsResultGetResponse Successfully retrieved store redirect mappings

Example response for GET all store redirect mappings
```
{
  "data": [
    {
      "sourceStoreId": "store1",
      "targetStoreId": "store2"
    },
    {
      "sourceStoreId": "store3",
      "targetStoreId": "store4"
    }
  ],
  "offset": 0,
  "limit": 25,
  "total": 2
}
```

401 Your access token is invalid or expired and can’t be used to identify a user.

Media type: application/problem+json. Schema: ErrorResponse.

Example: UnauthorizedExample

{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
  "title": "Unauthorized",
  "detail": "Your access token is invalid or expired and can’t be used to identify a user."
}

403 Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.

Media type: application/problem+json. Schema: ErrorResponse.

Example: ForbiddenExample

{
  "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
  "title": "Forbidden",
  "detail": "Your access token is valid, but you don’t have the required permissions to access the resource."
}