/documentation_

Courier Preview API Reference

Initializing search

Home
Bizzkit
PIM
DAM
CMS
Ecommerce Search
Mail
Users
BAIA
Blueprint
Product News
Release Notes
Become partner

/documentation_

Home
Bizzkit
Bizzkit
- Showcasing Bizzkit
  Showcasing Bizzkit
- Bizzkit Academy
  Bizzkit Academy
  - Training
    Training
    
    For Users
    For Users
    
    Getting started
    
    Using DAM
    
    Using PIM
    
    Using CMS
    Using CMS
    
    Course Description
    
    Course Material
    
    Using ECS
    
    For Developers
    For Developers
    
    Getting started
    
    Developing with DAM
    Developing with DAM
    
    Course description
    
    Course material
    
    Developing with PIM
    Developing with PIM
    
    Course description
    
    Course material
    
    Developing with ECS
    Developing with ECS
    
    Course description
    
    Course material
    
    For Advisors
    For Advisors
    
    Advisor training
  - Certifications
    Certifications
    
    For users
    For users
    
    Certified DAM user
    
    Certified PIM user
    
    Certified CMS user
    
    Certified ECS user
    
    For developers
    For developers
    
    Certified DAM developer
    
    Certified PIM developer
    
    Certified ECS developer
    
    For advisors
    For advisors
    
    Certified Bizzkit Advisor
- Bizzkit Support
  Bizzkit Support
- Running Bizzkit in cloud
  Running Bizzkit in cloud
- Running Bizzkit in docker
  Running Bizzkit in docker
  - Getting started
    
    Getting started
  - How to
    
    How to
    
    Setup local development with .NET
    
    Configure Bizzkit products
    
    Update Bizzkit products
  - Download Docker-related files
  - Common issues
- Using The Bizzkit SDKs
  Using The Bizzkit SDKs
- Service Level Agreement
  Service Level Agreement
- Definitions
- Cookie Information
  Cookie Information
PIM
PIM
- Getting started
  Getting started
- Tutorials
  Tutorials
  - Enriching products
  - Modelling attributes
- Concepts
  Concepts
  - Features
    Features
    
    AI assisted product descriptions
    
    Dashboards
    
    Search and filters
    
    Search and filters
    
    Product search bar
    
    Basic filters
    
    Advanced filters
    
    Quick filters
    
    Filter operators
    
    Mass edit
    
    Bulk operations
    
    Bulk operations
    
    Job overview
    
    Product enrichment
    Product enrichment
    
    Attribute value history
    
    Product enrichers
    
    Product validators
  - Product data
    Product data
    
    Products
    
    Products
    
    Attributes
    
    Attributes
    
    Calculated attributes
    
    Data types
    
    Segmentations
    
    Frontend views
  - System configuration
    System configuration
    
    Cultural preferences
    
    Roles and permissions
  - Developer overview
    
    Developer overview
    
    External bulk operations
    
    External bulk operations
    
    Creating external bulk operations
    
    Setting up the customer solution
    
    Securing external bulk operations
    
    Webhooks
- User guide
  User guide
  - How to's
    How to's
    
    How to search and filter
    
    How to search and filter
    
    How to edit data
    
    How to edit data
    
    How to add attributes
    
    How to add attributes
    
    How to create dashboards
    
    How to create dashboards
    
    How to work with hierarchies
    
    How to work with hierarchies
  - Best practices
    Best practices
    
    Naming conventions
    
    Naming conventions
    
    Setting up an attribute
    
    Setting up an attribute
- References
  References
DAM
DAM
- Getting started
  Getting started
- Tutorials
  Tutorials
  - Cropping an image
  - Selecting files in chooser mode
  - Administration
    Administration
    
    Creating a content language
    
    Creating a predefined setting
    
    Creating a resource image
    
    Creating an aspect ratio
  - Attributes and tags
    Attributes and tags
    
    Creating an attribute category
    
    Creating an attribute or tag
  - Chooser mode
    Chooser mode
    
    Implement a file chooser
    
    Restrict which filetypes can be selected when in chooser mode
  - Creating translations
    
    Creating translations
  - File and folder management
    
    File and folder management
    
    Setting folder permissions
  - Modules
    Modules
    
    Using the news module
    
    Using the publishing channel module
- Concepts
  Concepts
  - Developer overview
    
    Developer overview
  - Terminology
    
    Terminology
  - Integration points
    
    Integration points
  - Files and images
    
    Files and images
    
    File cache
    
    File cache
    
    File fetching
    
    File fetching
    
    File picking
    
    File picking
    
    Image format recommendations
    
    Image format recommendations
  - Transformations
    
    Transformations
  - Predefined settings
    
    Predefined settings
  - Folders
    
    Folders
  - Attributes and tags
    
    Attributes and tags
  - Jobs
    
    Jobs
    
    Background Jobs
    
    Index Jobs
  - Events
    
    Events
  - Permission management
    
    Permission management
  - Translations
    
    Translations
