July 27, 2021 — 1.2128 Service Update

Production Tenant Features

Order Management & eCommerce Functionality

  • Get Inventory Bins Update: The searchTerm parameter has now been made optional in the Get Inventory Bins API at … /v1/bin/ where previously it was required. This change allows a user to retrieve a list of all bins within a locationCode without filtering by bin names. The locationCode is still required to be appended to the endpoint as the filter ?locationCode={locationCode}. See the API documentation here.
  • Item Details in Admin: The SKU, Part Number, and product image are now displayed at the item level when viewing order or return details in the Admin UI. The SKU, Part Number, Code, and product image are also displayed at the item level of the shipment details tab when viewing an order or creating a new shipment. If any of these values are not applicable to the item, then the label will not be displayed. See the user guides for more information about the Order Admin and Returns in general.
  • Historical Order UI Updates: In addition to other recent updates to the historical order import process, the Order Admin UI has also been updated to better display these orders. These imported orders are displayed in the Order Admin in a read-only state, allowing order details to be viewed without having any edit capabilities (including placing returns or performing payment actions).
  • Site Builder Updates: Improvements have been made to the Site Builder behavior when editing email information. The Save button is now only enabled if changes have been made to the name, email, or gift card message. In this case, the Resend Email is disabled and will not be available until the changes have been saved. If no changes have been made, then the Save button is disabled while Resend Email is enabled.
  • Sandbox Provisioning: Kibo Composable Commerce Platform admin users are now able to provision new sandboxes from the Dev Center. This self-service allows users to create a new tenant and select a sandbox type depending on the options their implementation supports (i.e. eComm Only, eComm + OMS, OMS Only, or Curbside Only). Classic eCommerce users are also able to provision their own sandboxes, but the only type available to them will be Classic. See the Dev Center documentation for more information.

Search Functionality

  • Preview Search Campaigns: Previewing a Search campaign is now supported for all Search types – site search, product suggest, and listings. While the site search and product suggest prompt you to enter a search term before previewing, listings are previewed by category instead. When creating a new campaign and depending on the type of Search, enter the search term or select the category and then click Preview to test the search results. The results include an information pop-up for each item that will display factors such as relevancy and the total score to help you with further edits. See the Campaign user guide for more information.
  • Search Redirects Update: The KCCP navigation menu has been updated to replace “Redirects” with “Search Redirects” in the list of pages at Main > Marketing.

Fulfiller Functionality

  • Validate Stock Defaults: Previously, the Fulfiller UI defaulted to 0 during the Validate Stock step which required fulfiller users to always input the available stock amount. Now, the Validate Stock values will default to the quantity requested in the shipment – as long as the user is not using a scanner. If a scanner is being used, then the stock amount will still default to 0. A custom theme can be used to set a third option – setting the default as the inventory amount at that location. See the FFUI guide for more information about this UI in general.
  • Item Identifiers in Transfers: As with other shipments, item identifiers can now also be provided by fulfillers at the Validate Stock step for transfer shipments. This allows fulfiller users at the location that’s supplying the transfer to set the identifier values for that item.
  • Shipment & Gift Card Events: The event payload of the Fulfillment APIs now includes more shipment data and filters this information for shipment items with target gift cards. If there is a shipment with multiple items and each item has multiple gift cards, then the event will publish a shipment with one item and a single gift card that the email needs to be trigger for. This allows eCommerce gift card emails (which are triggered by these events) to include shipment information from the Order Management side of the Kibo Composable Commerce Platform.

Production Sandbox Features

