@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json

@@ -2,6 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Analytics",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/analytics/analytics-oas-v1-public.yaml)\n\n# API Overview\n\nThe Commerce Intelligence API provides access to metadata and query capabilities for analytics data available in the Commerce Intelligence Platform. Use this API to discover available subject areas and their dimensions and measures, and to query data for reporting and analytics purposes.\n\n## Features\n\n- **List Subject Areas**: Retrieve all available subject areas for an organization\n- **Subject Area Details**: Get detailed metadata including dimensions, measures, display names, and data types for a specific subject area\n- **Query Subject Area Data**: Query specific subject area data for reporting and analytics\n- **Flexible Filtering**: Filter by dimensions using operators such as equals, gt, lt, contains, date ranges, and more\n- **Sorting**: Order results by any field in ascending or descending order\n- **Pagination**: Built-in pagination support with configurable limit and offset\n\n## Endpoints\n\n### GET /organizations/{organizationId}/subject-areas\n\nRetrieve a list of all available subject areas in an organization.\n\n**Parameters:**\n- `organizationId` (required) - The organization identifier\n\n### GET /organizations/{organizationId}/subject-areas/{subjectAreaId}\n\nRetrieve metadata about a specific subject area, including its dimensions and measures.\n\n**Parameters:**\n- `organizationId` (required) - The organization identifier\n- `subjectAreaId` (required) - The subject area to retrieve metadata for (e.g., orderitems)\n\n### POST /organizations/{organizationId}/query/{subjectAreaId}\n\nQuery subject area data within an organization. Specify dimensions, measures, filters, and ordering in the request body.\n\n**Parameters:**\n- `organizationId` (required) - The organization identifier\n- `subjectAreaId` (required) - The subject area to query (e.g., orderitems)\n\n## Authentication and Authorization\n\nThis API uses OAuth 2.0 client credentials flow via Account Manager with the following scope:\n- `sfcc.analytics` - Access to analytics subject areas, metadata, and query operations",
     "version": "1.0.0",
     "x-api-type": "Admin",
     "x-api-family": "Intelligence"
@@ -11,6 +12,7 @@
       "url": "https://{shortCode}.api.commercecloud.salesforce.com/intelligence/analytics/v1",
       "variables": {
         "shortCode": {
+          "description": "A region-specific merchant identifier.",
           "default": "0dnz6oep"
         }
       }
@@ -19,17 +21,21 @@
   "paths": {
     "/organizations/{organizationId}/subject-areas": {
       "get": {
+        "summary": "Get Subject Areas",
+        "description": "Retrieve a list of subject areas.",
         "operationId": "getSubjectAreas",
         "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"
           }
         ],
         "responses": {
@@ -39,6 +45,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/SubjectAreasResponse"
+                },
+                "examples": {
+                  "subjectAreasExample": {
+                    "$ref": "#/components/examples/SubjectAreasResponseExample"
+                  }
                 }
               }
             }
@@ -64,21 +75,26 @@
     },
     "/organizations/{organizationId}/subject-areas/{subjectAreaId}": {
       "get": {
+        "summary": "Get Subject Area by ID",
+        "description": "Access metadata about a subject area",
         "operationId": "getSubjectAreaById",
         "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": "subjectAreaId",
             "in": "path",
+            "description": "The subject area to retrieve metadata for or to query",
             "required": true,
             "style": "simple",
             "explode": false,
@@ -94,6 +110,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/SubjectArea"
+                },
+                "examples": {
+                  "subjectAreaResponseExample": {
+                    "$ref": "#/components/examples/SubjectAreaExample"
+                  }
                 }
               }
             }
@@ -122,21 +143,26 @@
     },
     "/organizations/{organizationId}/query/{subjectAreaId}": {
       "post": {
+        "summary": "Query subject area data",
+        "description": "Query subject area data for reporting and analytics purposes. Use `limit` and `offset` in the request body to control pagination. The response echoes the original query, including pagination parameters, in the `query` object.\n",
         "operationId": "querySubjectArea",
         "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": "subjectAreaId",
             "in": "path",
+            "description": "The subject area to retrieve metadata for or to query",
             "required": true,
             "style": "simple",
             "explode": false,
@@ -146,10 +172,19 @@
           }
         ],
         "requestBody": {
+          "description": "The query request document",
           "content": {
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/QueryRequest"
+              },
+              "examples": {
+                "queryRequestExample": {
+                  "$ref": "#/components/examples/QueryRequestExample"
+                },
+                "queryRequestSetOperatorExample": {
+                  "$ref": "#/components/examples/QueryRequestSetOperatorExample"
+                }
               }
             }
           },
