j1.6.0
API Overview
Use the Shopper Experience API to look up page information for pages created in Page Designer, search and retrieve content assets, and access content folders.
Authentication & Authorization
The Shopper Experience API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
For details on how to request a shopper access token from SLAS, see the guest user flows for public clients and private clients in the SLAS guides.
You must include sfcc.shopper-experience in the client ID used to generate the SLAS token. For a full list of required permissions, see the Authorization Scopes Catalog.
Important: Currently, the Shopper Experience Pages endpoints can’t be used when the storefront password protection feature is enabled.
Response Details
Personalization
Responses from this API are not personalized via the Shopper Context API. Page Designer uses its own visibility rules (scheduling, customer groups) to control component visibility.
Caching
Caching is provided for the Shopper Experience API. For details, see Server-Side Web-Tier Caching and Page Designer Caching.
Timeouts
Shopper API requests must respond within 10 seconds, including any hook execution. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see Timeouts and Limits.
Error Handling
Error responses follow the RFC 7807 problem detail format. To trace errors, include a correlation-id header in your request — the response returns it as x-correlation-id. For details, see HTTP Status Codes and Errors.
Use Cases
Get a Page Designer Page
Retrieve a Page Designer page by ID.
curl "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/v1/organizations/{organizationId}/pages/{pageId}?siteId=RefArch" \
-H "Authorization: Bearer {access_token}"
Access Content Folders
The API provides access to content folders, which are used to organize and manage content assets. Content folders support:
- Hierarchical organization with nested subfolders
- Localized metadata including names, descriptions, and SEO attributes
- Custom attributes for extended functionality
- Configurable depth levels for subfolder retrieval (0, 1, or 2 levels)
Only content folders that are marked as online are returned in the API responses.
Search Content Assets
Search for content assets using keywords and refinement filters. The search functionality supports:
- Keyword-based search across content assets
- Refinement attributes to filter results, for example, by folder or content type
- Sorting by configurable attributes
- Pagination for large result sets (up to 200 items per page)
Only content assets that are online and assigned to a folder are included in search results.
Batch Retrieval
Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
Page Responses
Responses for pages include the following:
- The entire component hierarchy of the page at design time.
- All merchant data provided at design time.
- Server-side scripting data provided at run time.
- Tracking for each rendered component or fragment using a globally unique content link UUID.
- Support for reusable component fragments that can be shared across multiple pages.
Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only processed and returned if it is visible.
Content Asset Responses
Content asset responses include:
- Rich content including text, HTML, and images
- SEO metadata (title, description, keywords)
- Template information for rendering
- Folder organization structure
- Custom attributes and properties
Only content assets that are marked as online are returned. Content assets provide flexible content management capabilities for storefronts.
Related APIs
- Experiences (Admin) — Manage Page Designer pages and content assets.
Let us know so we can improve!