Order Management & eCommerce Functionality

  • Removed BOPIS Return Labels: The button to print return shipping labels has been hidden from the BOPIS shipment view of the Order Admin to avoid confusion about this functionality. Return labels could not be printed for returns generated from BOPIS shipments, which was the intended behavior. This is due to the fact that BOPIS items are not expected to be returned via shipping as they would for a STH order, and thus do not have an applicable “Ship to” address.
  • Max Packing Slips Location Config: A new configuration option has been added to location group settings, in which the user can set a “max. number of packing slips by group.” This setting is optional but providing a value will override the default value of 10 that is already used by the system. This determines how many packing slip tabs can be displayed in the Fulfiller UI’s Pick & Pack feature.
  • Block Assignment in Cancel Shipment API: The blockAssignment flag that blocks future assignment to a shipment’s original assigned location has now been added to the Cancel Shipment API. This allows assignment to be blocked from that location when you cancel one of its shipments.
  • Transfer Child Relationships: Similarly to the functionality used for service items, BOPIS and Transfer shipments now use item IDs to denote the relationship between parent and child items. The “parent” item in a BOPIS shipment includes a childItemId parameter pointing to the transfer item. In the Transfer shipment, the “child” item has a parentItemId parameter pointing back to the BOPIS item. This relationship previously existed at the shipment level but has been extended to the line item level to support behavior where an operation performed on a parent item also reflects on the child item being transferred. This is implemented on all transfer instances.
  • NativeScript Print URL Updates: Print URLs have now been updated to PDFs in the NativeScript application. This allows documents such as shipping labels, packing slips, and pick sheets to be successfully printed in the proper PDF format.
  • Tax Recalculation: When tax integration is not available, the Kibo Composable Commerce Platform will now recalculate tax based on the given tax percentages instead of refreshing the tax. This uses the Arc.js actions documented here. When both item and shipping tax rates are provided at the item level, then the Kibo Composable Commerce Platform will apply those tax rates to the line item upon a change in shipping address, change in line item unit price, or adjustments to item or shipping subtotals.
  • Fulfiller Dashboard Defaults: This feature update was released to sandbox with 1.2126 but is remaining in sandbox for 1.2128 instead of being pushed to production. Theme customization for the Fulfiller UI now supports defining a default tab for the dashboard to determine which shipment listings are displayed first when the page is opened. In the theme language files, the “SHARED.TENANTSETTINGS.defaultDashboardTab” setting can be set to a particular shipment type in order to set that shipment type’s tab as the default. For instance, setting “defaultDashboardTab“ : “BOPIS” would result in BOPIS shipments being displayed upon opening the dashboard. This allows the Late Shipment tab, which is the out-of-the-box default, to be removed from the UI with the following code: .alert-tab-Late { display:none; }
  • Shipment Item Declined Subscription: The existing SHIPMENT_ITEM_DECLINED event has been added to the available event subscriptions in the Dev Center, allowing users to subscribe to these events through the user interface. This event is triggered by actions such as cancel shipment item, shipment reassign, reject shipment, and transfer shipment. When the event is triggered, information about the action will be delivered through the subscription. See the Event Subscription and Shipment Event Notification guides for more details. Note that these docs are intended to be revisited and may be merged together in the future.
  • Return to Gift Card from Fulfiller UI: Any return processing for gift card payments via the Fulfiller UI would result in a failure. This was due to the Fulfiller UI's return logic attempting to perform a payment credit, which was not supported for gift card gateways. Now, the return process will allow the fulfiller to select "Process to New Gift Card" while handling a return, which will create a new gift card under the order's customer name and email address which the total amount of the refund will then be applied to. See the Fulfiller return processing documentation for more information.

Search Functionality

  • Typo Tolerance vs. Min Match: The Typo Tolerance options in the site search configurations are now hidden when Min Match is in use. These features cannot both be active at the same time, so Typo Tolerance will not be displayed if Min Match is set to a percentage other than 0 percent. It will be available only when Min Match is set to 0 percent. For more information about these features, see the documentation.