@@ -162,6 +197,11 @@
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/QueryResponse"
+                },
+                "examples": {
+                  "queryResponseExample": {
+                    "$ref": "#/components/examples/QueryResponseExample"
+                  }
                 }
               }
             }
@@ -193,16 +233,26 @@
     "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})$"
       },
       "SubjectAreasResponse": {
         "type": "object",
         "additionalProperties": false,
+        "example": {
+          "data": [
+            "orderitems",
+            "sessions",
+            "pageviews"
+          ]
+        },
         "properties": {
           "data": {
             "type": "array",
             "items": {
               "type": "string",
+              "example": "orderitems",
               "maxLength": 256,
               "minLength": 1
             }
@@ -215,17 +265,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
           }
         },
@@ -241,9 +299,16 @@
             "$ref": "#/components/schemas/ErrorResponse"
           }
         ],
+        "description": "Returned when a query or request body parameter is malformed.",
+        "example": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/malformed-parameter",
+          "title": "Malformed Parameter",
+          "detail": "The requested query or request body parameter 'subjectAreaId' is malformed."
+        },
         "properties": {
           "parameterId": {
             "type": "string",
+            "example": "subjectAreaId",
             "maxLength": 256,
             "minLength": 1
           }
@@ -251,11 +316,15 @@
       },
       "SubjectAreaId": {
         "type": "string",
+        "description": "The unique identifier of the subject area",
+        "example": "orderitems",
         "maxLength": 256,
         "minLength": 1
       },
       "DimensionId": {
         "type": "string",
+        "description": "The unique identifier of the dimension",
+        "example": "utc_submit_timestamp",
         "maxLength": 256,
         "minLength": 1
       },
@@ -267,16 +336,22 @@
           },
           "displayName": {
             "type": "string",
+            "description": "The display name of the dimension",
+            "example": "Submit Timestamp (UTC)",
             "maxLength": 256,
             "minLength": 1
           },
           "description": {
             "type": "string",
+            "description": "Description of the dimension",
+            "example": "The UTC timestamp when the order was submitted",
             "maxLength": 1024,
             "minLength": 1
           },
           "type": {
             "type": "string",
+            "description": "The data type of the dimension",
+            "example": "timestamp",
             "maxLength": 256,
             "minLength": 1
           }
@@ -288,6 +363,8 @@
       },
       "MeasureId": {
         "type": "string",
+        "description": "The unique identifier of the measure",
+        "example": "units",
         "maxLength": 256,
         "minLength": 1
       },
@@ -299,16 +376,22 @@
           },
           "displayName": {
             "type": "string",
+            "description": "The display name of the measure",
+            "example": "Units",
             "maxLength": 256,
             "minLength": 1
           },
           "description": {
             "type": "string",
+            "description": "Description of the measure",
+            "example": "Number of units ordered",
             "maxLength": 1024,
             "minLength": 1
           },
           "type": {
             "type": "string",
+            "description": "The data type of the measure",
+            "example": "integer",
             "maxLength": 256,
             "minLength": 1
           }
@@ -326,30 +409,42 @@
           },
           "description": {
             "type": "string",
+            "description": "Description of the subject area",
+            "example": "Order item level data",
             "maxLength": 1024,
             "minLength": 1
           },
           "tags": {
             "type": "array",
+            "description": "Tags associated with the subject area",
+            "example": [
+              "orders",
+              "commerce"
+            ],
             "items": {
               "type": "string",
+              "example": "orders",
               "maxLength": 256,
               "minLength": 1
             }
           },
           "displayName": {
             "type": "string",
+            "description": "The display name of the subject area",
+            "example": "Order Items",
             "maxLength": 256,
             "minLength": 1
           },
           "dimensions": {
             "type": "array",
+            "description": "Array of dimension metadata for the subject area",
             "items": {
               "$ref": "#/components/schemas/Dimension"
             }
           },
           "measures": {
             "type": "array",
+            "description": "Array of measure metadata for the subject area",
             "items": {
               "$ref": "#/components/schemas/Measure"
             }
@@ -368,6 +463,13 @@
             "$ref": "#/components/schemas/ErrorResponse"
           }
         ],
