@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json

@@ -2,7 +2,8 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Shopper SEO",
-    "version": "1.3.0",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-seo/shopper-seo-oas-v1-public.yaml)\n\n# API Overview\n\nThe Shopper SEO API Provides access to SEO-related information, such as URL mapping information.\n\n## Authentication & Authorization\n\nThe Shopper SEO API requires a shopper access token from the [Shopper Login and API Access Service (SLAS).](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html)\n\nYou must include the relevant scope(s) in the client ID used to generate the SLAS token. For a full list of required permissions, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)\n\nFor details on how to request a shopper access token from SLAS, see the guest user flows for [public clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-public-client.html) and [private clients](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html) in the SLAS guides.\n\n## Customization\n\n### Hooks\n\nFor details on working with hooks, see [Extensibility with Hooks.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/extensibility_via_hooks.html)\n\n## Response Details\n\n### Personalization\n\nResponses from this API are not personalized via the Shopper Context API.\n\n### Caching\n\nCaching is provided for this API. For details, see [Server-Side Web-Tier Caching.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html)\n\n### Timeouts\n\nShopper 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.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)\n\n### Error Handling\n\nError responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) 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.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)\n\n## Use Cases\n\n### Resolve a URL\n\nResolve a URL path to its resource type (product, category, or content page).\n\n```sh\ncurl \"https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/v1/organizations/{organizationId}/url-mapping?urlSegment=new-arrivals-tops&siteId=RefArch\" \\\n  -H \"Authorization: Bearer {access_token}\"\n```\n\n\n### URL Resolution\n\nFor information on setting up URL rules and URL redirects in Business Manager, see [URL Resolution.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/url-resolution.html)\n\n## Related APIs\n\n- [SEO (Admin)](https://developer.salesforce.com/docs/commerce/commerce-api/references/seo?meta=Summary) — Manage SEO URL rules and redirects.",
+    "version": "1.3.1",
     "x-api-type": "Shopper",
     "x-api-family": "Site"
   },
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/v1",
       "variables": {
         "shortCode": {
+          "description": "An eight-character string assigned to a realm for routing purposes. See [Base URL and Request Formation.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html)",
           "default": "shortCode"
         }
       }