- User guide
  User guide
  - How to organize files
    
    How to organize files
- How to
  How to
  - Change user permissions
  - Retrieve file transformations based on a predefined setting
- Troubleshooting
  Troubleshooting
  - Running DAM in docker for development / test
- References
  References
  - DAM API Reference
  - DAM Preview API Reference
CMS
CMS
Ecommerce Search
Ecommerce Search
- Getting started
  Getting started
  - Integration Development Checklist
  - Improving Search Results
- Tutorials
  Tutorials
  - Commercial sorting
    Commercial sorting
    
    Best practices
    
    User Affinities in practice
  - Pricing
    Pricing
    
    Planning price changes
  - Product assortment
    Product assortment
    
    Product assortment best practices
  - Searching
    
    Searching
    
    Authenticated Search
    
    Search Client
  - Configuring CORS
    
    Configuring CORS
  - Configuring Google Analytics
    
    Configuring Google Analytics
    
    Common parameter configuration options
- Concepts
  Concepts
  - Developer overview
    
    Developer overview
  - Commercial sorting
    
    Commercial sorting
    
    Commercial Parameters
    
    Normalization
    
    Personalization
    
    Suggestion Commercial Sorting
  - Content
    
    Content
    
    Best practices for searching Bizzkit CMS Classic content
    
    Integrating Bizzkit CMS and Ecommerce Search
    
    Field name priority
    
    Content Limitation
  - Contexts
    
    Contexts
  - Dashboards
    
    Dashboards
    
    Top phrases to improve
    
    Search Tracking
  - Diagnostics
    
    Diagnostics
    
    Pipeline analysis
  - Ingestion
    
    Ingestion
    
    Commercial parameters
    
    Content
    
    Products
    
    Suggestion Candidates
  - Pricing
    Pricing
    
    Pricing strategies
  - Products
    
    Products
    
    Field name priority
    
    Skus
  - Publications
    
    Publications
  - Rate limiting
    
    Rate limiting
  - Scopes
    
    Scopes
  - Searching
    
    Searching
    
    Authenticated Search
    
    Did You Mean
    
    Export
    
    Filters
    
    Semantic search
    
    Sorting
    
    Unified Search
  - Segments
    
    Segments
    
    Allowed filters
    
    Allowed sortings
  - Split tests
    
    Split tests
  - Suggestions
    
    Suggestions
    
    Related tags
    
    Suggestion Generator Rules
    
    Taboos
  - Text analysis
    
    Text analysis
    
    Dictionaries
    
    Hypernyms
    
    Ignored Words
    
    Irregular Words
    
    Misspellings
    
    Multi-Words
    
    Stemming Overrides
    
    Stemming
    
    Synonyms
- References
  References
  - Api
    
    Api
    
    Admin API Reference
    
    Admin Preview API Reference
    
    Courier API Reference
    
    Courier Preview API Reference
    
    Search API Reference
    
    Search Preview API Reference
- FAQ
Mail
Mail
- Getting started
  Getting started
- Tutorials
  Tutorials
  - Best practices
- Concepts
  Concepts
- References
  References
  - Mail API Reference
  - Mail Preview API Reference
Users
Users
- Getting started
  Getting started
- Tutorials
  Tutorials
  - Migrating users installation
    
    Migrating users installation
- Concepts
  Concepts
  - Developer overview
    
    Developer overview
  - Downstream clients
    
    Downstream clients
- User guide
  User guide
  - Create users and roles
    
    Create users and roles
- References
  References
  - Api
    
    Api
- FAQ
BAIA
BAIA
- Recipes
  Recipes
  - How to create a recipe
    
    How to create a recipe
  - How to manage a recipe
    
    How to manage a recipe
  - System recipes
    
    System recipes
    
    Check for synonyms
    
    Check for synonyms
    
    Copy context
    
    Copy context
    
    Validate hypernyms
    
    Validate hypernyms
    
    Validate irregular words
    
    Validate irregular words
    
    Validate synonyms
    
    Validate synonyms
Blueprint
Blueprint
- Getting started
  Getting started
- Fundamentals
  Fundamentals
  - Basket
  - Configuration
  - Order
  - Price
  - Product
  - Routing
  - Segmentation
  - Stock
  - WebsiteUser
- Bizzkit
  Bizzkit
- Extensions
  Extensions
  - Payment
    
    Payment
    
    Getting started
    
    Getting started
    
    Installing the Payment-extension
    
    Listing payment options
    
    Creating payments
    
    Setting up the server callback handling
    
    Integrations
    
    Integrations
    
    AltaPay
    
    Bambora
    
    Billwerk+
    
    EAN
    
    ePay
    
    Invoice
    
    Netaxept
    
    Zero
- Release Notes
  Release Notes
  - Blueprint 2024.4.1
- API Reference
- Blueprint Storybook
Product News
Product News
- Product News for March 2024
Release Notes
Release Notes
Become partner

Courier Preview API Reference