-
Shipping Method Name String The carrier-supplied name for the shipping service type, such as "UPS Ground … Shipping Method Code String The code associated with a carrier's shipping method service type used during … Package ID String A unique identifier for the package.
-
Last Updated: 03/14/2025 in User Guides Orders Returns
The Order Admin's returnable item details will also display any quantity limit or return window that … Return rule information will be reflected in the item-level data of Shipment APIs , such as when creating … Product and customer rules cannot be shared across any other rule features, such as purchase limit rules
-
API to negative test your application and ensure it throws errors as expected. … PayPal Operations The PayPal Express Application sends the following API requests to PayPal, as needed … use and click Profile : On the Settings tab, turn on negative testing: Example: Force Error 10001 in a
-
Payment Term String The payment term for a purchase order (e.g. net 30) used as payment for the order … Shipping Method Name String The carrier-supplied name for the shipping service type, such as UPS Ground … Purchase Order Number String The storefront identifier of the purchase order used as payment for the
-
Vue Storefront is an eCommerce frontend framework that can work with any backend API. … Visit the API documentation for more details about API authentication. … Prerequisites In order to use Vue Storefront, you must have the following: NodeJS v14 or later KiboCommerce
-
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 … field to provide a token, as they can now record the actual last four digits of the credit card number
-
Last Updated: 07/29/2024 in User Guides Subscriptions
orders and their fulfilled shipments through the Create Order API . … Import via Subscriptions API To import subscriptions, make a call to the Create Subscriptions API detailing … You can import subscriptions and their completed orders from your previous system via API so that those
-
Last Updated: 03/24/2025 in User Guides Marketing Discounts
Discount extensibility allows you to utilize custom attributes as additional discount conditions, giving … to use it as a discount condition. … Order Attributes Order attributes can only be used as condition for order-level discounts and can be
-
Last Updated: 07/07/2023 in User Guides System Permissions
The user can successfully create an order with a billing address located in any country. … Shipping Address Restrictions When adding a new shipping address to any order, customer, subscription … If a user doesn't have access to an order, then they will not have any access to returns associated with
-
Attribute Value String Value of the attribute represented as a string. Will never be null. … The Order Item Attributes view provides dimensions and measures for the extensible attributes associated … Shopper Entered Attribute Value String Value of the attribute entered by the shopper represented as a
-
Last Updated: 03/09/2023 in User Guides Search Search Schema
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. … and payload. suggestion : A string of the search term to return as a suggestion.
-
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
-
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: 09/26/2023 in User Guides System Schema
and services provided. … Order Attributes Order attributes enable you to uniquely describe an aspect of an order, such as collecting … This is a complex feature documented as its own topic in the Catalog documentation.
-
Last Updated: 03/14/2025 in User Guides B2B
If a client only wants to use B2B Order Release based on account priority without any configuring any … Product and customer rules cannot be shared across any other rule features, such as return rules . … If you want to assign a rule to multiple sites, create or update it via the Rule APIs instead.
-
Last Updated: 01/16/2025 in User Guides Locations
hours, services provided, etc. … Note that changes to these settings may not immediately take effect when processing orders. … attributes are attributes that you can apply to locations to add further definition for special uses, such as
-
In order to set a price list, you must pass an array of price lists as the second parameter of callback … A logged in user with a customer segment will have any customer segment specific pricelist codes in this … A logged in user with a customer segment will have any customer segment specific pricelist codes in this
-
Last Updated: 07/30/2024 in User Guides Orders Manage Orders
If the restrictEdit flag is set to true on the order via API , then a user without the Override Order … These are separate from order notes and not copied onto any child shipments or order-level logs. … Repeat for any other items you want to add.
-
A lot of the data relevant to applications is formatted as JSON. … A great use case for logging is to view what data the context object provides different actions, as shown … During API Extensions development, it is helpful to use the available logging tools to examine the data
-
For instance, a customer service representative can select a product and replace the original item with … Substitute on Order or New Shipment To perform a substitution on a Pending order or when creating a new … display all substitute products as line items with a label indicating the original products as shown