sfcc-dev-mcp 1.0.15 → 1.0.19

package/dist/core/tool-schemas/system-object-tools.js

@@ -0,0 +1,126 @@
+/**
+ * System Object Tool Schemas
+ */
+import { createSearchRequestSchema } from './shared-schemas.js';
+export const SYSTEM_OBJECT_TOOLS = [
+    {
+        name: 'get_system_object_definitions',
+        description: 'Get all system object definitions with metadata (not attributes). Use to discover available objects and identify Custom Objects via the _type field.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                start: {
+                    type: 'number',
+                    description: 'Start index for pagination (default: 0)',
+                    default: 0,
+                },
+                count: {
+                    type: 'number',
+                    description: 'Number of items to return (default: 200)',
+                    default: 200,
+                },
+                select: {
+                    type: 'string',
+                    description: 'OCAPI field selector. Examples: "(**)" for all, "(data.(object_type, display_name))" for specific fields.',
+                    default: '(**)',
+                },
+            },
+        },
+    },
+    {
+        name: 'get_system_object_definition',
+        description: 'Get metadata for a specific system object (attribute count, group count, flags). For attribute details, use search_system_object_attribute_definitions. Does not work for Custom Objects.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                objectType: {
+                    type: 'string',
+                    description: 'System object type, e.g., "Product", "Customer", "Order", "Category".',
+                },
+            },
+            required: ['objectType'],
+        },
+    },
+    {
+        name: 'search_system_object_attribute_definitions',
+        description: 'Search attribute definitions within a system object. Supports text search, filtering by mandatory/searchable/system, and sorting. Use match_all_query to get all attributes.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                objectType: {
+                    type: 'string',
+                    description: 'System object type, e.g., "Product", "Customer", "Order".',
+                },
+                searchRequest: createSearchRequestSchema('Query to filter attribute definitions'),
+            },
+            required: ['objectType', 'searchRequest'],
+        },
+    },
+    {
+        name: 'search_site_preferences',
+        description: 'Search site preferences by name, description, or type. Use to validate preference names and types when working with Site.getCurrent().getCustomPreferenceValue() or dw.system.Site.current.preferences.custom.*.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                groupId: {
+                    type: 'string',
+                    description: 'The ID of the preference group to search within',
+                },
+                instanceType: {
+                    type: 'string',
+                    enum: ['staging', 'development', 'sandbox', 'production'],
+                    description: 'The instance type to search preferences for. Since this MCP server is aimed at development and testing, the default is "sandbox".',
+                    default: 'sandbox',
+                },
+                searchRequest: createSearchRequestSchema('Query to filter site preferences'),
+                options: {
+                    type: 'object',
+                    description: 'Additional options for the search',
+                    properties: {
+                        maskPasswords: {
+                            type: 'boolean',
+                            description: 'Whether to mask password type preference values (default: true)',
+                            default: true,
+                        },
+                        expand: {
+                            type: 'string',
+                            description: 'Expand options (use "value" to retrieve value definitions)',
+                        },
+                    },
+                },
+            },
+            required: ['groupId', 'instanceType', 'searchRequest'],
+        },
+    },
+    {
+        name: 'search_system_object_attribute_groups',
+        description: 'Search attribute groups for a system object. Use "SitePreferences" as objectType to find preference groups needed for the site preferences API.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                objectType: {
+                    type: 'string',
+                    description: 'System object type, e.g., "Product", "Customer", "SitePreferences".',
+                },
+                searchRequest: createSearchRequestSchema('Query to filter attribute groups'),
+            },
+            required: ['objectType', 'searchRequest'],
+        },
+    },
+    {
+        name: 'search_custom_object_attribute_definitions',
+        description: 'Search attribute definitions within a custom object type (user-defined objects, not system objects). Supports text search, filtering, and sorting.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                objectType: {
+                    type: 'string',
+                    description: 'Custom object type, e.g., "Global_String", "MyCustomObject".',
+                },
+                searchRequest: createSearchRequestSchema('Query to filter attribute definitions'),
+            },
+            required: ['objectType', 'searchRequest'],
+        },
+    },
+];
+//# sourceMappingURL=system-object-tools.js.map

