-
Shipping Method Name String The carrier-supplied name for the shipping service type, such as UPS Ground … Customer Account ID String A system-generated unique identifier for the customer account. … Reason String The reason description for an action.
-
Last Updated: 02/09/2024 in Release Notes
This is used when an API query is made for a parent category or a parent category is browsed on the storefront … API, support for this field has been added to the translated OMS APIs so the Admin UI can display this … This should not cause any operational changes.
-
Last Updated: 08/05/2024 in Developers Event Notifications
appropriate API using the notification's entityID value - such as GET Shipment , GET Order , or GET … This does not cover all possible events, but includes both return and order topics that use the basic … For more general information about notification APIs, how they are formatted, or the full list of notification
-
Last Updated: 05/01/2025 in User Guides System Permissions
Shipping Address Restrictions When adding a new shipping address to any order, customer, subscription … The user can successfully create an order with a billing address located in any country. … , or B2B account through the Admin UI or API, the user can only add a shipping address for the country
-
Attribute Value String Value of the attribute represented as a string. Will never be null. … The Order Attributes view provides dimensions and measures for extensible attributes associated with … This ID is used at all levels of a store and catalog to associate objects to a site.
-
Last Updated: 02/13/2025 in User Guides Catalog Products
However, product variant details that do not deviate from the base product are shown on the site as part … If you do not specify either a relative or explicit price for each variant, the variant's price and weight … field in the Kibo eCommerce API product variations object .
-
Two Way The Two Way expansion type does not include a term, but instead only contains a list of synonyms … However, if a user searches for "top," the search results will not include results for "blouse" or any … This is a one way expansion; the search results are not expanded to the term or any other listed synonyms
-
Last Updated: 03/10/2023 in User Guides Orders
When a shopper that belongs to a specific customer segment logs in to their customer account, any price … If the product quantity in the order does not equal the minimum purchasable quantity in the volume pricing … You can control a product's list price, sale price, and other advanced pricing information such as MSRP
-
Last Updated: 03/09/2023 in User Guides Search Search Schema
This metadata is returned as part of the suggestion results and can be used by your site in a custom … Uploading via API You can upload a term file by specifying it with the following API call: PUT catalog … Terms are defined in a text-based file that acts as a dictionary.
-
Last Updated: 02/18/2025 in User Guides Order Routing
Note that this does not calculate based on the rates of any other carriers. … the configured after-action logic such as being canceled or sent to Customer Care as a separate STH … for future delivery so that it does not block the available items from being consolidated and shipped
-
Last Updated: 09/13/2024 in User Guides Orders
If you select a Yes/No type for the attribute, the value defaults to No if a user does not explicitly … By default, order attributes are only captured during checkout and the system does not reprice orders … , then the discount will remain applied even if the order doesn't match its conditions any more.
-
Last Updated: 02/18/2025 in User Guides Inventory
Inventory API calls, such as in the below example that includes a SKU, serial number, and condition. … For information about making Inventory API calls with granular fields, refer to the Inventory API Overview … Serial Number : This is the lowest granular identifier for a physical piece of inventory, such as a laptop
-
Last Updated: 05/01/2025 in User Guides Marketing Discounts
Discount extensibility allows you to utilize custom attributes as additional discount conditions, giving … B2B and Customer Attributes B2B and customer attributes can be used as conditions for both line item … The below example shows the option for a customer attribute.
-
Last Updated: 07/30/2024 in User Guides Catalog Products
You are able to cancel the update, but doing so will not revert any changes that were already completed … You are able to cancel the update, but doing so will not revert any changes that were already completed … You are able to cancel the update, but doing so will not revert any changes that were already completed
-
Last Updated: 01/17/2023 in User Guides Search Search Schema
Custom Attributes refer to any unique product attributes you've created. Select an attribute. … "gloves" matches with this analyzer, while the term "fireplace" does not. code_exact A code search analyzer … This analyzer does not use stopword filtering and synonym expansion to prevent undesirable interactions
-
Last Updated: 09/26/2023 in User Guides System Schema
and services provided. … This is a complex feature documented as its own topic in the Catalog documentation. … This is a complex feature documented as its own topic in the Catalog documentation .
-
Last Updated: 09/26/2023 in User Guides Locations
You can associate a location with any number of location types. … Location types act as templates that determine how all locations of a certain type interact with a site … Location types typically represent each distinct type of location you use to sell products, but does
-
Last Updated: 04/30/2025 in User Guides Marketing
You do not have to deactivate the coupon before deleting, but Kibo recommends making sure a coupon is … To remove a coupon set via API, simply make a DELETE call to the Delete Coupon Set API endpoint with … API.
-
Service type codes include a prefix that indicates the carrier. … Shipment Method Name String The carrier-supplied name for the shipping service type, such as UPS Ground … Shipment Method Code String The code associated with a carrier's shipping method service type used during
-
In Admin, go to System > Customization > API Extension s to open the Action Management JSON Editor . … In Admin, go to System > Customization > API Extensions to open the Action Management JSON Editor . … A great use case for logging is to view what data the context object provides different actions, as shown