Blog Developers Developer Blog Support

Kibo Help Center

Your central Hub for Kibo knowledge and information

  • Home
  • Developers
  • Home
  • Glossary
  • User Guides
    • Catalog
      • Catalogs
        • Catalog Overview
        • Catalog Terminology
        • Catalog Structure
        • Catalog and Site Structure Settings
        • Master Catalogs
        • Sites
      • Products
        • Product Types
          • Product Types Overview
          • Configure Product Types
          • Product Type Attributes
          • Display Groups
        • Product Attributes
          • Product Attributes Overview
          • Option Attributes
          • Property Attributes
          • Variant Property Attributes
          • Extra Attributes
          • Mapping Attributes
          • Attribute Localization
        • Product Subscriptions
          • Product Subscriptions Overview
          • Import Historical Subscriptions
          • Configure Subscriptions
          • Subscription Discounts
          • Create Subscription as Offline Order
          • Manage Subscriptions
          • Update Next Order Only
          • Order Subscription Now
          • Subscription Localization
          • Subscription Notifications
        • Digital Gift Cards
          • Digital Gift Card Overview
          • Standard Product Gift Cards
          • Configurable Gift Cards
        • Product Overview
        • Configure Products
        • Schedule Products
        • Product Variations
        • Product Slicing
        • Collections
        • Quick Edits
        • Dynamic Imaging
        • Substitute Products
      • Categories
        • Category Overview
        • Static Categories
        • Dynamic Categories
        • Dynamic Category Expressions
        • Category Attributes
        • Facets
        • Visual Merchandizing
      • Price Lists
    • Customers
      • B2C
        • Customers Overview
        • Customer Account Access
        • Customer Attributes
        • Customer Segments
        • Customer Sets
        • Customer Purchase Orders
      • B2B
        • B2B Overview
        • Types of B2B Users
        • Manage B2B Accounts
        • Storefront Accounts
        • Quotes
        • Email Settings
        • Quick Orders
    • Fulfillment
      • Fulfillment Methods
        • Fulfillment Method Types
        • Shipping Method Codes
        • Fulfillment Object States
        • Ship to Home
        • Ship to Store Transfer
        • Buy Online Pickup In Store
        • Curbside Delivery
        • Preparation and Delivery
      • Fulfillment Messaging
        • Fulfillment Messaging Overview
        • Consumer Emails
        • Store Notifications
        • Templates
      • Pick and Pack
        • Pick and Pack Overview
        • Pick Waves
        • Packing Slips
        • Split Packing Slips
        • Pick Lists and Sheets
      • Fulfiller UI Overview
      • Shipping Manifests
      • Fulfiller Returns
      • Substitute Products
      • User Management
      • Mobile Fulfiller Application
      • Fulfiller and Returns Customization
    • Inventory
      • Inventory File Import/Export
        • Inventory Import File
        • Inventory Export File
      • Inventory Overview
      • Configure Inventory
      • Inventory Quantity Types
      • Inventory Segmentation
      • Reserve Inventory in Cart
      • Product Bundles and Product Extras
      • Adjust On-Hand Quantities
      • Fulfill Items Without Sufficient Stock
      • Out of Stock Behaviors
      • Inventory Workflow Examples
    • Locations
      • Locations Overview
      • Location Types
      • Location Attributes
      • Manage Locations
      • Location Groups
    • Marketing
      • Discounts
        • Discounts Overview
        • Configure Discounts
        • Discount Folders
        • Variant Discounts
        • Stackable Discounts
        • Auto-Add Free Product Discount
      • Campaigns
      • Coupon Sets
      • Marketing Best Practices
    • Orders
      • Order Payments
        • Payment Overview
        • Payment States
        • Add Payments to Orders
        • Payment Actions
        • Pay with Rewards
        • Purchase Orders
        • Gateway Gift Cards
        • Store Credit and Gift Cards
      • Manage Orders
        • View Orders and Shipments
        • Search for Orders
        • Create Offline Orders
        • Edit Orders
        • Edit Order Shipments
        • Edit Order Items
        • Cancel Orders and Shipments
      • Returns
        • Returns Overview
        • Return Statuses
        • Manage Returns
        • Initiate a Return
        • Receive a Return
        • Refund a Return
        • Replace a Return
        • Close a Return
      • Orders Overview
      • Order Statuses
      • Order Attributes
      • Price Lists and Orders
      • Line Item Pricing
      • Appeasements
      • Cart Takeover
      • Ship to Multiple Addresses
    • Point of Sale Application
      • Getting Started with POS
      • POS Storefront
      • Product Description Pages
      • Scanning Barcodes
      • Customer Accounts
      • Viewing Orders
      • Filling the Cart
      • Checking Out
      • Order Management Integration
      • POS Settings
    • Publishing
      • Introduction
      • Drafts
      • Publish Sets
      • Live Edit Products
    • Order Routing
      • Order Routing Overview
      • Route Strategies
      • Routes
      • Locations
      • Filters
      • Custom Data Lists
      • Custom Data Sets
      • Reports
      • Extensible Order Routing
      • Suggestion Logs and Debug
    • Reporting
      • Dashboards
        • Channel Dashboard
        • Continuity Orders for Products Dashboard
        • Customer Dashboard
        • Deferred Sales Dashboard
        • Discount Dashboard
        • Fulfillment Dashboard
        • Fulfillment Year-to-Date Dashboard
        • Individual Category Dashboard
        • Individual Discount Dashboard
        • Individual Location Dashboard
        • Individual Product Dashboard
        • Locations Dashboard
        • New Customer Dashboard
        • Order Dashboard
        • Order Detail Dashboard
        • Order Item Details Dashboard
        • Order Payment Details Dashboard
        • Orders Year-to-Date Dashboard
        • Payment Type Dashboard
        • Product Dashboard
        • Product Category Dashboard
        • Product Category Returns Dashboard
        • Product Returns Dashboard
        • Product Subscription Dashboard
        • Purchase Order Dashboard
        • Purchase Order Account Details Dashboard
        • Purchase Order Details Dashboard
        • Rejected Shipment Detail Report
        • Return Details Dashboard
        • Returns Dashboard
        • Shipment Method Dashboard
        • Shipment Type Dashboard
        • Shipment Detail Dashboard
        • Subscription Dashboard
        • Unclaimed BOPIS Orders Dashboard
      • Explores and Views
        • Explores Overview
        • Category View
        • Child Shipment Number View
        • Customer View
        • Customer Account Segment View
        • Customer Contact View
        • Discount View
        • Inventory In Stock Notification Subscription View
        • Location View
        • Order View
        • Order Discount View
        • Order Attributes View
        • Order Item View
        • Order Item Attributes View
        • Order Payment View
        • Product View
        • Product Attributes View
        • Product Category Details View
        • Product in Catalog View
        • Purchase Order Account View
        • Return View
        • Return Item View
        • Shipment View
        • Shipment Package Tracking Number View
        • Shipment Package View
        • Shipment Reassigned Item View
        • Subscription View
        • Subscription Cancelled Item View
        • Subscription Item View
        • Transferred Shipment Number View
      • Reporting Overview
      • Download Reports
      • Custom Reports
    • Search
      • Search Schema
        • Search Schema Overview
        • Add a Core Field
        • Add Custom Attributes
        • Field Type Analyzer Implementation Guide
        • Field Type Analyzers
        • Term-Based Suggester
      • Search Settings
        • Overview
        • Create or Edit a Search Configuration
        • Search Types
        • Third-Party Search Tools
        • Personalized Search
        • Product Slicing within Search
        • MinMatch
        • Phrase Slop
        • Spell Correction
        • Field Weights
        • Boost and Bury
        • Whitespace
        • Return Fields
        • Merchandizing Rules
        • Search Redirects
        • Search Synonyms
      • Getting Started Integrating Personalization With Search
    • Site Builder
      • View Your Site
      • Edit Your Site
      • Preview and Apply Themes
      • Configure Redirects
      • File and Image Management
      • Filter Inventory by Location
    • System
      • General
        • Payment Settings
          • Payment Gateways
          • Payment Types
          • Payment Ranking and Auto Capture
          • Payment Extensibility
          • Payment Extensibility Starter Kit
          • Apple Pay Configuration
          • Google Pay Configuration
          • Fraud Checking
        • Shipping Settings
          • Shipping Settings Overview
          • Shipping Zones
          • Product Shipping Rules
          • Shipping Carriers
          • Shipping Methods and Fees
        • General Settings
        • Tax Settings
        • Publishing Settings
      • Customization
        • Application Settings
        • Custom Route Settings
      • Structure
        • Catalog and Site Structure Settings
        • Channel Settings
        • Customer Sets
      • Permissions
        • Users and User Groups
        • User Roles
        • IP Blocking
        • Logging User Edits
        • SSO Implementation
        • Geography-Based User Access
    • Apps and Integrations
      • App Support Levels
      • Apple Pay Integration
      • Avalara Application
      • Bazaarvoice Conversations Application
      • Borderfree Application
      • Bronto Application
      • ChannelAdvisor Application
      • Constant Contact Application
      • CyberSource Decision Manager Application
      • Google Pay Integration
      • Kount Application
      • Lightspeed Retail Application
      • Live Chat Integration
      • MailChimp Application
      • Pay with Amazon Application
      • Pay with Amazon Technical Specs
      • PayPal Express Application
      • PayPal Express Technical Specs
      • PowerReviews Application
      • Push Notifications Application
      • Salesforce Sales Cloud Application
      • Salesforce Technical Specs
      • ShipWorks Application
      • Social Content Application
      • Vertex Application
      • Monetate Integration
    • Import/Export
      • Introduction to Import-Export
      • Import and Export Tools
      • Troubleshooting Import Issues
      • Export IT Analytics Data
      • Customers Template
      • Orders Template
      • Catalogs Template
      • Marketing Template
      • Content Template
      • Price Lists Template
      • B2B Template
    • Introduction to the UCP UIs
    • International Support
    • Troubleshooting Your Implementation
  • Developers
    • API Documentation
      • API Guides
        • API Overviews
          • Dynamic Categories API Overview
          • Fulfillment API Overview
          • Inventory API Overview
          • Line Item Pricing API Mappings
          • Multiple Addresses API Overview
          • Orders API Overview
          • Order Routing API Overview
          • Price Lists API Overview
          • Purchase Order API Overview
          • Returns API Overview
          • Search Settings API Overview
          • Search Tuning Rules
          • Shipping Carriers API Overview
        • Making API Calls
        • API Best Practices
        • Sorting and Filtering APIs
        • Status Codes
        • Response Fields
        • Payment Gateway Responses
        • Live Editing Products
        • Transactional Logs
        • Getting Started with Postman
      • API Extensions Reference
        • Introduction
          • API Extensions Reference
        • Carts
          • Get Carts (After)
          • Add Item (Before)
          • Add Item (After)
          • Update Item (Before)
          • Update Item (After)
          • Delete Item (Before)
          • Delete Item (After)
          • Delete Cart (Before)
          • Delete Cart (After)
        • Catalog Admin
          • Add Category (Before)
          • Add Category (After)
          • Update Category (Before)
          • Update Category (After)
        • Catalog Storefront Products
          • Configured Product (Before)
          • Configured Product (After)
          • Get Product (Before)
          • Get Product (After)
          • Get Product For Indexing (Before)
          • Get Product For Indexing (After)
          • Get Products (Before)
          • Get Products (After)
          • Location Inventories (Before)
          • Location Inventories (After)
          • Validate Product (Before)
          • Validate Product (After)
          • Product Search (Before)
          • Product Search (After)
          • Resolve PriceList (Before)
          • Resolve PriceList (After)
          • Get PriceList Hierachy
        • Catalog Storefront Shipping
          • Request Rates (Before)
          • Request Rates (After)
          • Request Multi Rates (Before)
          • Request Multi Rates (After)
        • Catalog Storefront Tax
          • Estimate Taxes (Before)
          • Estimate Taxes (After)
        • Checkouts
          • Add Destination (Before)
          • Add Destination (After)
          • Checkout Groupings (After)
          • Update Destination (Before)
          • Update Destination (After)
        • Customer
          • Add Account (Before)
          • Add Account (After)
          • Add Account and Login (Before)
          • Add Account and Login (After)
          • Address Validation (Before)
          • Address Validation (After)
          • Update Account (Before)
          • Update Account (After)
          • Change Password (Before)
          • Change Password (After)
          • Update Forgotten Password (Before)
          • Update Forgotten Password (After)
          • Create User Auth Ticket (Before)
          • Create User Auth Ticket (After)
          • Add Credit (Before)
          • Add Credit (After)
          • Get Credit (Before)
          • Get Credit (After)
          • Get Credits (Before)
          • GetCredits (After)
          • Update Credit (Before)
          • Update Credit (After)
          • Associate Credit to Shopper (Before)
          • Associate Credit to Shopper (After)
          • DeleteCredit (Before)
          • Resend Credit Created Email (Before)
          • Get Transactions (Before)
          • Get Transactions (After)
          • Add Transaction (Before)
          • Add Transaction (After)
          • Get Audit Entries (Before)
          • Get Audit Entries (After)
          • Verify External Password
        • Orders
          • Action (Before)
          • Action (After)
          • Add Item (Before)
          • Add Item (After)
          • Delete Item (Before)
          • Delete Item (After)
          • Order Price (Before)
          • Order Price (After)
          • Create From Cart (Before)
          • Create From Cart (After)
          • Set Fulfillment Info (Before)
          • Set Fulfillment Info (After)
          • Set Billing Info (Before)
          • Set Billing Info (After)
          • Cancellation Reasons (Before)
          • Cancellation Reasons (After)
          • Refund Reasons (Before)
          • Refund Reasons (After)
        • Payments
          • Action (Before)
          • Action (After)
          • Perform Payment Interaction
        • Return
          • Retrieve Reasons
          • Get RMA Labels (Before)
          • Get RMA Labels (After)
          • Actions (Before)
          • Actions (After)
          • Update Return (Before)
          • Update Return (After)
          • Delete Return (Before)
          • Delete Return (After)
          • Create Return Item (Before)
          • Create Return Item (After)
          • Delete Order Item (Before)
          • Delete Order Item (After)
          • Create Package (Before)
          • Create Package (After)
          • Update Package (Before)
          • Update Package (After)
          • Delete Package (Before)
          • Delete Package (After)
          • Create Package Shipments (Before)
          • Create Package Shipments (After)
          • Delete Shipment (Before)
          • Delete Shipment (After)
        • Settings
          • Update Payment Settings (Before)
        • Subscriptions
          • Subscription Reasons (Before)
          • Subscription Reasons (After)
          • Validate Product (Before)
          • Validate Product (After)
          • Flatten Bundle On Convert (Before)
          • Flatten Bundle On Convert (After)
        • Applications
          • Install Applications
          • Uninstall Applications
        • Storefront
          • Cart Pages (Before)
          • Cart Pages (After)
          • Category Pages (Before)
          • Category Pages (After)
          • Checkout Pages (Before)
          • Checkout Pages (After)
          • CMS Page Loads (Before)
          • CMS Page Loads (After)
          • Global Page Request (Before)
          • Global Page Request (After)
          • My Account Pages (Before)
          • My Account Pages (After)
          • Order Confirmation Pages (Before)
          • Order Confirmation Pages (After)
          • Product Details Pages (Before)
          • Product Details Pages (After)
          • Search Pages (Before)
          • Search Pages (After)
          • Storefront Routes
      • API Extensions Guides
        • What You Can Do With API Extensions
        • Getting Started with API Extensions
        • The Structure of an API Extension Application
        • Types of Actions
        • Programming Patterns
        • Action Management JSON Editor
        • Logging Data
        • Testing API Extension Applications
        • API Extension Examples
        • Custom Checkout Grouping
        • Create a New Tax Integration
      • Applications
        • Introduction
        • Get Started with Applications
        • Application Development Requirements
        • Application Development Best Practices
        • Extending Unified Commerce with Custom Schema
        • Event Subscription
        • Order Validators and Fraud Check Applications
        • Creating a New Tax Integration
        • Address Validator
      • Dev Center
        • Dev Center and Your Local Environment
        • Set Up Your System
        • Administration
        • Developer Tools
        • Application Asset Management
        • Theme Asset Management
      • eCommerce Storefront
        • What is the Storefront Application?
        • SEO Best Practices
        • Routes
        • Query Strings
        • GDPR Compliance
      • Headless Integrations
        • Getting Started
        • React Storefront
        • Next.js Commerce
        • Vue Storefront
        • Nuxt
        • GraphQL
        • Contentful Integration
        • Contentstack Integration
      • Themes
        • What You Can Do With Themes
        • Get Started with Themes
        • Theme Structure
        • Theme Settings
        • Hypr Templating System
        • Widgets
        • Editors
        • Labels
        • Stylesheets
        • JavaScript
        • Email Template Customization
        • Maximize Theme Performance
        • Theme Reference
        • Synthesized Mode
      • SDKs
        • .NET SDK
        • Node SDK
        • Mozu Storefront SDK
        • mozu-android-sdk
        • mozu-ios-sdk
        • Unified Commerce Java SDK
      • Event Notifications
        • Event Notifications Overview
        • Event Notifications Examples
      • Curbside-Only
        • Curbside Delivery API Overview
        • Manage Location Types
        • Manage Fulfillment Locations
        • Import Curbside Order
        • Curbside Fulfillment Steps
        • Cancel Curbside Order/Shipment
      • Translated OMS
        • Orders
          • Create Order
          • Create Order Authorize
          • Custom Order Data
          • Add Order Note
          • Search Order Notes
          • Add Order Item
          • Custom Order Item Data
          • Get Order Item Information
          • Search for Order Item
          • Edit Order Item
          • Cancel Order Item
          • Cancel Order
          • Get Order Information
          • Search for Order
          • Assign Order
          • External Fraud
          • Change Gift Information
          • Import Order
        • Locations
          • Create Location
          • Get Location Information
          • Update Location
          • Search for Location
        • Inventory
          • Inventory Inquiry
          • Inventory Inquiry (Aggregate)
          • Inventory Refresh
          • Inventory Adjust
          • Inventory Import
          • Inventory Export
          • Get Inventory Job
        • Customers
          • Create Customer
          • Get Customer Information
          • Search Customer Address Information
          • Search for Customer
          • Get Customer Address Information
        • Notifications
          • Event Notifications Overview
          • Return Event Notifications
          • Shipment Assign Notifications
          • Payment Transaction Error Notification
          • Shipment Status Notifications
          • Order Appeasement Notifications
          • Order Status Notifications
          • Store Decline Notifications
          • Order Item Modification Notifications
        • Shipments
          • Get Shipment Information
          • Search for Shipment
          • Adjust Shipping Fee
          • Adjust Shipment Tax
          • Assign Shipment
          • Assign Shipment to Customer Care
          • Transition States
          • Fulfill Shipment
          • Cancel Shipment
          • Update Tracking Information
        • Returns
          • Create Return
          • Get Returnable Items
          • Get Return Information
          • Search for Return
          • Process Return
          • Reopen Return
          • Delete Return
        • Appeasements
          • Create Appeasement
          • Get Appeasement Information
          • Search for Appeasement
        • Locale
          • Get Locale
        • Payments
          • Get Payment Information
        • Order Routing
          • Get Routing Candidates
        • Translated OMS Overview
    • Glossary
      • Video Tutorials
        •  Accessing a Kibo Commerce Developer Console
        •  Configuring UCP Search
        •  Creating Kibo Event Subscriptions
        •  Getting Started with Payment Extensibility
        • Getting Started with Postman
        •  Kibo Developer Center Overview
        •  Postman Product Attribute Runner
        •  Sandboxes Overview
        •  Update Locations Using Postman Runner
        •  Using Looker Reporting
        •  Using Postman Runner with Kibo APIs
        •  Using Postman to Sort Product Type Attribute Values
      • Release Notes
        • Home
        • Developers

        API Extensions Reference

        Introduction

        Carts

        Catalog Admin

        Catalog Storefront Products

        Catalog Storefront Shipping

        Catalog Storefront Tax

        Checkouts

        Customer

        Orders

        Payments

        Return

        Settings

        Subscriptions

        Applications

        Storefront

        Together, we’re making commerce more personal

        Products

        • Personalization
        • eCommerce
        • Order Management
        • Point of Sale

        Resources

        • Blog
        • Developer Blog
        • Developers
        • Support

        Who We Are

        • Who We Are
        • Kibo Story
        • Leadership
        • News/Press
        • Ecommerce Awards

        Employee Login

        © 2023 - Kibo Commerce | All Rights Reserved | GDPR | Privacy Policy