@@ -19,26 +21,32 @@
   "paths": {
     "/organizations/{organizationId}/url-mapping": {
       "get": {
+        "summary": "Get URL mapping information for a URL segment.",
+        "description": "The mapping information is based on URL rules and redirects that are set up in Business Manager. \nFor more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). \nYou can customize the behavior of this endpoint by using hooks. For details, refer to the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).",
         "operationId": "getUrlMapping",
         "parameters": [
           {
             "name": "organizationId",
             "in": "path",
+            "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
             "required": true,
             "style": "simple",
             "explode": false,
             "schema": {
               "$ref": "#/components/schemas/OrganizationId"
-            }
+            },
+            "example": "f_ecom_zzxy_prd"
           },
           {
             "name": "urlSegment",
             "in": "query",
+            "description": "The part of the requested URL that comes after the domain name. For example, the urlSegment for \\\"www.abc.com/blue/new-arrivals/tops\\\" is \\\"blue/new-arrivals/tops\\\". \nThere's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. \nMake this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "type": "string",
+              "example": "mens/clothing/shorts",
               "maxLength": 2047,
               "minLength": 1
             }
@@ -46,51 +54,55 @@
           {
             "name": "siteId",
             "in": "query",
+            "description": "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.",
             "required": true,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/SiteId"
+            },
+            "examples": {
+              "SiteId": {
+                "value": "RefArch"
+              }
             }
           },
           {
             "name": "locale",
             "in": "query",
+            "description": "A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.",
             "required": false,
             "style": "form",
             "explode": true,
             "schema": {
               "$ref": "#/components/schemas/LocaleCode"
+            },
+            "examples": {
+              "LanguageCountry": {
+                "value": "en-US"
+              },
+              "CountryCode": {
+                "value": "US"
+              }
             }
           },
           {
             "name": "sfdc_usid",
             "in": "header",
+            "description": "A unique shopper identifier (USID) for tracking client context.\nUsed with endpoints secured with ShopperClientContextToken.\nThis header is required for all endpoints secured with ShopperClientContextToken.",
             "required": false,
             "style": "simple",
             "explode": false,
             "schema": {
               "type": "string",
-              "format": "uuid"
-            }
-          },
-          {
-            "name": "sfdc_dw_dnt",
-            "in": "header",
-            "required": false,
-            "style": "simple",
-            "explode": false,
-            "schema": {
-              "type": "string",
-              "enum": [
-                "0",
-                "1"
-              ]
+              "format": "uuid",
+              "example": "550e8400-e29b-41d4-a716-446655440000"
             }
           },
           {
             "name": "personalized",
             "in": "query",
+            "description": "Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.\n\nWhen set to `none`, the server skips applying personalization to the response.\n\nSetting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).",
             "required": false,
             "style": "form",
             "explode": true,
@@ -98,12 +110,14 @@
               "type": "string",
               "enum": [
                 "none"
-              ]
+              ],
+              "example": "none"
             }
           },
           {
             "name": "sfdc_shopper_context",
             "in": "header",
+            "description": "Shopper context information (for example clientIP, sourceCode, and customQualifiers)\npassed in from a trusted backend application.",
             "required": false,
             "style": "simple",
             "explode": false,
@@ -119,6 +133,17 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/UrlMapping"
+                },
+                "examples": {
+                  "UrlMappingCategory": {
+                    "$ref": "#/components/examples/UrlMappingCategory"
+                  },
+                  "UrlMappingProduct": {
+                    "$ref": "#/components/examples/UrlMappingProduct"
+                  },
+                  "UrlMappingContentAsset": {
+                    "$ref": "#/components/examples/UrlMappingContentAsset"
+                  }
                 }
               }
             }
@@ -129,6 +154,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "getUrlMapping400": {
+                    "$ref": "#/components/examples/getUrlMapping400"
+                  }
                 }
               }
             }
@@ -139,6 +169,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "getUrlMapping401": {
+                    "$ref": "#/components/examples/getUrlMapping401"
+                  }
                 }
               }
             }
@@ -149,6 +184,11 @@
               "application/problem+json": {
                 "schema": {
                   "$ref": "#/components/schemas/ErrorResponse"
+                },
+                "examples": {
+                  "getUrlMapping404": {
+                    "$ref": "#/components/examples/getUrlMapping404"
+                  }
                 }
               }
             }
