October 19, 2021 — 1.2140 Service Update

Production Tenant Features

eCommerce & Order Management Functionality

• Refund Amount Update: Following up to the 1.2136 update to the Refund API, KCCP will utilize the shipping, handling, and processing fees for returns provided per that update. When values are provided for the return processing fee and a Boolean flag indicating whether or not to include the S&H fee in the return, this data will now be factored into refund calculations. This ensures that the proper refund amount after all fees are charged is reflected in the Admin UI and the API response. For where these values can be set via the Admin UI, see the Return guide.
• Monetate Replacements: The term “Monetate” has been replaced with “Kibo Personalization” wherever it was named in the KCCP Admin UI, specifically under the theme settings for personalization configuration.

Order Management Functionality

• Location Group Setting Updates: When a carrier is enabled in location group settings, you are required to configure at least one shipping method or type as well as its default options. If you attempt to enable a carrier without making these selections, an error will now be displayed that prompts you to set those options. If you cannot provide that information at the time, you are still able to save incomplete carrier settings without enabling the career. Additionally, the Location Group Config API can support custom carriers. The type (whose value should begin with "custom_" as the prefix), name, shipping method names, and default carrier options can be set to a custom carrier (such as BoxKnight). Then, viewing the order’s tracking information in the Admin UI will display the custom carrier name and the tracking number (text only, not a hyperlink). Custom carriers are not yet displayed in the Fulfiller UI, but support will be added in an upcoming release. See the Location Group documentation and the Configuration API for more information
• Site Builder Pick Wave Updates: To support recent changes to display item options in pick wave documents via the site theme, a few relevant parameters have also been added to the fields available in the Site Builder tool. This includes productOptions and locatorName (the inventory locator name, e.g. the aisle where an item is located in the store) which can be used in the Hypr template for pick wave sheets.
• Delivery Preparation Update: When a Delivery shipment is in the Delivery Preparation step, the button to proceed said “Ready for Pickup” and the instructional pop-up that appeared after clicking that button described pickup instructions as well. This button has been changed to say delivery instead of pickup and the pop-up now explains the intended delivery instructions. See the Delivery user guide for more information about this process.
• Order Routing Filter Update: Adding filters to a group in the Order Routing UI (via the Add Filter button while viewing the Routes page) now displays an updated pop-up modal that matches the one used when adding filters while creating a new group. The user will be presented with a list of available filters and check one or more that they wish to add. See the Order Routing guide for more information about this UI and routing groups.

eCommerce Functionality

• Schedule Categories: Static and dynamic categories can now be given start and end dates during which they will be automatically displayed on the storefront. This provides flexibility in setting up categories in advance for a particular time period, such as holiday-themed categories, without having to manually enable and disable them. See the updated user guides for static and dynamic categories for more information.
• Quick Edit - Assign Categories: The product Quick Edits feature now supports assigning categories to products. This includes removing or replacing existing category assignments, adding new category assignments, and updating primary category selections on a set of products in child catalogs. See the updated Quick Edits documentation for more information.

Production Sandbox Features

eCommerce & Order Management Functionality

• User Interface Updates: Several minor updates have been made across the Kibo Composable Commerce Platform Admin interface:
  • The login page now says “Username or Email” instead of only “Email,” as admins can log in with either.
  • Shipment numbers displayed on the order details page are now hyperlinks to the respective shipment in the Fulfiller UI, allowing faster customer care and fulfillment. (The link will not be active if the Admin user doesn’t have access to that fulfillment location.)
  • In the order details tab, the internal notes have been moved underneath the basic order information and attributes.
  • Labels in the order notes section of the order details tab have been updated for a better user experience. This section has been renamed to “Internal Order Notes,” the “Add Internal Notes” button is now simply “Add,” and these labels are now consistent across the order details and order creation flow, as well as both the Admin and Fulfiller UIs.
  • When creating a return in the Fulfiller UI, a Quantity Shipped column is now displayed that will display the amount of that item on the shipment. The existing Quantity column has been renamed to “Quantity to Return” and will default to the Quantity Shipped amount. The return reason drop-down value can now default to a “returnReason” set in the tenant settings of the theme language file.