package/dist/core/tool-schemas/system-object-tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-object-tools.js","sourceRoot":"","sources":["../../../src/core/tool-schemas/system-object-tools.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC;QACE,IAAI,EAAE,+BAA+B;QACrC,WAAW,EAAE,sJAAsJ;QACnK,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,yCAAyC;oBACtD,OAAO,EAAE,CAAC;iBACX;gBACD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,0CAA0C;oBACvD,OAAO,EAAE,GAAG;iBACb;gBACD,MAAM,EAAE;oBACN,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2GAA2G;oBACxH,OAAO,EAAE,MAAM;iBAChB;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,8BAA8B;QACpC,WAAW,EAAE,2LAA2L;QACxM,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,uEAAuE;iBACrF;aACF;YACD,QAAQ,EAAE,CAAC,YAAY,CAAC;SACzB;KACF;IACD;QACE,IAAI,EAAE,4CAA4C;QAClD,WAAW,EAAE,8KAA8K;QAC3L,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2DAA2D;iBACzE;gBACD,aAAa,EAAE,yBAAyB,CAAC,uCAAuC,CAAC;aAClF;YACD,QAAQ,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC;SAC1C;KACF;IACD;QACE,IAAI,EAAE,yBAAyB;QAC/B,WAAW,EAAE,kNAAkN;QAC/N,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iDAAiD;iBAC/D;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,YAAY,CAAC;oBACzD,WAAW,EAAE,mIAAmI;oBAChJ,OAAO,EAAE,SAAS;iBACnB;gBACD,aAAa,EAAE,yBAAyB,CAAC,kCAAkC,CAAC;gBAC5E,OAAO,EAAE;oBACP,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,mCAAmC;oBAChD,UAAU,EAAE;wBACV,aAAa,EAAE;4BACb,IAAI,EAAE,SAAS;4BACf,WAAW,EAAE,iEAAiE;4BAC9E,OAAO,EAAE,IAAI;yBACd;wBACD,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,4DAA4D;yBAC1E;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,EAAE,eAAe,CAAC;SACvD;KACF;IACD;QACE,IAAI,EAAE,uCAAuC;QAC7C,WAAW,EAAE,iJAAiJ;QAC9J,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,qEAAqE;iBACnF;gBACD,aAAa,EAAE,yBAAyB,CAAC,kCAAkC,CAAC;aAC7E;YACD,QAAQ,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC;SAC1C;KACF;IACD;QACE,IAAI,EAAE,4CAA4C;QAClD,WAAW,EAAE,oJAAoJ;QACjK,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,UAAU,EAAE;oBACV,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,8DAA8D;iBAC5E;gBACD,aAAa,EAAE,yBAAyB,CAAC,uCAAuC,CAAC;aAClF;YACD,QAAQ,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC;SAC1C;KACF;CACF,CAAC"}

package/dist/docs/dw_net/HTTPClient.md

@@ -9,7 +9,7 @@
 
 ## Description
 