@@ -173,27 +213,38 @@
     "schemas": {
       "OrganizationId": {
         "type": "string",
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
+        "example": "f_ecom_zzxy_prd",
         "pattern": "^f_ecom_[a-z]{4}_(prd|stg|dev|s[0-9]{2}|[0-9]{3})$"
       },
       "SiteId": {
         "type": "string",
+        "description": "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": "RefArch",
         "maxLength": 32,
         "minLength": 1
       },
       "LanguageCountry": {
         "type": "string",
+        "description": "A concatenated version of the standard Language and Country codes, combined with a hyphen '`-`'.",
+        "example": "en-US",
         "pattern": "^[a-z][a-z]-[A-Z][A-Z]$"
       },
       "LanguageCode": {
         "type": "string",
+        "description": "A two letter lowercase language code conforming to the [ISO 639-1](https://www.iso.org/iso-639-language-codes.html) standard. Additionally, this may be used to submit requests with the header parameter `Accept-Language`, following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766).",
+        "example": "en",
         "pattern": "^[a-z][a-z]$"
       },
       "DefaultFallback": {
         "type": "string",
         "default": "default",
+        "description": "A specialized value indicating the system default values for locales.",
+        "example": "default",
         "pattern": "^default$"
       },
       "LocaleCode": {
+        "description": "A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.",
         "oneOf": [
           {
             "$ref": "#/components/schemas/LanguageCountry"
@@ -208,64 +259,85 @@
       },
       "UrlMapping": {
         "type": "object",
+        "description": "The URL mapping information for a URL that a shopper clicked or typed in.",
         "properties": {
           "resourceType": {
             "type": "string",
+            "description": "The type of resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager, \nresourceType returns the corresponding destination type value from the redirect. If there's a URI redirect, resourceType isn't returned. \nThe URL redirect feature is available from B2C Commerce version 24.3.",
             "enum": [
               "CATEGORY",
               "PRODUCT",
               "CONTENT_ASSET"
             ],
+            "example": "CATEGORY",
             "maxLength": 256,
             "minLength": 1
           },
           "resourceSubType": {
             "type": "string",
+            "description": "If the resourceType is CONTENT_ASSET, this field tells you whether the resource is a standard content asset or a Page Designer content asset. \nThis output is available from B2C Commerce version 24.2.",
             "enum": [
               "STANDARD_CONTENT_ASSET",
               "PAGE_DESIGNER_CONTENT_ASSET"
             ],
+            "example": "STANDARD_CONTENT_ASSET",
             "maxLength": 256,
             "minLength": 1
           },
           "resourceId": {
             "type": "string",
+            "description": "The identifier for the resource that corresponds to the requested URL. If you set up a URL redirect in Business Manager, \nresourceId returns the corresponding destination ID value from the redirect. \nIf there's a URI redirect, resourceId isn't returned. The URL redirect feature is available from B2C Commerce version 24.3.",
+            "example": "mens-clothing-shorts",
             "maxLength": 256,
             "minLength": 1
           },
           "refinements": {
             "type": "object",
-            "additionalProperties": true
+            "additionalProperties": true,
+            "description": "The refinement filters that correspond to the URL and resourceType. \nRefinements are returned only if all of these conditions are met - a) the resourceType is CATEGORY, b) refinements are included in the urlSegment, and c) the refinements are configured in Business Manager. \nThis field returns a key-value pair of refinement name and refinement value. If there’s a matching URL redirect for the requested URL. the refinements output isn’t returned.\nThe URL redirect feature is available from B2C Commerce version 24.3."
           },
           "statusCode": {
             "type": "integer",
-            "format": "int32"
+            "format": "int32",
+            "description": "This field is populated only if you set up a URL redirect in Business Manager. It specifies whether the redirect is temporary (302 or 307) or permanent (301). \nSee [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5) \nThis parameter is available from B2C Commerce version 24.3.",
+            "example": 301
           },
           "destinationUrl": {
             "type": "string",
+            "description": "This field is populated if the urlSegment resolves to a redirect. Specifies the URL you want to redirect to as an absolute or relative URL. \nThe destinationUrl is based on your configuration in Business Manager. It's either a calculated value indicating the Commerce Cloud object (product, category, or content asset) URL or your specified URL. \nNote that an object's path may not necessarily match your headless storefront URLs but can be used as a reference for calculating the destinationUrl. \nSee [Create a Redirect from a B2C Commerce URL.](https://help.salesforce.com/s/articleView?id=cc.b2c_creating_a_redirect_from_a_digital_url.htm&type=5). \nAvailable from B2C Commerce 24.3.",
+            "example": "mens/clothing/shorts",
             "maxLength": 2048,
             "minLength": 1
           },
           "copySourceParams": {
-            "type": "boolean"
+            "type": "boolean",
+            "description": "This field is populated only if you set up a URL redirect in Business Manager. \nIt’s a flag that shows whether the parameters of the source URL have been copied to the destination URL. \nThis parameter is available from B2C Commerce version 24.3.",
+            "example": true
           },
           "additionalUrlParams": {
             "type": "string",
+            "description": "This field is populated only if you set up a URL redirect in Business Manager. \nIt returns the parameters you want to add to the end of the URL. \nThis parameter is available from B2C Commerce version 24.3.",
+            "example": "&cgid=womens-accessories-scarves&prefn1=displaySize",
             "maxLength": 2048,
             "minLength": 1
           },
           "productCategoryId": {
             "type": "string",
+            "description": "This field is populated only if you set up a URL redirect in Business Manager.\nIt identifies the destination product's category ID. This field is returned only when the destination type is product.\nThis parameter is available from B2C Commerce version 24.3.",
             "maxLength": 256,
             "minLength": 1
           },
           "onlineFrom": {
             "type": "string",
-            "format": "date-time"
+            "format": "date-time",
+            "description": "The date and time from which the URL redirect is active. If null, the redirect has no start date constraint.\nThis field is populated only if you set up a URL redirect in Business Manager.\nThis parameter is available from B2C Commerce version 26.8.",
+            "example": "2025-06-01T00:00:00Z"
           },
           "onlineTo": {
             "type": "string",
-            "format": "date-time"
+            "format": "date-time",
+            "description": "The date and time until which the URL redirect is active. If null, the redirect has no end date constraint.\nThis field is populated only if you set up a URL redirect in Business Manager.\nThis parameter is available from B2C Commerce version 26.8.",
+            "example": "2025-12-31T23:59:59Z"
           }
         }
       },
@@ -275,17 +347,25 @@
         "properties": {
           "title": {
             "type": "string",
+            "description": "A short, human-readable summary of the problem\ntype.  It will not change from occurrence to occurrence of the \nproblem, except for purposes of localization\n",
+            "example": "You do not have enough credit",
             "maxLength": 256
           },
           "type": {
             "type": "string",
+            "description": "A URI reference [RFC3986] that identifies the\nproblem type.  This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]).  When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "NotEnoughMoney",
             "maxLength": 2048
           },
           "detail": {
-            "type": "string"
+            "type": "string",
+            "description": "A human-readable explanation specific to this occurrence of the problem.",
+            "example": "Your current balance is 30, but that costs 50"
           },
           "instance": {
             "type": "string",
+            "description": "A URI reference that identifies the specific\noccurrence of the problem.  It may or may not yield further\ninformation if dereferenced.  It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
+            "example": "/account/12345/msgs/abc",
             "maxLength": 2048
           }
         },
@@ -300,21 +380,25 @@
       "organizationId": {
         "name": "organizationId",
         "in": "path",
+        "description": "An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).",
         "required": true,
         "style": "simple",
         "explode": false,
         "schema": {
           "$ref": "#/components/schemas/OrganizationId"
-        }
+        },
+        "example": "f_ecom_zzxy_prd"
       },
       "urlSegment": {
         "name": "urlSegment",
         "in": "query",
+        "description": "The part of the requested URL that comes after the domain name. For example, the urlSegment for \\\"www.abc.com/blue/new-arrivals/tops\\\" is \\\"blue/new-arrivals/tops\\\". \nThere's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. \nMake this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.",
         "required": true,
         "style": "form",
         "explode": true,
         "schema": {
           "type": "string",
+          "example": "mens/clothing/shorts",
           "maxLength": 2047,
           "minLength": 1
         }
@@ -322,51 +406,55 @@
       "siteId": {
         "name": "siteId",
         "in": "query",
+        "description": "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.",
         "required": true,
         "style": "form",
         "explode": true,
         "schema": {
           "$ref": "#/components/schemas/SiteId"
+        },
+        "examples": {
+          "SiteId": {
+            "value": "RefArch"
+          }
         }
       },
       "locale": {
         "name": "locale",
         "in": "query",
+        "description": "A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.",
         "required": false,
         "style": "form",
         "explode": true,
         "schema": {
           "$ref": "#/components/schemas/LocaleCode"
+        },
+        "examples": {
+          "LanguageCountry": {
+            "value": "en-US"
+          },
+          "CountryCode": {
+            "value": "US"
+          }
         }
       },
       "sfdcUsid": {
         "name": "sfdc_usid",
         "in": "header",
+        "description": "A unique shopper identifier (USID) for tracking client context.\nUsed with endpoints secured with ShopperClientContextToken.\nThis header is required for all endpoints secured with ShopperClientContextToken.",
         "required": false,
         "style": "simple",
         "explode": false,
         "schema": {
           "type": "string",
-          "format": "uuid"
-        }
-      },
-      "sfdcDwDnt": {
-        "name": "sfdc_dw_dnt",
-        "in": "header",
-        "required": false,
-        "style": "simple",
-        "explode": false,
-        "schema": {
-          "type": "string",
-          "enum": [
-            "0",
-            "1"
-          ]
+          "format": "uuid",
+          "example": "550e8400-e29b-41d4-a716-446655440000"
         }
       },
       "personalized": {
         "name": "personalized",
         "in": "query",
+        "description": "Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.\n\nWhen set to `none`, the server skips applying personalization to the response.\n\nSetting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).",
         "required": false,
         "style": "form",
         "explode": true,
@@ -374,12 +462,14 @@
           "type": "string",
           "enum": [
             "none"
-          ]
+          ],
+          "example": "none"
         }
       },
       "sfdcShopperContext": {
         "name": "sfdc_shopper_context",
         "in": "header",
+        "description": "Shopper context information (for example clientIP, sourceCode, and customQualifiers)\npassed in from a trusted backend application.",
         "required": false,
         "style": "simple",
         "explode": false,
@@ -388,9 +478,61 @@
         }
       }
     },
+    "examples": {
+      "UrlMappingCategory": {
+        "summary": "URL mapped to a category with refinements.",
+        "value": {
+          "resourceType": "CATEGORY",
+          "resourceId": "new-arrivals-tops",
+          "refinements": {
+            "refinementColor": "Blue"
+          }
+        }
+      },
+      "UrlMappingProduct": {
+        "summary": "URL mapped to a product.",
+        "value": {
+          "resourceType": "PRODUCT",
+          "resourceId": "25695327M"
+        }
+      },
+      "UrlMappingContentAsset": {
+        "summary": "URL mapped to a content asset.",
+        "value": {
+          "resourceType": "CONTENT_ASSET",
+          "resourceId": "about-us"
+        }
+      },
+      "getUrlMapping400": {
+        "value": {
+          "title": "Unknown Locale",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unknown-locale",
+          "detail": "The locale 'ab-CD' is unknown.",
+          "locale": "ab-CD"
+        }
+      },
+      "getUrlMapping401": {
+        "value": {
+          "title": "Invalid Access Token",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token",
+          "detail": "The request is unauthorized, the access token is invalid.",
+          "accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp"
+        }
+      },
+      "getUrlMapping404": {
+        "value": {
+          "title": "Seo Url Mapping Not Found",
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/seo-url-mapping-not-found",
+          "detail": "black/mens/accessories/luggage",
+          "urlSegment": "black/mens/accessories/luggage",
+          "locale": "en_US"
+        }
+      }
+    },
     "securitySchemes": {
       "ShopperToken": {
         "type": "oauth2",
+        "description": "ShopperToken authentication follows the authorization code grant flow, as defined by the OAuth 2.1 standard. Depending on the type of OAuth client (public or private), this authorization flow has further requirements. \nFor a detailed description of the authorization flow, see the [SLAS overview](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).\nA shopper token allows you to access the Shopper API endpoints of both the Open Commerce API (OCAPI) and the B2C Commerce API. These endpoints can be used to build headless storefronts and other applications.\nThe `ShopperToken` security scheme is a parent of other security schemes, such as `ShopperTokenTsob`. A Shopper API endpoint can require a specific child scheme (`ShopperTokenTsob`, for example) that cannot be accessed with a regular shopper token.\n",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token",
@@ -409,6 +551,7 @@
       },
       "ShopperClientContextToken": {
         "type": "oauth2",
+        "description": "ShopperClientContextToken is a separate security scheme used to track and validate client context information.\nIt is valid for Guest shoppers flows only using SLAS private clients. For registered shoppers, use existing ShopperToken flows.\nFor authentication details, see the [SLAS overview](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).\nThis token allows access to Shopper API endpoints for guest shoppers only.\n",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token?hint=client_context",