• ReCAPTCHA Site Setting: The ability to enable Google ReCAPTCHA when adding payments to an order has been added to the general site settings. This setting can be found in the Storefront section of the settings and also includes a form to specify a site key, secret password, and desired validity score (which defaults to 50%). When enabled, a user will be forced to validate when they add payment information. 
• Refund to Existing Gift Card Update: If the Refund On Existing Gift Card site setting is selected, then the system will distribute the amount between multiple existing cards accordingly if more than one was used to pay for the order. When issuing refunds, the modal has also been updated by moving the line items in order to display a field for whether a Return Processing Fee has been applied. 
• Bulk Delete Inventory API: A new version of the Delete Inventory API can now accept more than one item at a time. This endpoint is .../v5/inventory/deleteItems and accepts arrays for item UPCs and location codes where the inventory should be deleted from. The Inventory API documentation will update after release.
• Batch Custom Data API: A new API has been created for batch custom data creation, which takes in multiple key:value pairs and adds them to the order item specified in the endpoint. This does not support adding custom data to multiple items or shipments at once, but allows all custom data to be configured for an item in one call rather than making a separate request for each key:value pair. This endpoint is .../v2/orderItem/{orderItemId}/customData/batch?orderID={orderId} and accepts an orderId, itemId, and customDataList array of objects with the key name and value strings in the body. The Order API specs will update after the release.
• Disable Backorder Re-Auth: Voiding and re-authing credit cards can now be turned off for implementations using subscription tokens that don’t expire, so that backorders can be released by the automatic backorder job without attempting to re-auth payments. Previously, this would place those orders into Customer Care and require the client to manually manage backorders. There is not yet an Admin UI site setting for this, so this update only allows re-auth to be turned off in the back-end for implementations that need it.

Order Management Functionality

• Location Mapping Updates: Location mappings are now synced in locations and location groups when deletion events occurs. When a location is removed from a group or a location group is deleted, the mappings on any connected locations or groups and their retailer IDs are updated accordingly. See the Location Management and Location Group user guides for more information about these features.
• Refund S&H in Fulfiller UI: To make the Admin and Fulfiller UIs more consistent in how they handle returns and shipping/handling tax, a “Refund Shipping & Handling” checkbox has been added to the Fulfiller UI’s modal for processing returns. If disabled, the return total will be the sum of the subtotal and item tax (which is the existing functionality). If enabled, the return total will now be calculated as the sum of the subtotal, item tax, and shipping/handling tax. This option is enabled by default. Additionally, the automatic Refund API has been updated to better support refund functionality in the Fulfiller UI by handling partial refund cases in which only some line items are refunded OR less than the total quantity of a line item is refunded. See the Fulfiller UI user guide for instructions on how to process returns.
• Fulfiller Custom Carriers: Version 1.2138 introduced the ability to configure custom carriers and shipping types via the Location Groups API, such as for BoxKnight. Now, the Fulfiller UI is able to display this information after it has been set – the custom carrier name and service types will be selectable options in the Prepare For Shipment step. Tracking numbers can then be added and removed for that shipment as usual, and the appropriate information will be displayed on the shipping label. Note that for the particular BoxKnight use case, BoxKnight will only be supported for Canadian locations. Additionally, any language translation or customization of the buttons must be done via the fulfiller theme. See the Fulfiller UI user guide for information about the Prepare for Shipment flow, and the Customization documentation for how to edit the fulfiller theme.
• Payment Errors Block Fulfillment: The shipment workflow has been updated with new behavior in which the fulfillment process now considers an order's payment status to determine if a shipment can be fulfilled. This changes how the Fulfiller UI and the Fulfillment APIs may be used to process shipments and fulfill orders. Now, a shipment can only be fulfilled if the order's rollup payment status is Pending, Paid, Pending and Errored, or Paid and Errored. If the status is Unpaid or Errored, then all shipments on the order will be blocked from being fulfilled through either API or UI until the order is no longer in that errored state. Learn more about these changes, payment statuses, and how to opt out via your site theme settings here. Refer to the Fulfiller UI guide to see how blocked shipments are displayed in that interface.

Translated OMS Functionality

• Customer Custom Data: Translated APIs now map customer custom data fields properly from the legacy Create Order API to the Kibo Composable Commerce Platform. Previously, this custom data was not properly handled and created in KCCP after the Create Order call was translated. With this update, placing an order with customer.customData results in the data being displayed on the Customer page of the Admin UI. See the translated Create Order API doc here.

Search Functionality

• User Interface Updates: The configuration settings in the Search Settings have been updated to better align buttons, table data, and whitespace. Button colors have been changed in the Search Schema.
• Spell Correction: Two types of spellchecks are now supported for the site search, providing Auto Correct and Did You Mean? functionality. For these options to be available, spell correction must first be enabled in the schema settings. When that is done, a new “Spell Correction” section will be editable on the site search configuration page. Here, the Auto Correct and Did You Mean? features can be toggled on or off individually. Note that spellcheck mappings are automatically performed and thus cannot be manually configured in the schema. The Search documentation will be updated with more information will be updated with the production release.  

Bug Fixes

The following list summarizes resolved issues for this release.