-The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE. If a secure connection via HTTPS is established the used server certificate or the signing CAs certificate needs to be imported into the customer key store via Business Manager. Note: when this class is used with sensitive data, be careful in persisting sensitive information. Key selection for mutual TLS: Check if there is an explicit identity requested setIdentity(KeyRef) Else, Check if there is a mapping for hostname in the keystore Deprecated: Select an arbitrary private key from the keystore var httpClient : HTTPClient = new HTTPClient(); var message : String; httpClient.open('GET', 'http://www.myinstance.com/feed.xml'); httpClient.setTimeout(3000); httpClient.send(); if (httpClient.statusCode == 200) { message = httpClient.text; } else { // error handling message="An error occurred with status code "+httpClient.statusCode; }
+The HTTPClient class supports the HTTP methods GET, POST, HEAD, PUT, PATCH, OPTIONS, and DELETE. If a secure connection via HTTPS is established the used server certificate or the signing CAs certificate needs to be imported into the customer key store via Business Manager. Note: when this class is used with sensitive data, be careful in persisting sensitive information. Key selection for mutual TLS: Check if there is an explicit identity requested setIdentity(KeyRef) Else, Check if there is a mapping for hostname in the keystore Deprecated: Select an arbitrary private key from the keystore var httpClient = new HTTPClient(); var message; httpClient.open('GET', 'http://www.myinstance.com/feed.xml'); httpClient.setTimeout(3000); httpClient.send(); if (httpClient.statusCode == 200) { message = httpClient.text; } else { // error handling message = "An error occurred with status code "+httpClient.statusCode; }
 
 ## Constants
 
@@ -77,6 +77,12 @@ Determines whether host name verification is enabled.
 
 Gets the identity used for mutual TLS (mTLS).
 
+### loggingConfig
+
+**Type:** HTTPClientLoggingConfig
+
+Gets the logging configuration for this HTTP client.
+
 ### responseHeaders
 
 **Type:** Map (Read Only)
@@ -110,7 +116,9 @@ The timeout for this client, in milliseconds.
 
 ## Constructor Summary
 
-HTTPClient()
+HTTPClient() Constructs the HTTPClient instance with the default configuration.
+
+HTTPClient(configMap : Object) Constructs the HTTPClient instance with the given configuration.
 
 ## Method Summary
 
@@ -162,6 +170,12 @@ Determines whether host name verification is enabled.
 
 Gets the identity used for mutual TLS (mTLS).
 
+### getLoggingConfig
+
+**Signature:** `getLoggingConfig() : HTTPClientLoggingConfig`
+
+Gets the logging configuration for this HTTP client.
+
 ### getResponseHeader
 
 **Signature:** `getResponseHeader(header : String) : String`
@@ -306,6 +320,12 @@ Sets whether certificate host name verification is enabled.
 
 Sets the identity (private key) to use when mutual TLS (mTLS) is configured.
 
+### setLoggingConfig
+
+**Signature:** `setLoggingConfig(config : HTTPClientLoggingConfig) : void`
+
+Sets the logging configuration for this HTTP client.
+
 ### setRequestHeader
 
 **Signature:** `setRequestHeader(key : String, value : String) : void`
@@ -424,6 +444,18 @@ Reference to the private key, or null if not configured
 
 ---
 
+### getLoggingConfig
+
+**Signature:** `getLoggingConfig() : HTTPClientLoggingConfig`
+
+**Description:** Gets the logging configuration for this HTTP client.
+
+**Returns:**
+
+the current logging configuration
+
+---
+
 ### getResponseHeader
 
 **Signature:** `getResponseHeader(header : String) : String`
@@ -761,6 +793,18 @@ true if the returned code was a positive status code.
 
 ---
 
+### setLoggingConfig
+
+**Signature:** `setLoggingConfig(config : HTTPClientLoggingConfig) : void`
+
+**Description:** Sets the logging configuration for this HTTP client.
+
+**Parameters:**
+
+- `config`: the logging configuration to use
+
+---
+
 ### setRequestHeader
 
 **Signature:** `setRequestHeader(key : String, value : String) : void`

package/dist/docs/dw_net/HTTPClientLoggingConfig.md

@@ -0,0 +1,296 @@
+## Package: dw.net
+
+# Class HTTPClientLoggingConfig
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.net.HTTPClientLoggingConfig
+
+## Description
+
+Script API for configuring HTTP client logging and sensitive data redaction. This class provides a customer-facing interface for configuring HTTP client logging behavior, including enabling/disabling logging, setting log levels, and defining sensitive fields that should be redacted from HTTP request and response bodies. Security Note: This class handles sensitive security-related data and logging configuration. Pay special attention to PCI DSS requirements when configuring sensitive field redaction to ensure proper data protection. Sensitive Fields of appropriate types MUST be set else logging will be skipped. Usage Example: var config = new dw.net.HTTPClientLoggingConfig(); // Enable logging and set level config.setEnabled(true); config.setLevel("INFO"); // Configure sensitive JSON fields config.setSensitiveJsonFields(["password", "creditCard", "ssn"]); // Configure sensitive XML fields config.setSensitiveXmlFields(["password", "creditCard", "ssn"]); // Configure sensitive headers config.setSensitiveHeaders(["authorization", "x-api-key", "cookie"]); // Configure sensitive body fields (for form data) config.setSensitiveBodyFields(["password", "creditCard", "ssn"]); // Configure text patterns for plain text/HTML content config.setSensitiveTextPatterns([["password\\s*=\\s*[^\\s&]+"]]); Content Type Support: JSON: Use setSensitiveJsonFields() to specify field names to redact XML: Use setSensitiveXmlFields() to specify element/attribute names to redact Form Data: Use setSensitiveBodyFields() to specify parameter names to redact Plain Text/HTML: Use setSensitiveTextPatterns() to specify regex patterns Binary/Multipart: Entire body is automatically treated as sensitive
+
+## Properties
+
+### enabled
+
+**Type:** boolean
+
+Gets whether HTTP client logging is enabled.
+
+### level
+
+**Type:** String
+
+Gets the current log level for HTTP client logging.
+
+### sensitiveBodyFields
+
+**Type:** String
+
+Gets the sensitive body fields configured for form data redaction.
+
+### sensitiveHeaders
+
+**Type:** String
+
+Gets the sensitive headers configured for redaction.
+
+### sensitiveJsonFields
+
+**Type:** String
+
+Gets the sensitive JSON fields configured for redaction.
+
+### sensitiveXmlFields
+
+**Type:** String
+
+Gets the sensitive XML fields configured for redaction.
+
+## Constructor Summary
+
+HTTPClientLoggingConfig() Creates a new HTTPClientLoggingConfig instance.
+
+## Method Summary
+
+### getLevel
+
+**Signature:** `getLevel() : String`
+
+Gets the current log level for HTTP client logging.
+
+### getSensitiveBodyFields
+
+**Signature:** `getSensitiveBodyFields() : String[]`
+
+Gets the sensitive body fields configured for form data redaction.
+
+### getSensitiveHeaders
+
+**Signature:** `getSensitiveHeaders() : String[]`
+
+Gets the sensitive headers configured for redaction.
+
+### getSensitiveJsonFields
+
+**Signature:** `getSensitiveJsonFields() : String[]`
+
+Gets the sensitive JSON fields configured for redaction.
+
+### getSensitiveXmlFields
+
+**Signature:** `getSensitiveXmlFields() : String[]`
+
+Gets the sensitive XML fields configured for redaction.
+
+### isEnabled
+
+**Signature:** `isEnabled() : boolean`
+
+Gets whether HTTP client logging is enabled.
+
+### setEnabled
+
+**Signature:** `setEnabled(enabled : boolean) : void`
+
+Sets whether HTTP client logging is enabled.
+
+### setLevel
+
+**Signature:** `setLevel(level : String) : void`
+
+Sets the log level for HTTP client logging.
+
+### setSensitiveBodyFields
+
+**Signature:** `setSensitiveBodyFields(fields : String...) : void`
+
+Sets the sensitive body fields that should be redacted from HTTP form data.
+
+### setSensitiveHeaders
+
+**Signature:** `setSensitiveHeaders(headers : String...) : void`
+
+Sets the sensitive headers that should be redacted from HTTP requests/responses.
+
+### setSensitiveJsonFields
+
+**Signature:** `setSensitiveJsonFields(fields : String...) : void`
+
+Sets the sensitive JSON fields that should be redacted from HTTP request/response bodies.
+
+### setSensitiveTextPatterns
+
+**Signature:** `setSensitiveTextPatterns(patterns : String...) : void`
+
+Sets the sensitive text patterns that should be redacted from HTTP request/response bodies.
+
+### setSensitiveXmlFields
+
+**Signature:** `setSensitiveXmlFields(fields : String...) : void`
+
+Sets the sensitive XML fields that should be redacted from HTTP request/response bodies.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### getLevel
+
+**Signature:** `getLevel() : String`
+
+**Description:** Gets the current log level for HTTP client logging.
+
+**Returns:**
+
+the log level as a string (DEBUG, INFO, WARN, ERROR)
+
+---
+
+### getSensitiveBodyFields
+
+**Signature:** `getSensitiveBodyFields() : String[]`
+
+**Description:** Gets the sensitive body fields configured for form data redaction.
+
+**Returns:**
+
+an array of field names that will be redacted from form data
+
+---
+
+### getSensitiveHeaders
+
+**Signature:** `getSensitiveHeaders() : String[]`
+
+**Description:** Gets the sensitive headers configured for redaction.
+
+**Returns:**
+
+an array of header names that will be redacted
+
+---
+
+### getSensitiveJsonFields
+
+**Signature:** `getSensitiveJsonFields() : String[]`
+
+**Description:** Gets the sensitive JSON fields configured for redaction.
+
+**Returns:**
+
+an array of field names that will be redacted from JSON content
+
+---
+
+### getSensitiveXmlFields
+
+**Signature:** `getSensitiveXmlFields() : String[]`
+
+**Description:** Gets the sensitive XML fields configured for redaction.
+
+**Returns:**
+
+an array of field names that will be redacted from XML content
+
+---
+
+### isEnabled
+
+**Signature:** `isEnabled() : boolean`
+
+**Description:** Gets whether HTTP client logging is enabled.
+
+**Returns:**
+
+true if logging is enabled, false otherwise
+
+---
+
+### setEnabled
+
+**Signature:** `setEnabled(enabled : boolean) : void`
+
+**Description:** Sets whether HTTP client logging is enabled. When enabled, HTTP requests and responses will be logged according to the configured log level and sensitive field redaction settings. When disabled, no HTTP logging will occur.
+
+**Parameters:**
+
+- `enabled`: true to enable logging, false to disable
+
+---
+
+### setLevel
+
+**Signature:** `setLevel(level : String) : void`
+
+**Description:** Sets the log level for HTTP client logging. The log level determines the verbosity of HTTP logging output. Available levels: DEBUG: Most verbose, includes detailed request/response information INFO: Standard level, includes basic request/response details WARN: Only logs warnings and errors ERROR: Only logs errors
+
+**Parameters:**
+
+- `level`: the log level (DEBUG, INFO, WARN, ERROR). Case-insensitive.
+
+---
+
+### setSensitiveBodyFields
+
+**Signature:** `setSensitiveBodyFields(fields : String...) : void`
+
+**Description:** Sets the sensitive body fields that should be redacted from HTTP form data. When HTTP requests or responses contain form data (application/x-www-form-urlencoded), any parameters matching the specified field names will be redacted with "****FILTERED****" in the logs. Sensitive Field MUST be set else logging will be skipped for form body type Setting with empty array will use default values ["name", "email", "email_address", "ssn", "first_name", "last_name"] Example: config.setSensitiveBodyFields(["fname", "creditCard", "ssn_last_4"]);
+
+**Parameters:**
+
+- `fields`: an array of field names to redact from form data
+
+---
+
+### setSensitiveHeaders
+
+**Signature:** `setSensitiveHeaders(headers : String...) : void`
+
+**Description:** Sets the sensitive headers that should be redacted from HTTP requests/responses. Any HTTP headers matching the specified names will be redacted with "****FILTERED****" in the logs. This is useful for protecting sensitive authentication tokens, API keys, and session information. Sensitive Headers MUST be set else logging will be skipped for headers Setting the sensitive headers with empty array will use default values ["authorization", "cookie"] Example: config.setSensitiveHeaders([ "x-api-key", "x-auth-token"]); config.setSensiviteHeaders([]);
+
+**Parameters:**
+
+- `headers`: an array of header names to redact
+
+---
+
+### setSensitiveJsonFields
+
+**Signature:** `setSensitiveJsonFields(fields : String...) : void`
+
+**Description:** Sets the sensitive JSON fields that should be redacted from HTTP request/response bodies. When HTTP requests or responses contain JSON content, any fields matching the specified names will be redacted with "****FILTERED****" in the logs. Sensitive Field MUST be set else logging will be skipped for JSON body type Setting with empty array will use default values ["name", "email", "email_address", "ssn", "first_name", "last_name", "password"] Example: config.setSensitiveJsonFields(["password", "creditCard", "ssn"]);
+
+**Parameters:**
+
+- `fields`: an array of field names to redact from JSON content
+
+---
+
+### setSensitiveTextPatterns
+
+**Signature:** `setSensitiveTextPatterns(patterns : String...) : void`
+
+**Description:** Sets the sensitive text patterns that should be redacted from HTTP request/response bodies. When HTTP requests or responses contain text content, any text matching the specified regex patterns will be redacted with "****FILTERED****" in the logs. Example: config.setSensitiveTextPatterns(["password", "credit.*card", "\\d{3}-\\d{2}-\\d{4}"]);
+
+**Parameters:**
+
+- `patterns`: an array of regex patterns to match and redact from text content
+
+---
+
+### setSensitiveXmlFields
+
+**Signature:** `setSensitiveXmlFields(fields : String...) : void`
+
+**Description:** Sets the sensitive XML fields that should be redacted from HTTP request/response bodies. When HTTP requests or responses contain XML content, any elements or attributes matching the specified names will be redacted with "****FILTERED****" in the logs. Sensitive Field MUST be set else logging will be skipped for XML body type Setting with empty array will use default values ["name", "email", "email_address", "ssn", "first_name", "last_name", "password"] Example: config.setSensitiveXmlFields(["password", "creditCard", "ssn"]);
+
+**Parameters:**
+
+- `fields`: an array of element/attribute names to redact from XML content
+
+---

package/dist/docs/dw_order/Basket.md

@@ -122,7 +122,7 @@ Returns if the basket is temporary.
 
 **Signature:** `releaseInventory() : Status`
 
-Releases all inventory previously reserved for this basket.
+Release all inventory previously reserved for this basket.
 
 ### reserveInventory
 
@@ -134,13 +134,13 @@ Reserves inventory for all items in this basket for 10 minutes.
 
 **Signature:** `reserveInventory(reservationDurationInMinutes : Number) : Status`
 
-Reserves inventory for all items in this basket for a specified amount of minutes.
+Reserve inventory for all items in this basket for 10 minutes.
 
 ### reserveInventory
 
 **Signature:** `reserveInventory(reservationDurationInMinutes : Number, removeIfNotAvailable : boolean) : Status`
 
-Reserves inventory for all items in this basket for a specified amount of minutes.
+Reserve inventory for all items in this basket for 10 minutes.
 
 ### setBusinessType
 
@@ -252,7 +252,7 @@ true if the basket is temporary otherwise false
 
 **Signature:** `releaseInventory() : Status`
 
-**Description:** Releases all inventory previously reserved for this basket. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook.
+**Description:** Release all inventory previously reserved for this basket. This is not needed for a normal workflow. You can call dw.order.Basket.reserveInventory() one time after every basket change. For performance and scaling reasons, avoid calling dw.order.Basket.releaseInventory() before dw.order.Basket.reserveInventory(). The reserveInventory function works in an optimized way to release inventory reservations that are no longer relevant. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook.
 
 **Returns:**
 
@@ -264,7 +264,7 @@ a Status instance with - Status.OK if release inventory was successful, otherwis
 
 **Signature:** `reserveInventory() : Status`
 
-**Description:** Reserves inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method will be reset to 10 minutes. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. Behaves same as reserveInventory( null, false );. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
+**Description:** Reserves inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced. Sample workflow for subsequent basket reservations: 1. Request: Add item to basket and reserve the basket. transaction.begin() basket.createProductLineItem("sku1",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2} is complete. 2. Request: Add item to basket. transaction.begin() basket.createProductLineItem("sku2",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten. 3. Request: Remove item from basket. transaction.begin() basket.removeProductLineItem(item1) basket.commit() basket.reserveInventory() // The reservation {sku2:2} is complete. The previous reservation was // overwritten and a quantity of 2 is released for sku1. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. Behaves same as reserveInventory( null, false );. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
 
 **Returns:**
 
@@ -276,7 +276,7 @@ a Status instance with - Status.OK if all items could be reserved, otherwise Sta
 
 **Signature:** `reserveInventory(reservationDurationInMinutes : Number) : Status`
 
-**Description:** Reserves inventory for all items in this basket for a specified amount of minutes. Any reservations created by previous calls of this method will be reset to that amount of minutes. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. getInventoryReservationExpiry() can be used to determine when the expiration will expire. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. Behaves same as reserveInventory( reservationDurationInMinutes, false );. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
+**Description:** Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced. Sample workflow for subsequent basket reservations: 1. Request: Add item to basket and reserve the basket. transaction.begin() basket.createProductLineItem("sku1",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2} is complete. 2. Request: Add item to basket. transaction.begin() basket.createProductLineItem("sku2",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten. 3. Request: Remove item from basket. transaction.begin() basket.removeProductLineItem(item1) basket.commit() basket.reserveInventory() // The reservation {sku2:2} is complete. The previous reservation was // overwritten and a quantity of 2 is released for sku1. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above. The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. getInventoryReservationExpiry() can be used to determine when the expiration will expire. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. Behaves same as reserveInventory( reservationDurationInMinutes, false );. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
 
 **Parameters:**
 
@@ -292,7 +292,7 @@ a Status instance with - Status.OK if all items could be reserved, otherwise Sta
 
 **Signature:** `reserveInventory(reservationDurationInMinutes : Number, removeIfNotAvailable : boolean) : Status`
 
-**Description:** Reserves inventory for all items in this basket for a specified amount of minutes. Any reservations created by previous calls of this method will be reset to that amount of minutes. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above or removeIfNotAvailable is set to true The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. getInventoryReservationExpiry() can be used to determine when the expiration will expire. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. If the reservation succeeds with an OK status and removeIfNotAvailable is true, basket line items quantities might have been changed or line items might have been removed. The returned Status object will contain information about the changes. Possible values for StatusItem.getCode() are: BUNDLE_REMOVED - a bundle item was removed completely ITEM_REMOVED - a product line item was removed completely ITEM_QUANTITY_REDUCED - the quantity of a line item was reduced StatusItem.getDetails() will contain for each item the sku and uuid of the item which was changed/removed. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
+**Description:** Reserve inventory for all items in this basket for 10 minutes. Any reservations created by previous calls of this method are replaced. Sample workflow for subsequent basket reservations: 1. Request: Add item to basket and reserve the basket. transaction.begin() basket.createProductLineItem("sku1",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2} is complete 2. Request: Add item to basket. transaction.begin() basket.createProductLineItem("sku2",2,basket.defaultShipment) basket.commit() basket.reserveInventory() // The reservation {sku1:2, sku2:2} is complete. The previous reservation was overwritten. 3. Request: Remove item from basket. transaction.begin() basket.removeProductLineItem(item1) basket.commit() basket.reserveInventory() // The reservation {sku2:2} is complete. The previous reservation was // overwritten and a quantity of 2 is released for sku1. The method can be used to reserve basket items before checkout to ensure that inventory is still available at the time an order is created from the basket using OrderMgr.createOrder(Basket). If all or some basket items are not reserved before creating an order, OrderMgr.createOrder(Basket) will validate item availability and will fail if any item is unavailable. Calling this method in the same request as OrderMgr.createOrder(Basket) is unnecessary and discouraged for performance reasons. The maximum quantity that can be reserved at one time is equal to the ATS (Available To Sell) quantity. (See ProductInventoryRecord.getATS().) When using B2C Commerce inventory, reserving basket inventory does not reduce ATS. In this case, converting the basket to an order reduces ATS by the reserved amount. For example, consider a product with an ATS quantity of 5 and no reservations. If a basket reserves a quantity of 3, then other baskets still see an ATS of 5 but can only reserve a quantity of 2. When using Omnichannel Inventory, reserving basket inventory reduces ATS. In this case, converting the basket to an order doesn't reduce ATS. In the previous example, after the first basket reserved a quantity of 3, other baskets would see an ATS of 2. Reservations can only be made for products with an inventory record. The reservation of product bundles is controlled by the Use Bundle Inventory Only setting on the inventory list. The setting allows inventory to be reserved for just the bundle or for the bundle and its bundled products. The following conditions must be met for the method to succeed: an inventory list must be assigned to the current site all products in the basket must exist, and must not be of type Master or ProductSet each product line item must have a valid quantity each product must have an inventory record, or the inventory list must define that products without inventory record are available by default the reservation must succeed for each item as described above or removeIfNotAvailable is set to true The method implements its own transaction handling. Calling the method from inside a transaction is disallowed and results in an exception being thrown. This behavior differs when calling the method from an OCAPI hook. OCAPI hooks handle transactions themselves, so in this case there is also no need to do any transaction handling, but to ensure the shortest possible locking of the inventory this method should only be called as the last step in the OCAPI hook. getInventoryReservationExpiry() can be used to determine when the expiration will expire. If the reservation fails with an ERROR status, existing valid reservations for the basket will remain unchanged but no new reservations will be made. This might lead to a partially reserved basket. If the reservation succeeds with an OK status and removeIfNotAvailable is true, basket line items quantities might have been changed or line items might have been removed. The returned Status object will contain information about the changes. Possible values for StatusItem.getCode() are: BUNDLE_REMOVED - a bundle item was removed completely ITEM_REMOVED - a product line item was removed completely ITEM_QUANTITY_REDUCED - the quantity of a line item was reduced StatusItem.getDetails() will contain for each item the sku and uuid of the item which was changed/removed. This method must not be used with the CreateOrder2 pipelet, or OrderMgr.createOrder(Basket), or OrderMgr.createOrder(Basket, String) in the same request.
 
 **Parameters:**