@salesforce/b2c-tooling-sdk 1.15.1 → 1.17.0

package/data/content-schemas/regiondefinition.json

@@ -6,6 +6,7 @@
   "properties": {
     "id": {"$ref":"common.json#/definitions/id"},
     "name": {"$ref":"common.json#/definitions/name"},
+    "description": {"$ref":"common.json#/definitions/description"},
     "max_components": {
       "type": "integer",
       "minimum": 1

package/data/job-steps/CatalogDeltaExport.md

@@ -0,0 +1,31 @@
+<!-- prettier-ignore-start -->
+# Job Step: CatalogDeltaExport
+
+**Type ID:** `CatalogDeltaExport`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Creates Delta Export for Catalogs. Support must be contacted to enable delta exports.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CatalogIDs` | Yes | — | — | Comma Separated list of Catalog Ids to be exported. Character limit 1000 |
+| `Consumers` | Yes | — | — | Comma Separated List of consumers. Character limit 1000 |
+| `ExportFile` | Yes | — | — | Delta Export name and Export file name and path relative to 'IMPEX/src'. |
+| `MasterProductExport` | No | `false` | — | If selected, the option exports all changes with the master product. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/CreateSitemap.md

@@ -0,0 +1,22 @@
+<!-- prettier-ignore-start -->
+# Job Step: CreateSitemap
+
+**Type ID:** `CreateSitemap`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Creates Sitemap.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+This step takes no configuration parameters.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/CustomerListsDeltaExport.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: CustomerListsDeltaExport
+
+**Type ID:** `CustomerListsDeltaExport`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Creates Delta Export for Customer Lists. Support must be contacted to enable delta exports.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `Consumers` | Yes | — | — | Comma separated List of consumers, Character limit 1000 |
+| `CustomerLists` | Yes | — | — | Comma separated list of Customers, Character limit 1000 |
+| `ExportFile` | Yes | — | — | Delta Export name and Export file name and path relative to 'IMPEX/src'. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/DownloadActiveDataFromStorage.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: DownloadActiveDataFromStorage
+
+**Type ID:** `DownloadActiveDataFromStorage`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Download active data from storage system to current site. This step downloads active data to the new site from storage system during a site move if active data is required to migrate to the new site. Before this step can run, set the new site to 'Online' mode. This prevents premature migration for the new site. The StorageFolderName parameter needs to use the value from UploadActiveDataToStorageStep's log.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `StorageFolderName` | Yes | — | — | This is the storage folder name created by the UploadActiveDataToStorage step. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecuteCategorizationRules.md

@@ -0,0 +1,25 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecuteCategorizationRules
+
+**Type ID:** `ExecuteCategorizationRules`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Executes the Categorization based on the Categorization Rules and Conditions defined on a CatalogCategory.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CatalogID` | Yes | — | — | The Catalog Id which needs Categorization. |
+| `CategoryID` | Yes | — | — | The Category Id which needs Categorization. If we need to run the Categorization for all Categories, this should be set as 'ALL'. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecuteDataReplication.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecuteDataReplication
+
+**Type ID:** `ExecuteDataReplication`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Replicates data to a target system. The ReplicationConfiguration parameter requires a string in JSON format that describes the replication process and its tasks that will be executed. The parameter section that describes the tasks is similar to the Replication Tasks step of the Business Manager Data Replication wizard. Replication tasks not included in the JSON are not included in the data replication process. Replication tasks set to 'false' are also not included in the data replication process.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ReplicationConfiguration` | Yes | — | — | Describes the replication process and its replication tasks that will be executed. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecutePipeline.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecutePipeline
+
+**Type ID:** `ExecutePipeline`  
+**Scope:** Organization & Sites (add to an organization- or site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Executes a pipeline. The name and start node of the pipeline has to be configured at parameter 'ExecutePipeline.Pipeline'. This step has been provided to ease the transition from pipeline based jobs to the new job framework. To fully leverage the new framework use system or custom job steps. Deprecated: This job step is deprecated. We recommend you replace pipelines with system job steps and custom job steps.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExecutePipeline.Pipeline` | Yes | — | — | The process pipeline to execute, e.g. 'MyProcessPipeline-Start'. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecutePreconfiguredCodeReplicationProcess.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecutePreconfiguredCodeReplicationProcess
+
+**Type ID:** `ExecutePreconfiguredCodeReplicationProcess`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Executes the preconfigured code replication process with the ID defined at parameter 'ReplicationProcessID'. The code replication process has to be created / configured using the BM UI for code replication, with activation set to 'Job Step' and type 'Code Transfer & Activation'.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ReplicationProcessID` | Yes | — | — | The ID of the preconfigured replication process. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecutePreconfiguredDataReplicationProcess.md

@@ -0,0 +1,24 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecutePreconfiguredDataReplicationProcess
+
+**Type ID:** `ExecutePreconfiguredDataReplicationProcess`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Executes the preconfigured data replication process with the ID defined at parameter 'ReplicationProcessID'. The data replication process has to be created / configured using the BM UI for data replication, with activation set to 'Job Step' and type 'Transfer & Publication'.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ReplicationProcessID` | Yes | — | — | The ID of the preconfigured replication process. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExecuteScriptModule.md

@@ -0,0 +1,27 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExecuteScriptModule
+
+**Type ID:** `ExecuteScriptModule`  
+**Scope:** Organization & Sites (add to an organization- or site-level job flow)  
+**Category:** Standard / system job step (Processing)
+
+Executes a function exported by a script module. The module ID has to be configured at parameter 'ExecuteScriptModule.Module'. Deprecated: This job step is deprecated. We recommend that you use the steptypes.json file to execute a script.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExecuteScriptModule.Module` | Yes | — | — | The ID of the script module, e.g. my_cartridge/cartridge/scripts/job/myScriptModule.js |
+| `ExecuteScriptModule.FunctionName` | No | `execute` | — | The name of the script module's exported function to execute. If not defined teh script is supposed to export a function named 'execute'. |
+| `ExecuteScriptModule.TimeoutInSeconds` | No | — | — | The timeout in seconds for the script module's function. If not defined the batch processing framework applies the default timeout. |
+| `ExecuteScriptModule.Transactional` | No | `false` | — | Indicates if the script module's function requires transaction handling. The default value is 'false'. To avoid a negative impact on system performance and allow more granular transaction control, keep the default setting of 'false'. Implement transaction handling within the job step using the dw.system.Transaction API. |
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportABTests.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportABTests
+
+**Type ID:** `ExportABTests`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports A/B tests.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportAssignments.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportAssignments
+
+**Type ID:** `ExportAssignments`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports all assignments in the system.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCatalog.md

@@ -0,0 +1,37 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCatalog
+
+**Type ID:** `ExportCatalog`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports catalog data.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CatalogID` | Yes | — | — | The ID of the catalog which will be exported. |
+| `ExportCategories` | No | `true` | — | Optional flag indicating whether to export categories or not. |
+| `ExportCategoryAssignments` | No | `true` | — | Optional flag indicating whether to export category assignments or not. |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `ExportProductOptions` | No | `true` | — | Optional flag indicating whether to export product options or not. |
+| `ExportProducts` | No | `true` | — | Optional flag indicating whether to export products or not. |
+| `ExportRecommendations` | No | `true` | — | Optional flag indicating whether to export recommendations or not. |
+| `ExportVariationAttributes` | No | `true` | — | Optional flag indicating whether to export variation attributes or not. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportContent.md

@@ -0,0 +1,31 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportContent
+
+**Type ID:** `ExportContent`  
+**Scope:** Organization & Sites (add to an organization- or site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports the folders in the specified content Library.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `LibraryID` | Yes | — | — | Content Library Id of the library to export. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportContentSlots.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportContentSlots
+
+**Type ID:** `ExportContentSlots`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports all content slot data.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCouponCodes.md

@@ -0,0 +1,33 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCouponCodes
+
+**Type ID:** `ExportCouponCodes`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports the codes of a specified coupon.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CouponID` | Yes | — | — | The ID of the coupon whose codes being exported. |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `NumberOfCodes` | No | — | — | The number of coupon codes being exported. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+| `StartFrom` | No | — | — | The start from position for coupon codes being exported. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCoupons.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCoupons
+
+**Type ID:** `ExportCoupons`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports coupons.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCustomObjects.md

@@ -0,0 +1,31 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCustomObjects
+
+**Type ID:** `ExportCustomObjects`  
+**Scope:** Organization & Sites (add to an organization- or site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports custom objects of a specified type and scope. The scope of the job flow (Organization or Sites) must match the scope of the custom object type.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CustomObjectTypeID` | Yes | — | — | The ID of the custom object type. |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCustomerGroups.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCustomerGroups
+
+**Type ID:** `ExportCustomerGroups`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports all customer groups.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCustomerList.md

@@ -0,0 +1,31 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCustomerList
+
+**Type ID:** `ExportCustomerList`  
+**Scope:** Organization (add to an organization-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports a customer list, it's preferences as well as the customers assigned to the customer list.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `CustomerListID` | Yes | — | — | The ID of the customer list which will be exported. |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->

package/data/job-steps/ExportCustomers.md

@@ -0,0 +1,30 @@
+<!-- prettier-ignore-start -->
+# Job Step: ExportCustomers
+
+**Type ID:** `ExportCustomers`  
+**Scope:** Site (add to a site-level job flow)  
+**Category:** Standard / system job step (Export)
+
+Exports the customer profiles from the default customer list of the given site.
+
+This is a built-in (standard) job step provided by the B2C Commerce platform. Add it to a job flow in **Business Manager → Administration → Operations → Jobs**, or reference it by its type ID in a `jobs.xml` flow inside a site-import archive.
+
+## Configuration Parameters
+
+| Parameter | Required | Default | Allowed Values | Description |
+| --- | --- | --- | --- | --- |
+| `ExportFile` | No | — | — | Export file name and path relative to 'IMPEX/src'. Required if not using FileNamePrefix. |
+| `FileNamePrefix` | No | — | — | Prefix for the export file. A timestamp is appended and site information as applicable. To order the files chronologically, sort alphanumerically. Path is relative to 'IMPEX/src' and can include a subdirectory. Required if not using ExportFile. |
+| `OverwriteExportFile` | No | `true` | — | If selected, the option overwrites an existing file. If not selected and a file exists, the job step exits and reports an error. |
+
+## Working With IMPEX Files
+
+This step writes a file into the instance IMPEX area (typically under `IMPEX/src/...`). The produced file can be consumed by a later step in the same flow (for example a replication or a custom processing step) or downloaded via WebDAV. See the `b2c:b2c-custom-job-steps` skill for IMPEX hand-off patterns.
+
+## Related
+
+- Run a job that uses this step: `b2c job run <job-id>` (see the `b2c-cli:b2c-job` skill).
+- Author custom steps to chain with this one: `b2c:b2c-custom-job-steps` skill.
+- Find more docs: `b2c docs search <term>` and `b2c docs read <id>`.
+
+<!-- prettier-ignore-end -->