+        "description": "Returned when the requested subject area was not found.",
+        "example": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subject-area-not-found",
+          "title": "Subject Area Not Found",
+          "detail": "The requested 'orderitems' subject area was not found.\"",
+          "subjectAreaId": "orderitems"
+        },
         "properties": {
           "subjectAreaId": {
             "$ref": "#/components/schemas/SubjectAreaId"
@@ -379,6 +481,7 @@
         "properties": {
           "operator": {
             "type": "string",
+            "description": "The filter operator to apply",
             "enum": [
               "equals",
               "not_equals",
@@ -394,12 +497,18 @@
               "not_in_date_range",
               "before_date",
               "after_date"
-            ]
+            ],
+            "example": "gt"
           },
           "values": {
             "type": "array",
+            "description": "Array of values for the filter. For operators `set` and `not_set`, which check for the presence or absence of a value, pass an empty array (`[]`) since these operators do not take operands.\n",
+            "example": [
+              "2020-01-01"
+            ],
             "items": {
               "type": "string",
+              "example": "2020-01-01",
               "maxLength": 256,
               "minLength": 1
             }
@@ -420,6 +529,8 @@
             "properties": {
               "dimension": {
                 "type": "string",
+                "description": "The dimension to filter on",
+                "example": "utc_submit_timestamp",
                 "maxLength": 256,
                 "minLength": 1
               }
@@ -440,6 +551,8 @@
             "properties": {
               "measure": {
                 "type": "string",
+                "description": "The measure to filter on",
+                "example": "units",
                 "maxLength": 256,
                 "minLength": 1
               }
@@ -455,15 +568,19 @@
         "properties": {
           "field": {
             "type": "string",
+            "description": "The field to order by",
+            "example": "utc_submit_timestamp",
             "maxLength": 256,
             "minLength": 1
           },
           "order": {
             "type": "string",
+            "description": "The sort order (ascending or descending)",
             "enum": [
               "asc",
               "desc"
-            ]
+            ],
+            "example": "asc"
           }
         },
         "required": [
@@ -476,18 +593,37 @@
         "properties": {
           "dimensions": {
             "type": "array",
+            "description": "Array of dimension IDs to include in the query",
+            "example": [
+              "utc_submit_timestamp",
+              "site_name"
+            ],
             "items": {
               "$ref": "#/components/schemas/DimensionId"
             }
           },
           "measures": {
             "type": "array",
+            "description": "Array of measure IDs to include in the query",
+            "example": [
+              "units"
+            ],
             "items": {
               "$ref": "#/components/schemas/MeasureId"
             }
           },
           "filters": {
             "type": "array",
+            "description": "Array of filter expressions for dimensions or measures",
+            "example": [
+              {
+                "dimension": "utc_submit_timestamp",
+                "operator": "gt",
+                "values": [
+                  "2020-01-01"
+                ]
+              }
+            ],
             "items": {
               "oneOf": [
                 {
@@ -501,16 +637,27 @@
           },
           "order": {
             "type": "array",
+            "description": "Array of ordering expressions",
+            "example": [
+              {
+                "field": "utc_submit_timestamp",
+                "order": "asc"
+              }
+            ],
             "items": {
               "$ref": "#/components/schemas/SortOrder"
             }
           },
           "limit": {
             "type": "integer",
+            "description": "Maximum number of results to return",
+            "example": 100,
             "minimum": 1
           },
           "offset": {
             "type": "integer",
+            "description": "Number of results to skip",
+            "example": 0,
             "minimum": 0
           }
         },
@@ -527,33 +674,52 @@
               {
                 "$ref": "#/components/schemas/SubjectAreaId"
               }
-            ]
+            ],
+            "description": "The subject area that was queried",
+            "example": "orderitems"
           },
           "query": {
             "$ref": "#/components/schemas/QueryRequest"
           },
           "dimensions": {
             "type": "array",
+            "description": "Array of dimension IDs in the response",
+            "example": [
+              "utc_submit_timestamp",
+              "site_name"
+            ],
             "items": {
               "$ref": "#/components/schemas/DimensionId"
             }
           },
           "measures": {
             "type": "array",
+            "description": "Array of measure IDs in the response",
+            "example": [
+              "units"
+            ],
             "items": {
               "$ref": "#/components/schemas/MeasureId"
             }
           },
           "fields": {
             "type": "array",
+            "description": "Ordered list of all column keys in the response — the concatenation of `dimensions` and `measures`. Each entry is a `DimensionId` or `MeasureId` string. Provided as a convenience for tabular rendering so consumers can iterate columns in order without having to concatenate `dimensions` and `measures` themselves.\n",
+            "example": [
+              "utc_submit_timestamp",
+              "site_name",
+              "units"
+            ],
             "items": {
               "type": "string",
+              "example": "utc_submit_timestamp",
               "maxLength": 256,
               "minLength": 1
             }
           },
           "data": {
             "type": "array",
+            "description": "Array of result objects containing the queried data. Each object has keys corresponding to the requested dimension and measure IDs. Value types vary based on each field's data type as described in the subject area metadata (e.g., string, integer, decimal, timestamp).",
             "items": {
               "type": "object",
               "additionalProperties": true
@@ -577,6 +743,11 @@
           "application/problem+json": {
             "schema": {
               "$ref": "#/components/schemas/MalformedParameterErrorResponse"
+            },
+            "examples": {
+              "MalformedParameterErrorResponseExample": {
+                "$ref": "#/components/examples/MalformedParameterErrorResponseExample"
+              }
             }
           }
         }
@@ -587,6 +758,11 @@
           "application/problem+json": {
             "schema": {
               "$ref": "#/components/schemas/ErrorResponse"
+            },
+            "examples": {
+              "UnauthorizedExample": {
+                "$ref": "#/components/examples/UnauthorizedExample"
+              }
             }
           }
         }
@@ -597,6 +773,11 @@
           "application/problem+json": {
             "schema": {
               "$ref": "#/components/schemas/ErrorResponse"
+            },
+            "examples": {
+              "ForbiddenExample": {
+                "$ref": "#/components/examples/ForbiddenExample"
+              }
             }
           }
         }
@@ -607,6 +788,11 @@
           "application/problem+json": {
             "schema": {
               "$ref": "#/components/schemas/SubjectAreaNotFoundErrorResponse"
+            },
+            "examples": {
+              "SubjectAreaNotFoundErrorResponseExample": {
+                "$ref": "#/components/examples/SubjectAreaNotFoundErrorResponseExample"
+              }
             }
           }
         }
@@ -616,16 +802,19 @@
       "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"
       },
       "subjectAreaId": {
         "name": "subjectAreaId",
         "in": "path",
+        "description": "The subject area to retrieve metadata for or to query",
         "required": true,
         "style": "simple",
         "explode": false,
@@ -634,9 +823,208 @@
         }
       }
     },
+    "examples": {
+      "SubjectAreasResponseExample": {
+        "value": {
+          "data": [
+            "orderitems",
+            "sessions",
+            "pageviews"
+          ]
+        }
+      },
+      "UnauthorizedExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized",
+          "title": "Unauthorized",
+          "detail": "Unauthorized request"
+        }
+      },
+      "ForbiddenExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden",
+          "title": "Forbidden",
+          "detail": "Access to requested resource forbidden"
+        }
+      },
+      "SubjectAreaExample": {
+        "value": {
+          "id": "orderitems",
+          "displayName": "Order Items",
+          "description": "Order item level data",
+          "tags": [
+            "orders",
+            "commerce"
+          ],
+          "dimensions": [
+            {
+              "id": "utc_submit_timestamp",
+              "displayName": "Submit Timestamp (UTC)",
+              "description": "The UTC timestamp when the order was submitted",
+              "type": "timestamp"
+            },
+            {
+              "id": "site_name",
+              "displayName": "Site Name",
+              "description": "The name of the site",
+              "type": "string"
+            }
+          ],
+          "measures": [
+            {
+              "id": "units",
+              "displayName": "Units",
+              "description": "Number of units ordered",
+              "type": "integer"
+            },
+            {
+              "id": "revenue",
+              "displayName": "Revenue",
+              "description": "Total revenue amount",
+              "type": "decimal"
+            }
+          ]
+        }
+      },
+      "QueryRequestExample": {
+        "value": {
+          "dimensions": [
+            "utc_submit_timestamp",
+            "site_name"
+          ],
+          "measures": [
+            "units"
+          ],
+          "filters": [
+            {
+              "dimension": "utc_submit_timestamp",
+              "operator": "gt",
+              "values": [
+                "2020-01-01"
+              ]
+            }
+          ],
+          "order": [
+            {
+              "field": "utc_submit_timestamp",
+              "order": "asc"
+            }
+          ],
+          "limit": 100,
+          "offset": 0
+        }
+      },
+      "QueryRequestSetOperatorExample": {
+        "summary": "Filter using set / not_set operators",
+        "description": "Example showing the `set` and `not_set` operators. These check for the presence or absence of a value on a dimension and do not take operands, so `values` must be an empty array (`[]`).\n",
+        "value": {
+          "dimensions": [
+            "utc_submit_timestamp",
+            "site_name"
+          ],
+          "measures": [
+            "units"
+          ],
+          "filters": [
+            {
+              "dimension": "site_name",
+              "operator": "set",
+              "values": []
+            },
+            {
+              "dimension": "campaign_id",
+              "operator": "not_set",
+              "values": []
+            }
+          ],
+          "limit": 100,
+          "offset": 0
+        }
+      },
+      "QueryResponseExample": {
+        "value": {
+          "subjectAreaId": "orderitems",
+          "query": {
+            "dimensions": [
+              "utc_submit_timestamp",
+              "site_name"
+            ],
+            "measures": [
+              "units"
+            ],
+            "filters": [
+              {
+                "dimension": "utc_submit_timestamp",
+                "operator": "gt",
+                "values": [
+                  "2020-01-01"
+                ]
+              }
+            ],
+            "order": [
+              {
+                "field": "utc_submit_timestamp",
+                "order": "asc"
+              }
+            ],
+            "limit": 100,
+            "offset": 0
+          },
+          "dimensions": [
+            "utc_submit_timestamp",
+            "site_name"
+          ],
+          "measures": [
+            "units"
+          ],
+          "fields": [
+            "utc_submit_timestamp",
+            "site_name",
+            "units"
+          ],
+          "data": [
+            {
+              "utc_submit_timestamp": "2020-01-01",
+              "site_name": "Sites-SiteGenesis-Site",
+              "units": 42
+            },
+            {
+              "utc_submit_timestamp": "2020-01-01",
+              "site_name": "Sites-SiteGenesisGlobal-Site",
+              "units": 37
+            },
+            {
+              "utc_submit_timestamp": "2020-01-02",
+              "site_name": "Sites-SiteGenesis-Site",
+              "units": 12
+            },
+            {
+              "utc_submit_timestamp": "2020-01-02",
+              "site_name": "Sites-SiteGenesisGlobal-Site",
+              "units": 75
+            }
+          ]
+        }
+      },
+      "MalformedParameterErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/malformed-parameter",
+          "detail": "The requested query or request body parameter 'subjectAreaId' is malformed.",
+          "title": "Malformed Parameter"
+        }
+      },
+      "SubjectAreaNotFoundErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/subject-area-not-found",
+          "detail": "The requested 'orderitems' subject area was not found.",
+          "title": "Subject Area Not Found"
+        }
+      }
+    },
     "securitySchemes": {
       "AmOAuth2": {
         "type": "oauth2",
+        "description": "Account Manager OAuth 2.0 bearer token authentication.",
         "flows": {
           "clientCredentials": {
             "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",