Translated Order Management Functionality

  • Location Mappings: When a tenant using the translated Order Management APIs adds a new location from the Admin UI, the system now automatically maps the location data so that it can immediately be used by the Inventory and Order Routing services. Previously, this did not happen automatically and required an engineer to manually perform the mapping.
  • Translated Tax Overrides: Previously in the Create Order API, an error would be returned if values for both itemTaxOverride and itemTaxRateOverride were sent. Now, the itemTaxOverride field will override the itemTaxRateOverride field. Likewise, the same error would be returned if values for both shippingTax and shippingTaxRate were sent. Now, the shippingTax field will override the shippingTaxRate field at both the order and item level. All of these values also accept decimals up to 5 places. For more information about these translated APIs, see the documentation.
  • Item Identifiers: Item identifier data is now returned in translated GET calls to the Order, Item, and Shipment APIs to facilitate importing and retrieving orders. The data can be updated when sending a request to the translated Transition Shipment State API to validate items in stock or validate an incoming transfer. This also supports the Fulfiller UI, as it allows fulfiller users from upgraded implementations using translated APIs to set their item identifiers (such as card numbers) in the FFUI and then view that information in their Order Admin UI and transactional logs. For more information about these translated APIs, see the documentation.
    When transitioning states, the user can update item identifiers such as in the below example. In GET responses, the array format is the same but the object is called customFulfillmentFields.
    “fulfillmentFields”: {
            “key”: “Card Number”,
            “value”: “123”,
            “required”: true

Bug Fixes

The following list summarizes resolved issues for this release.

Targeted for Production TenantsPayments were unable to be voided in the production environment of a particular implementation, making it difficult to cancel orders in the expected process. Attempting to void a payment first resulted in an error indicating that the transaction could not be found in the Worldpay gateway. This has been updated so that the void process is compatible with Worldpay and orders can be canceled.
Targeted for Production TenantsSome active orders did not display any shipments in the shipment details tab of the Order Admin view, even though shipments existed for the order in the API and FFUI. This was due to a missing shipment workflow state in the order data. Updated error handling has been added to the Order Admin so that it can still display shipment information even if that data is unexpectedly missing.
Targeted for Production TenantsImage Groups were not being returned in the Product Storefront API response, though calls made through the Product Admin API did include image groups. This caused issues with displaying images on product detail pages, but has now been fixed so that the Storefront API retrieves all product images.
Targeted for Production TenantsWhen placing an order with multiship to split an item’s quantity between two locations, the user was redirected to the cart page instead of progressing to checkout. An error was displayed saying that “an item with the same key has already been added.” This has been corrected so that a shopper can successfully place an order with shipping to multiple addresses.
Targeted for Production TenantsThe reason code for appeasements was not being populated in the Credits transactional log, as the field (return_notes) was displayed as an empty string instead. This TLog has been updated to properly record reason codes.
Targeted for Production TenantsThe Pickup Ready email was being generated for Ship to Home orders after performing pick waves, even though pickup does not apply to STH. This has been fixed so that closing a pick wave does not trigger a Pickup Ready email for all orders included in the pick wave.
Targeted for Production TenantsThe ability to preview campaign boosts with and without search terms association was temporarily unavailable. This has been fixed so that the search bar and preview option is displayed for the site search and product suggest.
Targeted for Production SandboxesThe shipment details tab of the Order Admin UI displayed product option codes twice, instead of the option code and its label. This has been corrected so that both values are properly displayed for shipment options.
Targeted for Production SandboxesReturn labels were truncated and incorrectly sized in the print dialog screen when printing from the Order Admin UI. This has been fixed so that return labels can be fully printed in the correct size.
Targeted for Production SandboxesEditing the shipping address of an order in the Admin UI and performing a validation check on the address resulted in both the billing and shipping addresses being changed. This has been corrected so that only the shipping address will be updated as intended.
Targeted for Production SandboxesAttempting to perform an appeasement on a canceled gift card order and refund to a new gift card was not successful, as the UI returned an error message that the refund amount was required even when it was provided. In addition, canceling the order returned another gateway error message. This has been corrected so that refunds can be successfully made to a new gift card.
Targeted for Production SandboxesThe item SKU field was missing from the packing slip model, preventing this value from being added to packing sheet templates. This model has been updated to once again include the item.sku field to use this data in pack sheets.
Targeted for Production SandboxesLocations with a location code of 0 were not being added to inventory records, preventing inventory from being managed for those locations. This has been fixed so that the system accepts 0 as a valid location code.
Targeted for Production SandboxesThe inventory service occasionally experienced performance issues due to the presence of jobs with null location codes when querying for jobs. This query has been optimized to ignore cases of null locations, allowing jobs to be retrieved more quickly and improve the performance of inventory processes.
Targeted for Production SandboxesReturns transactional logs were not displaying credits correctly and did not match shipment information in the UI when there was more than one transaction. This has been fixed so that the Returns log will report the proper transactions related to a particular return and include accurate credit amounts, without duplications.
Targeted for Production SandboxesRetrieving shipping labels from FedEx Cross Border occasionally included a commerce invoice, which was incorrectly saved as a PNG. This prevented the Fulfiller UI from printing the invoice. The document will now be saved as a PDF as intended so that it can be successfully printed alongside the label.
Targeted for Production SandboxesThe Product Search filter was not persisting properly, as filtered product codes were not staying filtered after clicking a SKU. This has been updated so that the filter stays in effect until being manually cleared.
Targeted for Production Sandboxes

Phrases were not being redirected on the storefront search despite being configured in the Search Redirects settings. This has been fixed so that searching phrases will properly redirect the user to the intended URLs.