The mapping information is based on URL rules and redirects that are set up in Business Manager. For more information about prerequisites and sample usage, see URL Resolution. You can customize the behavior of this endpoint by using hooks. For details, refer to the Hook List.
If you would like to get a raw Response object use the other getUrlMapping function.
An object containing the options for this method.
A promise of type UrlMapping.
The mapping information is based on URL rules and redirects that are set up in Business Manager. For more information about prerequisites and sample usage, see URL Resolution. You can customize the behavior of this endpoint by using hooks. For details, refer to the Hook List.
An object containing the options for this method.
Set to true to return entire Response object instead of DTO.
A promise of type Response if rawResponse is true, a promise of type UrlMapping otherwise.
Generated using TypeDoc
Shopper SEO
*# API Overview
The Shopper SEO API Provides access to SEO-related information, such as URL mapping information.
Authentication & Authorization
The Shopper SEO API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see Authorization Scopes Catalog.
Use Cases
URL Resolution
For information on setting up URL rules and URL redirects in Business Manager, see URL Resolution.
Caching
Caching capabilities are available for the Shopper SEO API. For details, see Server-Side Web-Tier Caching.
Using Hooks
For details working with hooks, see Extensibility with Hooks.*
Simple example:
API Version: 0.0.33import { ShopperSEO } from "commerce-sdk-isomorphic"; const clientConfig = { parameters: { clientId: "XXXXXX", organizationId: "XXXX", shortCode: "XXX", siteId: "XX" } }; const shopperSEOClient = new ShopperSEO(clientConfig);
Last Updated: