@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0

package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/deployments/v1.json

@@ -0,0 +1,1442 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Deployments",
+    "description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/storefront/deployments-oas-v1-public.yaml)\n\n# API Overview\n\nThe Deployments API provides SCAPI-native access to bundle and deployment management for Composable Commerce storefronts running on Managed Runtime (MRT).\n\n- **Bundles** — upload and list versioned SSR application packages for a storefront.\n- **Deployments** — trigger, list, and monitor deployments of bundles to storefront environments.\n\n## Authentication & Authorization\n\nRequests are authenticated with Account Manager OAuth 2.0 bearer tokens (`AmOAuth2`). Access is governed by the Deployments API scopes: `sfcc.storefront.deployments` grants read-only access, and `sfcc.storefront.deployments.rw` grants read and write access. Read operations (`GET`) accept either scope; write operations (`POST`) require `sfcc.storefront.deployments.rw`.",
+    "version": "1.0.5",
+    "x-api-type": "Admin",
+    "x-api-family": "Storefront"
+  },
+  "servers": [
+    {
+      "url": "https://{shortCode}.api.commercecloud.salesforce.com/storefront/deployments/v1",
+      "variables": {
+        "shortCode": {
+          "default": "123456gf"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/organizations/{organizationId}/storefronts/{storefrontId}/bundles": {
+      "get": {
+        "summary": "Get bundles for a storefront.",
+        "description": "Retrieves a paginated list of bundles uploaded to the specified storefront.",
+        "operationId": "getBundlesForStorefront",
+        "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": "storefrontId",
+            "in": "path",
+            "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "my-storefront",
+              "maxLength": 20,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "default": 25,
+              "maximum": 200,
+              "minimum": 1
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "description": "Used to retrieve the results based on a particular resource offset.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "default": 0,
+              "minimum": 0
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of bundles successfully retrieved.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BundleResult"
+                },
+                "examples": {
+                  "BundleListSuccess": {
+                    "$ref": "#/components/examples/BundleListSuccess"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/401unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/403forbidden"
+          }
+        },
+        "security": [
+          {
+            "AmOAuth2": [
+              "sfcc.storefront.deployments",
+              "sfcc.storefront.deployments.rw"
+            ]
+          }
+        ]
+      },
+      "post": {
+        "summary": "Upload a bundle for a storefront.",
+        "description": "Uploads a bundle archive (uncompressed or gzip-compressed .tar file), which must not exceed 400 MB. Bundle configuration is derived from a configuration file inside the archive. Sent as `multipart/form-data`: the archive travels in the `bundle` part, with the remaining request metadata as sibling form fields.",
+        "operationId": "uploadBundleForStorefront",
+        "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": "storefrontId",
+            "in": "path",
+            "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "my-storefront",
+              "maxLength": 20,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/BundleUploadRequest"
+              },
+              "examples": {
+                "BundleUpload": {
+                  "summary": "Bundle upload with metadata",
+                  "description": "The `bundle` part carries the binary archive; the remaining parts carry the request metadata.",
+                  "value": {
+                    "bundle": "<binary .tar.gz archive, e.g. storefront-bundle.tar.gz>",
+                    "message": "Release 2.1.0",
+                    "rootDir": "bld",
+                    "configPath": ".mrt/config.json",
+                    "matchMode": "strict"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Bundle successfully uploaded.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/BundleUploadResponse"
+                },
+                "examples": {
+                  "BundleUploadSuccess": {
+                    "$ref": "#/components/examples/BundleUploadSuccess"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/400BadRequest_UploadBundle"
+          },
+          "401": {
+            "$ref": "#/components/responses/401unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/403forbidden"
+          }
+        },
+        "security": [
+          {
+            "AmOAuth2": [
+              "sfcc.storefront.deployments.rw"
+            ]
+          }
+        ]
+      }
+    },
+    "/organizations/{organizationId}/storefronts/{storefrontId}/environments/{environmentId}/deployments": {
+      "get": {
+        "summary": "Get deployments for an environment.",
+        "description": "Retrieves a paginated list of deployments for the specified environment.",
+        "operationId": "getDeploymentsForEnvironment",
+        "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": "storefrontId",
+            "in": "path",
+            "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "my-storefront",
+              "maxLength": 20,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "environmentId",
+            "in": "path",
+            "description": "The environment identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "production",
+              "maxLength": 19,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "default": 25,
+              "maximum": 200,
+              "minimum": 1
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "description": "Used to retrieve the results based on a particular resource offset.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32",
+              "default": 0,
+              "minimum": 0
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "List of deployments successfully retrieved.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DeploymentResult"
+                },
+                "examples": {
+                  "DeploymentListSuccess": {
+                    "$ref": "#/components/examples/DeploymentListSuccess"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/401unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/403forbidden"
+          }
+        },
+        "security": [
+          {
+            "AmOAuth2": [
+              "sfcc.storefront.deployments",
+              "sfcc.storefront.deployments.rw"
+            ]
+          }
+        ]
+      },
+      "post": {
+        "summary": "Create a deployment for an environment.",
+        "description": "Triggers a new deployment of a bundle to the specified environment. Returns immediately with a deployment resource in a queued status. Poll the deployment by ID to track progress.",
+        "operationId": "createDeploymentForEnvironment",
+        "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": "storefrontId",
+            "in": "path",
+            "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "my-storefront",
+              "maxLength": 20,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "environmentId",
+            "in": "path",
+            "description": "The environment identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "production",
+              "maxLength": 19,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/DeploymentCreateRequest"
+              },
+              "examples": {
+                "CreateDeployment": {
+                  "$ref": "#/components/examples/CreateDeployment"
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "202": {
+            "description": "Deployment successfully queued.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Deployment"
+                },
+                "examples": {
+                  "DeploymentCreatedSuccess": {
+                    "$ref": "#/components/examples/DeploymentCreatedSuccess"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/400BadRequest_CreateDeployment"
+          },
+          "401": {
+            "$ref": "#/components/responses/401unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/403forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/404NotFound_CreateDeployment"
+          },
+          "409": {
+            "$ref": "#/components/responses/409Conflict_CreateDeployment"
+          }
+        },
+        "security": [
+          {
+            "AmOAuth2": [
+              "sfcc.storefront.deployments.rw"
+            ]
+          }
+        ]
+      }
+    },
+    "/organizations/{organizationId}/storefronts/{storefrontId}/environments/{environmentId}/deployments/{deploymentId}": {
+      "get": {
+        "summary": "Get a deployment by ID.",
+        "description": "Retrieves the details of a specific deployment, including its current status and progress.",
+        "operationId": "getDeploymentById",
+        "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": "storefrontId",
+            "in": "path",
+            "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "my-storefront",
+              "maxLength": 20,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "environmentId",
+            "in": "path",
+            "description": "The environment identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "example": "production",
+              "maxLength": 19,
+              "minLength": 1,
+              "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+            }
+          },
+          {
+            "name": "deploymentId",
+            "in": "path",
+            "description": "The deployment identifier.",
+            "required": true,
+            "style": "simple",
+            "explode": false,
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Deployment successfully retrieved.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Deployment"
+                },
+                "examples": {
+                  "DeploymentSuccess": {
+                    "$ref": "#/components/examples/DeploymentSuccess"
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/401unauthorized"
+          },
+          "403": {
+            "$ref": "#/components/responses/403forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/404NotFound_GetDeployment"
+          }
+        },
+        "security": [
+          {
+            "AmOAuth2": [
+              "sfcc.storefront.deployments",
+              "sfcc.storefront.deployments.rw"
+            ]
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "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})$"
+      },
+      "Total": {
+        "type": "integer",
+        "format": "int32",
+        "default": 0,
+        "description": "The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.",
+        "example": 10,
+        "minimum": 0
+      },
+      "ResultBase": {
+        "type": "object",
+        "description": "Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. \nAdditionally it needs to be defined what data is returned.",
+        "properties": {
+          "limit": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter `limit` of the endpoint returning this schema.",
+            "example": 10
+          },
+          "total": {
+            "$ref": "#/components/schemas/Total"
+          }
+        },
+        "required": [
+          "limit",
+          "total"
+        ]
+      },
+      "Offset": {
+        "type": "integer",
+        "format": "int32",
+        "default": 0,
+        "description": "The zero-based index of the first hit/data to include in the result.",
+        "example": 0,
+        "minimum": 0
+      },
+      "PaginatedResultBase": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ResultBase"
+          }
+        ],
+        "description": "Schema defining generic pageable result. Each response schema of a resource requiring pagination should extend this schema. \nIf you use this extend this schema directly, it needs to be defined what data is returned. Allowed names for the data field is `data`.",
+        "properties": {
+          "offset": {
+            "$ref": "#/components/schemas/Offset"
+          }
+        },
+        "required": [
+          "limit",
+          "offset",
+          "total"
+        ]
+      },
+      "Bundle": {
+        "type": "object",
+        "description": "A versioned build artifact (SSR application package) uploaded to a storefront.",
+        "properties": {
+          "bundleId": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The unique identifier of the bundle.",
+            "example": 170
+          },
+          "description": {
+            "type": "string",
+            "description": "A user-provided message describing the bundle.",
+            "example": "my bundle",
+            "maxLength": 2048
+          },
+          "status": {
+            "type": "string",
+            "description": "The processing status of the bundle.",
+            "enum": [
+              "ok",
+              "broken",
+              "preparing"
+            ],
+            "example": "ok"
+          },
+          "lifecycleStatus": {
+            "type": "string",
+            "description": "The lifecycle status of the bundle.",
+            "enum": [
+              "active",
+              "cleanup_requested",
+              "cleanup_in_progress",
+              "cleanup_complete",
+              "cleanup_failed"
+            ],
+            "example": "active"
+          },
+          "createdBy": {
+            "type": "string",
+            "description": "The email address of the user who uploaded the bundle. Null if no user is associated.",
+            "example": "dev@example.com",
+            "maxLength": 254
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The timestamp when the bundle was created.",
+            "example": "2026-04-08T21:47:28.188965Z"
+          },
+          "lastModified": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The timestamp when the bundle was last modified.",
+            "example": "2026-04-08T21:47:31.307595Z"
+          },
+          "type": {
+            "type": "string",
+            "description": "The bundle type.",
+            "enum": [
+              "ssr",
+              "legacy"
+            ],
+            "example": "ssr"
+          },
+          "ssrParameters": {
+            "type": "object",
+            "description": "SSR configuration parameters for this bundle. Null for non-SSR bundles.",
+            "properties": {
+              "runtime": {
+                "type": "string",
+                "description": "The Node.js runtime version used by this bundle.",
+                "example": "24.x",
+                "maxLength": 256
+              },
+              "runtimeDescription": {
+                "type": "string",
+                "description": "Human-readable description of the runtime version.",
+                "example": "NodeJS 24.x",
+                "maxLength": 256
+              },
+              "envBasePath": {
+                "type": "string",
+                "description": "The base path for the environment associated with this bundle.",
+                "example": "ca",
+                "maxLength": 256
+              }
+            }
+          },
+          "inUseBy": {
+            "type": "array",
+            "description": "List of environment identifiers where this bundle is currently deployed.",
+            "example": [
+              "production"
+            ],
+            "items": {
+              "type": "string",
+              "example": "production",
+              "maxLength": 256
+            }
+          },
+          "streamingEnabled": {
+            "type": "boolean",
+            "description": "Whether streaming is enabled for this bundle.",
+            "example": false
+          }
+        }
+      },
+      "BundleResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginatedResultBase"
+          }
+        ],
+        "description": "Paginated result containing a list of bundles.",
+        "properties": {
+          "data": {
+            "type": "array",
+            "description": "List of bundles.",
+            "items": {
+              "$ref": "#/components/schemas/Bundle"
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
+      "ErrorResponse": {
+        "type": "object",
+        "additionalProperties": true,
+        "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",
+            "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
+          }
+        },
+        "required": [
+          "detail",
+          "title",
+          "type"
+        ]
+      },
+      "BundleUploadRequest": {
+        "type": "object",
+        "description": "Request body to upload a bundle, sent as `multipart/form-data`. The archive travels in the `bundle` part, with the remaining request metadata as sibling form fields.",
+        "properties": {
+          "bundle": {
+            "type": "string",
+            "format": "binary",
+            "description": "Bundle archive (uncompressed or gzip-compressed .tar file). The uploaded archive must not exceed 400 MB.",
+            "example": "UEdKcGJtRnllU0F1ZEdGeUxtZDZJR0Z5WTJocGRtVXNJR1V1Wnk0Z2MzUnZjbVZtY205dWRDMWlkVzVrYkdVdWRHRnlMbWQ2UGc9PQ=="
+          },
+          "message": {
+            "type": "string",
+            "description": "Bundle description (optional metadata).",
+            "example": "Release 2.1.0",
+            "maxLength": 2048
+          },
+          "rootDir": {
+            "type": "string",
+            "default": "bld",
+            "description": "Root directory within bundle archive. Files in this directory are used for server-side rendering, published as static assets, or both. Any files in the bundle archive outside of this directory are ignored.",
+            "example": "bld",
+            "maxLength": 256
+          },
+          "configPath": {
+            "type": "string",
+            "default": ".mrt/config.json",
+            "description": "Path (relative to root directory) of bundle configuration file.",
+            "example": ".mrt/config.json",
+            "maxLength": 256
+          },
+          "matchMode": {
+            "type": "string",
+            "default": "strict",
+            "description": "Determines how files in the bundle configuration are matched. If `strict`, all files listed in `ssrOnly` and `ssrShared` fields in the bundle configuration must be present. If `ignore_missing`, missing files in the `ssrOnly` and `ssrShared` fields are ignored.",
+            "enum": [
+              "strict",
+              "ignore_missing"
+            ],
+            "example": "strict"
+          }
+        },
+        "required": [
+          "bundle"
+        ]
+      },
+      "BundleUploadResponse": {
+        "type": "object",
+        "description": "Response returned after a successful bundle upload.",
+        "properties": {
+          "bundleId": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The unique identifier of the uploaded bundle.",
+            "example": 170
+          },
+          "warnings": {
+            "type": "array",
+            "description": "List of warnings generated during bundle processing.",
+            "example": [],
+            "items": {
+              "type": "string",
+              "example": "Deprecated runtime version detected",
+              "maxLength": 4000
+            }
+          },
+          "matches": {
+            "type": "object",
+            "description": "File matching results from bundle analysis.",
+            "properties": {
+              "ssrOnly": {
+                "type": "array",
+                "description": "Files matched as SSR-only (server-side only).",
+                "example": [
+                  "ssr.js"
+                ],
+                "items": {
+                  "type": "string",
+                  "example": "ssr.js",
+                  "maxLength": 640
+                }
+              },
+              "ssrShared": {
+                "type": "array",
+                "description": "Files matched as SSR-shared (used by both server and client).",
+                "example": [
+                  "shared.js"
+                ],
+                "items": {
+                  "type": "string",
+                  "example": "shared.js",
+                  "maxLength": 640
+                }
+              }
+            }
+          }
+        }
+      },
+      "BundleValidationFailedErrorResponse": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        ],
+        "description": "Returned when the uploaded bundle fails validation.",
+        "properties": {
+          "error": {
+            "type": "string",
+            "description": "A human-readable description of why bundle validation failed.",
+            "example": "missing entry point",
+            "maxLength": 4000
+          }
+        }
+      },
+      "Deployment": {
+        "type": "object",
+        "description": "A deployment action that publishes a bundle to an environment.",
+        "properties": {
+          "deploymentId": {
+            "type": "string",
+            "description": "The unique identifier of the deployment, in UUID format.",
+            "example": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8",
+            "maxLength": 36,
+            "minLength": 36,
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+          },
+          "status": {
+            "type": "string",
+            "description": "The current status of the deployment.",
+            "enum": [
+              "queued",
+              "in_progress",
+              "failed",
+              "finished"
+            ],
+            "example": "finished"
+          },
+          "deploymentType": {
+            "type": "string",
+            "description": "The type of deployment.",
+            "enum": [
+              "publish",
+              "reset_bundle",
+              "push",
+              "deploy_settings",
+              "redeploy"
+            ],
+            "example": "publish"
+          },
+          "creationDate": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The timestamp when the deployment was created.",
+            "example": "2026-04-08T21:47:31.322339Z"
+          },
+          "lastModified": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The timestamp when the deployment was last modified.",
+            "example": "2026-04-08T21:51:55.692688Z"
+          },
+          "duration": {
+            "type": "number",
+            "format": "double",
+            "description": "The duration of the deployment in seconds. Null if the deployment has not finished.",
+            "example": 76.867967
+          },
+          "createdBy": {
+            "type": "string",
+            "description": "The email address of the user who triggered the deployment. Null if no user is associated.",
+            "example": "dev@example.com",
+            "maxLength": 254
+          },
+          "statusMessage": {
+            "type": "string",
+            "description": "A human-readable message about the deployment's current state.",
+            "example": "Queueing Bundle",
+            "maxLength": 4096
+          },
+          "progress": {
+            "type": "object",
+            "description": "Progress information for the deployment. Null unless an external publish is in progress.",
+            "properties": {
+              "description": {
+                "type": "string",
+                "description": "A human-readable description of the current deployment stage.",
+                "example": "Updating CDN",
+                "maxLength": 128
+              },
+              "percentage": {
+                "type": "integer",
+                "format": "int32",
+                "description": "Percentage of deployment completion.",
+                "example": 0,
+                "maximum": 100,
+                "minimum": 0
+              }
+            }
+          },
+          "bundle": {
+            "$ref": "#/components/schemas/Bundle"
+          }
+        }
+      },
+      "DeploymentResult": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PaginatedResultBase"
+          }
+        ],
+        "description": "Paginated result containing a list of deployments.",
+        "properties": {
+          "data": {
+            "type": "array",
+            "description": "List of deployments.",
+            "items": {
+              "$ref": "#/components/schemas/Deployment"
+            }
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
+      "DeploymentCreateRequest": {
+        "type": "object",
+        "description": "Request body to create a new deployment.",
+        "properties": {
+          "bundleId": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The identifier of the bundle to deploy.",
+            "example": 170
+          }
+        },
+        "required": [
+          "bundleId"
+        ]
+      },
+      "InvalidDeploymentRequestErrorResponse": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        ],
+        "description": "Returned when the deployment request body is malformed or missing a valid bundleId."
+      },
+      "BundleNotFoundErrorResponse": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        ],
+        "description": "Returned when the bundle referenced by the deployment request does not exist for this storefront.",
+        "properties": {
+          "bundleId": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The identifier of the bundle that couldn't be found.",
+            "example": 999
+          }
+        }
+      },
+      "DeploymentConflictErrorResponse": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        ],
+        "description": "Returned when a deployment cannot proceed because another deployment or deletion is already in progress for the environment."
+      },
+      "DeploymentNotFoundErrorResponse": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        ],
+        "description": "Returned when the requested deployment does not exist."
+      }
+    },
+    "responses": {
+      "401unauthorized": {
+        "description": "Your access token is invalid or expired and can’t be used to identify a user.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorResponse"
+            },
+            "examples": {
+              "UnauthorizedExample": {
+                "$ref": "#/components/examples/UnauthorizedExample"
+              }
+            }
+          }
+        }
+      },
+      "403forbidden": {
+        "description": "Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/ErrorResponse"
+            },
+            "examples": {
+              "ForbiddenExample": {
+                "$ref": "#/components/examples/ForbiddenExample"
+              }
+            }
+          }
+        }
+      },
+      "400BadRequest_UploadBundle": {
+        "description": "Bad Request. The uploaded bundle failed validation.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/BundleValidationFailedErrorResponse"
+            },
+            "examples": {
+              "BundleValidationFailedErrorResponseExample": {
+                "$ref": "#/components/examples/BundleValidationFailedErrorResponseExample"
+              }
+            }
+          }
+        }
+      },
+      "400BadRequest_CreateDeployment": {
+        "description": "Bad Request. The deployment request body is invalid.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/InvalidDeploymentRequestErrorResponse"
+            },
+            "examples": {
+              "InvalidDeploymentRequestErrorResponseExample": {
+                "$ref": "#/components/examples/InvalidDeploymentRequestErrorResponseExample"
+              }
+            }
+          }
+        }
+      },
+      "404NotFound_CreateDeployment": {
+        "description": "The bundle referenced by the deployment request was not found for this storefront.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/BundleNotFoundErrorResponse"
+            },
+            "examples": {
+              "BundleNotFoundErrorResponseExample": {
+                "$ref": "#/components/examples/BundleNotFoundErrorResponseExample"
+              }
+            }
+          }
+        }
+      },
+      "409Conflict_CreateDeployment": {
+        "description": "The deployment cannot proceed because another deployment or deletion is already in progress for this environment.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/DeploymentConflictErrorResponse"
+            },
+            "examples": {
+              "DeploymentConflictErrorResponseExample": {
+                "$ref": "#/components/examples/DeploymentConflictErrorResponseExample"
+              }
+            }
+          }
+        }
+      },
+      "404NotFound_GetDeployment": {
+        "description": "The requested deployment was not found.",
+        "content": {
+          "application/problem+json": {
+            "schema": {
+              "$ref": "#/components/schemas/DeploymentNotFoundErrorResponse"
+            },
+            "examples": {
+              "DeploymentNotFoundErrorResponseExample": {
+                "$ref": "#/components/examples/DeploymentNotFoundErrorResponseExample"
+              }
+            }
+          }
+        }
+      }
+    },
+    "parameters": {
+      "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"
+      },
+      "storefrontId": {
+        "name": "storefrontId",
+        "in": "path",
+        "description": "The storefront identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+        "required": true,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string",
+          "example": "my-storefront",
+          "maxLength": 20,
+          "minLength": 1,
+          "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+        }
+      },
+      "environmentId": {
+        "name": "environmentId",
+        "in": "path",
+        "description": "The environment identifier. Must consist only of lowercase letters, numbers, and hyphens, with no leading or trailing hyphens.",
+        "required": true,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string",
+          "example": "production",
+          "maxLength": 19,
+          "minLength": 1,
+          "pattern": "^[a-z0-9]+(?:-+[a-z0-9]+)*$"
+        }
+      },
+      "deploymentId": {
+        "name": "deploymentId",
+        "in": "path",
+        "description": "The deployment identifier.",
+        "required": true,
+        "style": "simple",
+        "explode": false,
+        "schema": {
+          "type": "string",
+          "format": "uuid",
+          "example": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8"
+        }
+      }
+    },
+    "examples": {
+      "BundleListSuccess": {
+        "summary": "Successful bundle list result",
+        "description": "Example of a successful response returning a paginated list of bundles for a storefront.",
+        "value": {
+          "limit": 25,
+          "offset": 0,
+          "total": 3,
+          "data": [
+            {
+              "bundleId": 170,
+              "description": "my bundle",
+              "status": "ok",
+              "lifecycleStatus": "active",
+              "createdBy": "dev@example.com",
+              "creationDate": "2026-04-08T21:47:28.188965Z",
+              "lastModified": "2026-04-08T21:47:31.307595Z",
+              "type": "ssr",
+              "ssrParameters": {
+                "runtime": "24.x",
+                "runtimeDescription": "NodeJS 24.x",
+                "envBasePath": "ca"
+              },
+              "inUseBy": [
+                "production"
+              ],
+              "streamingEnabled": true
+            },
+            {
+              "bundleId": 169,
+              "description": "previous release",
+              "status": "ok",
+              "lifecycleStatus": "active",
+              "createdBy": "dev@example.com",
+              "creationDate": "2026-04-07T15:30:00.000000Z",
+              "lastModified": "2026-04-07T15:30:05.000000Z",
+              "type": "ssr",
+              "ssrParameters": {
+                "runtime": "24.x",
+                "runtimeDescription": "NodeJS 24.x",
+                "envBasePath": "ca"
+              },
+              "inUseBy": [],
+              "streamingEnabled": false
+            }
+          ]
+        }
+      },
+      "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"
+        }
+      },
+      "BundleUploadSuccess": {
+        "summary": "Successful bundle upload",
+        "description": "Example of a successful response after uploading a bundle.",
+        "value": {
+          "bundleId": 170,
+          "warnings": [],
+          "matches": {
+            "ssrOnly": [
+              "ssr.js",
+              "worker.js"
+            ],
+            "ssrShared": [
+              "shared.js",
+              "utils.js"
+            ]
+          }
+        }
+      },
+      "DeploymentListSuccess": {
+        "summary": "Successful deployment list result",
+        "description": "Example of a successful response returning a paginated list of deployments for an environment.",
+        "value": {
+          "limit": 25,
+          "offset": 0,
+          "total": 1,
+          "data": [
+            {
+              "deploymentId": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8",
+              "status": "finished",
+              "deploymentType": "publish",
+              "creationDate": "2026-04-08T21:47:31.322339Z",
+              "lastModified": "2026-04-08T21:51:55.692688Z",
+              "duration": 76.867967,
+              "createdBy": "dev@example.com",
+              "statusMessage": "Deploy Finished",
+              "bundle": {
+                "bundleId": 170,
+                "description": "my bundle",
+                "status": "ok",
+                "lifecycleStatus": "active",
+                "createdBy": "dev@example.com",
+                "creationDate": "2026-04-08T21:47:28.188965Z",
+                "lastModified": "2026-04-08T21:47:31.307595Z",
+                "type": "ssr",
+                "ssrParameters": {
+                  "runtime": "24.x",
+                  "runtimeDescription": "NodeJS 24.x",
+                  "envBasePath": "ca"
+                },
+                "inUseBy": [
+                  "production"
+                ],
+                "streamingEnabled": true
+              }
+            }
+          ]
+        }
+      },
+      "CreateDeployment": {
+        "summary": "Create a deployment",
+        "description": "Trigger a deployment of a bundle to an environment by its bundleId.",
+        "value": {
+          "bundleId": 170
+        }
+      },
+      "DeploymentCreatedSuccess": {
+        "summary": "Successful deployment creation",
+        "description": "Example of a successful response when a new deployment is triggered (202 Accepted).",
+        "value": {
+          "deploymentId": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8",
+          "status": "queued",
+          "deploymentType": "publish",
+          "creationDate": "2026-04-08T21:47:31.322339Z",
+          "lastModified": "2026-04-08T21:47:31.322339Z",
+          "createdBy": "dev@example.com",
+          "statusMessage": "Queueing Bundle",
+          "bundle": {
+            "bundleId": 170,
+            "description": "my bundle",
+            "status": "ok",
+            "lifecycleStatus": "active",
+            "createdBy": "dev@example.com",
+            "creationDate": "2026-04-08T21:47:28.188965Z",
+            "lastModified": "2026-04-08T21:47:31.307595Z",
+            "type": "ssr",
+            "ssrParameters": {
+              "runtime": "24.x",
+              "runtimeDescription": "NodeJS 24.x",
+              "envBasePath": "ca"
+            },
+            "inUseBy": [
+              "production"
+            ],
+            "streamingEnabled": true
+          }
+        }
+      },
+      "DeploymentSuccess": {
+        "summary": "Successful deployment retrieval",
+        "description": "Example of a successful response returning a single deployment with all properties.",
+        "value": {
+          "deploymentId": "b035a4d7-ec6b-4dcd-af8f-3a847b10fed8",
+          "status": "finished",
+          "deploymentType": "publish",
+          "creationDate": "2026-04-08T21:47:31.322339Z",
+          "lastModified": "2026-04-08T21:51:55.692688Z",
+          "duration": 76.867967,
+          "createdBy": "dev@example.com",
+          "statusMessage": "Deploy Finished",
+          "progress": {
+            "description": "Finished deployment",
+            "percentage": 100
+          },
+          "bundle": {
+            "bundleId": 170,
+            "description": "my bundle",
+            "status": "ok",
+            "lifecycleStatus": "active",
+            "createdBy": "dev@example.com",
+            "creationDate": "2026-04-08T21:47:28.188965Z",
+            "lastModified": "2026-04-08T21:47:31.307595Z",
+            "type": "ssr",
+            "ssrParameters": {
+              "runtime": "24.x",
+              "runtimeDescription": "NodeJS 24.x",
+              "envBasePath": "ca"
+            },
+            "inUseBy": [
+              "production"
+            ],
+            "streamingEnabled": true
+          }
+        }
+      },
+      "BundleValidationFailedErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bundle-validation-failed",
+          "detail": "We couldn't validate the bundle for these reasons: missing entry point",
+          "title": "Bundle Validation Failed"
+        }
+      },
+      "InvalidDeploymentRequestErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-deployment-request",
+          "detail": "The deployment request body is invalid. A valid bundleId is required.",
+          "title": "Invalid Deployment Request"
+        }
+      },
+      "BundleNotFoundErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bundle-not-found",
+          "detail": "We couldn't find bundle 999.",
+          "title": "Bundle Not Found"
+        }
+      },
+      "DeploymentConflictErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/deployment-conflict",
+          "detail": "You can't request a deployment when another deployment or deletion is in progress.",
+          "title": "Deployment Conflict"
+        }
+      },
+      "DeploymentNotFoundErrorResponseExample": {
+        "value": {
+          "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/deployment-not-found",
+          "detail": "We couldn't find that deployment.",
+          "title": "Deployment Not Found"
+        }
+      }
+    },
+    "securitySchemes": {
+      "AmOAuth2": {
+        "type": "oauth2",
+        "description": "AccountManager OAuth 2.0 bearer token Authentication.",
+        "flows": {
+          "clientCredentials": {
+            "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {
+              "sfcc.storefront.deployments": "Read-only access to the Deployments API.",
+              "sfcc.storefront.deployments.rw": "Read and write access to the Deployments API."
+            }
+          },
+          "authorizationCode": {
+            "authorizationUrl": "https://account.demandware.com/dwsso/oauth2/authorize",
+            "tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
+            "scopes": {
+              "sfcc.storefront.deployments": "Read-only access to the Deployments API.",
+              "sfcc.storefront.deployments.rw": "Read and write access to the Deployments API."
+            }
+          }
+        }
+      }
+    }
+  }
+}