/documentation_

Courier API Reference

Initializing search

Home
Bizzkit
PIM
DAM
CMS
Ecommerce Search
Mail
Users
BAIA
Blueprint
Product News
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 ECS
    
    For Developers
    For Developers
    
    Developing with DAM
    
    Developing with PIM
    
    Developing with ECS
    
    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
- Developing software at Bizzkit
  Developing software at Bizzkit
- Versioning strategy
  Versioning strategy
- Service Level Agreement
  Service Level Agreement
- Definitions
- Cookie Information
  Cookie Information
PIM
PIM
- User guides
  User guides
  - AI text generation
  - AI text translation
  - 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 use Mass Edit
    
    How to use Mass Edit
    
    How to add attributes
    
    How to add attributes
    
    How to use dashboards
    
    How to use dashboards
    
    How to work with hierarchies
    
    How to work with hierarchies
    
    How to import products
    
    How to import products
  - Best practices
    Best practices
    
    Naming conventions
    
    Naming conventions
    
    Setting up an attribute
    
    Setting up an attribute
- Concepts
  Concepts
  - Features
    
    Features
    
    AI assisted functionality
    
    AI assisted functionality
    
    AI text generation with BAIA
    
    AI translation with BAIA
    
    AI suggested values for global lists
    
    AI product placement suggestions with BAIA
    
    BAIA Configuration
    
    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
    
    Master/variant hierarchies
    
    Bundles
    
    Attributes
    
    Attributes
    
    Calculated attributes
    
    Attribute groups
    
    Product hierarchies
    
    Product hierarchies
    
    Data types
    
    Segmentations
    
    Resolved views
  - System configuration
    System configuration
    
    Cultural preferences
    
    Roles and permissions
  - Solution architecture
    
    Solution architecture
- For developers
  For developers
  - Tutorials
    Tutorials
    
    Configuring product placement suggestions
    
    Modelling attributes
  - References
    References
    
    PIM API Reference
    
    PIM Preview API Reference
    
    CSV specification
    
    CSV Examples
    
    JSON Import API Reference
    
    Resolved views structural versions
  - Integration points
    Integration points
    
    External bulk operations
    
    External bulk operations
    
    Creating external bulk operations
    
    Setting up the customer solution
    
    Securing external bulk operations
    
    Webhooks
- FAQ
DAM
DAM
- User guides
  User guides
  - Permissions management
  - Cropping an image
  - Chooser mode: Selecting files
  - Administration
    Administration
    
    Creating a content language
    
    Creating a transformation function
    
    Creating a resource image
    
    Creating an aspect ratio
  - Attributes and tags
    Attributes and tags
    
    Creating an attribute category
    
    Creating an attribute or tag
  - Creating translations
    
    Creating translations
  - File and folder management
    
    File and folder management
    
    Setting folder permissions
  - Organize
    
    Organize
- Concepts
  Concepts
  - Attributes and tags
    
    Attributes and tags
  - Basket
    
    Basket
  - Files and images
    
    Files and images
  - Folders
    
    Folders
  - Image descriptions
    
    Image descriptions
  - Permission management
    
    Permission management
  - Translations
    
    Translations
- For developers
  For developers
  - Getting started
    
    Getting started
  - Concepts
    Concepts
    
    Cdn records
    
    Cdn records
    
    Events
    
    Events
    
    File picking
    
    File picking
    
    Integration points
    
    Integration points
    
    Transformation functions
    
    Transformation functions
    
    Examples
  - How to
    How to
    
    Chooser mode
    Chooser mode
    
    Implement a file chooser
    
    Restrict which filetypes can be selected when in chooser mode
  - References
    
    References
    
    DAM API Reference
    
    DAM Preview API Reference
CMS
CMS
- Concepts
  Concepts
  - Bizzkit plugins
    
    Bizzkit plugins
  - Bizzkit components
    
    Bizzkit components
  - Bizzkit content hub
    
    Bizzkit content hub
- For developers
  For developers
  - Bizzkit single sign on
    
    Bizzkit single sign on
  - Bizzkit plugins
    
    Bizzkit plugins
  - Bizzkit starter kit
    
    Bizzkit starter kit
  - Environments
    
    Environments
  - SDK
    
    SDK
Ecommerce Search
Ecommerce Search
- Getting started
  Getting started
  - Integration Development Checklist
  - Improving Search Results
- User guides
  User guides
  - Best practices
    Best practices
    
    Best practices for searching Bizzkit CMS Classic content
    
    Commercial Sorting Best practices
    
    Product assortment best practices
  - Dashboard
    
    Dashboard
    
    Findability
  - Experience
    Experience
    
    Allowed filters
    
    Allowed sortings
    
    Facets
    
    Search relevance
  - Playground
    
    Playground
    
    Business Rules & Inheritance
    
    Effects
    
    Experience
  - Products
    Products
    
    Hypernyms
    
    Misspellings
    
    Searchable fields
    
    Stemming Overrides
    
    Synonyms
  - Suggestions
    Suggestions
    
    Related tag groupings
    
    Suggestion Candidates
- Concepts
  Concepts
  - Business rules
    
    Business rules
  - Commercial sorting
    
    Commercial sorting
    
    Commercial Parameters
    
    Normalization
    
    Personalization
  - Content
    
    Content
    
    Integrating Bizzkit CMS and Ecommerce Search
    
    Field name priority
    
    Content Limitation
  - Dashboards
    
    Dashboards
    
    Overall Performance
    
    Popular searches
    
    Findability
    
    No product results
    
    Search Response Time
    
    Full search
    
    Quick search
    
    Browse search
    
    Search tracking
  - Diagnostics
    
    Diagnostics
    
    Pipeline analysis
  - Experiences
    
    Experiences
  - Ingestion
    
    Ingestion
    
    Commercial parameters
    
    Content
    
    Products
    
    Suggestion Candidates
  - Pricing
    Pricing
    
    Pricing strategies
  - Products
    
    Products
    
    Product Families
    
    Field name priority
    
    SKUs
  - Publications
    
    Publications
  - Scopes
    
    Scopes
  - Searching
    
    Searching
    
    Authenticated Search
    
    Did You Mean
    
    Export
    
    Filters
    
    Searchable images
    
    Semantic search
    
    Sorting
    
    Unified Search
  - Segments
    
    Segments
    
    Allowed filters
    
    Allowed sortings
  - Suggestions
    
    Suggestions
    
    Related tags
    
    Suggestion Generator Rules
    
    Taboos
  - Targets
    
    Targets
  - Text analysis
    
    Text analysis
    
    Dictionaries
    
    Hypernyms
    
    Ignored Words
    
    Irregular Words
    
    Misspellings
    
    Multi-Words
    
    Stemming Overrides
    
    Stemming
    
    Synonyms
- For developers
  For developers
  - Limits
    
    Limits
    
    Rate limiting
    
    Rate limiting
  - References
    References
    
    Common pitfalls
    
    Api
    
    Api
    
    Admin API Reference
    
    Admin Preview API Reference
    
    Courier API Reference
    
    Courier Preview API Reference
    
    Search API Reference
    
    Search Preview API Reference
  - Tutorials
    Tutorials
    
    Bizzkit pim integration
    
    Bizzkit pim integration
    
    Commercial sorting
    Commercial sorting
    
    User Affinities in practice
    
    Pricing
    Pricing
    
    Planning price changes
    
    Searching
    
    Searching
    
    Authenticated Search
    
    Search Client
    
    Configuring CORS
    
    Configuring CORS
    
    Configuring Google Analytics
    
    Configuring Google Analytics
    
    Common parameter configuration options
- FAQ
  FAQ
  - FAQ
Mail
Mail
- Getting started
  Getting started
- Concepts
  Concepts
- For developers
  For developers
  - Tutorials
    Tutorials
    
    Best practices
  - References
    References
    
    Mail API Reference
    
    Mail Preview API Reference
Users
Users
- User guides
  User guides
  - Create users and roles
    
    Create users and roles
  - Local login
    
    Local login
  - Email templates
    
    Email templates
  - User metadata
    
    User metadata
  - Login page styles
    
    Login page styles
  - Manage MFA
    
    Manage MFA
  - Forget password
    
    Forget password
- Concepts
  Concepts
  - Downstream clients
    
    Downstream clients
- For developers
  For developers
  - Getting started
    
    Getting started
  - Tutorials
    Tutorials
    
    Migrating users installation
    
    Migrating users installation
  - References
    References
    
    Api
    
    Api
- FAQ
BAIA
BAIA
- Userguide
  Userguide
  - Getting started
    
    Getting started
  - 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
    
    PIM
    PIM
    
    Create and populate global list
    
    Create and populate global list
    
    DAM
    DAM
    
    Create transformation function
    
    Create transformation function
    
    List transformation functions
    
    List transformation functions
    
    Search
    Search
    
    Check for synonyms
    
    Check for synonyms
    
    Validate synonyms
    
    Validate synonyms
    
    Validate hypernyms
    
    Validate hypernyms
    
    Validate irregular words
    
    Validate irregular words
    
    Copy context
    
    Copy context
    
    Users
    Users
    
    List users in role
    
    List users in role
- Concepts
  Concepts
- For developers
  For developers
Blueprint
Blueprint
- For developers
  For developers
  - Getting started
    Getting started
    
    Install Bizzkit Blueprint
    
    Setup new solution
    
    Introduction to the code
  - Fundamentals
    
    Fundamentals
    
    Basket
    
    Configuration
    
    Order
    
    Price
    
    Product
    
    Routing
    
    Segmentation
    
    Stock
    
    WebsiteUser
  - Bizzkit
    Bizzkit
    
    BUM integration
    
    DAM integration
    
    CMS integration
    
    PIM integration
    
    Mail integration
    
    Search integration
    
    Cache usage
  - 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
    
    Blueprint 2024.5.0
  - API Reference
  - Blueprint Storybook
Product News
Product News
- 26. March 2025
- 12. March 2025
- 05. March 2025
- 28. February 2025
- 23 January 2025
- 15 January 2025
- 07 January 2025
- 20 December 2024
- 1 November 2024
- 11 October 2024
- 3 September 2024
- 7 August 2024
- 18 July 2024
- 5 June 2024
- 27 March 2024
- Release notes
  Release notes
  - BAIA
    BAIA
    
    BAIA 24.9
    
    BAIA 24.8
    
    BAIA 24.7
    
    BAIA 24.6
    
    BAIA 24.5
    
    BAIA 24.4
    
    BAIA 24.3
    
    BAIA 24.2
    
    BAIA 24.1
    
    BAIA 24.0
  - PIM
    PIM
    
    PIM 25.0
    
    PIM 24.26
    
    PIM 24.25
    
    PIM 24.24
    
    PIM 24.23
    
    PIM 24.22
    
    PIM 24.21
    
    PIM 24.20
    
    PIM 24.18
    
    PIM 24.17
    
    PIM 24.16
    
    PIM 24.15
    
    PIM 24.14
    
    PIM 24.13
    
    PIM 24.12
    
    PIM 24.11
    
    PIM 24.10
    
    PIM 24.9
    
    PIM 24.8
    
    PIM 24.7
    
    PIM 24.6
    
    PIM 24.5
    
    PIM 24.4
    
    PIM 24.3
    
    PIM 24.2
    
    PIM 24.1
    
    PIM 24.0
  - DAM
    DAM
    
    DAM 25.1
    
    DAM 25.0
    
    DAM 24.10
    
    DAM 24.8
    
    DAM 24.7
    
    DAM 24.6
    
    DAM 24.5
    
    DAM 24.4
    
    DAM 24.3
    
    DAM 24.2
    
    DAM 24.1
    
    DAM 24.0
  - CMS
    CMS
    
    CMS 25.0
    
    CMS 24.4
    
    CMS 24.3
    
    CMS 24.2
    
    CMS 24.1
    
    CMS 24.0
  - Ecommerce Search
    Ecommerce Search
    
    Ecommerce Search 25.5
    
    Ecommerce Search 25.4
    
    Ecommerce Search 25.3
    
    Ecommerce Search 25.2
    
    Ecommerce Search 25.1
    
    Ecommerce Search 25.0
    
    Ecommerce Search 24.48
    
    Ecommerce Search 24.47
    
    Ecommerce Search 24.46
    
    Ecommerce Search 24.45.0
    
    Ecommerce Search 24.44
    
    Ecommerce Search 24.43
    
    Ecommerce Search 24.42
    
    Ecommerce Search 24.41
    
    Ecommerce Search 24.40
    
    Ecommerce Search 24.39
    
    Ecommerce Search 24.38
    
    Ecommerce Search 24.37
    
    Ecommerce Search 24.36
    
    Ecommerce Search 24.35
    
    Ecommerce Search 24.34
    
    Ecommerce Search 24.33
    
    Ecommerce Search 24.32
    
    Ecommerce Search 24.31
    
    Ecommerce Search 24.30
    
    Ecommerce Search 24.29
    
    Ecommerce Search 24.28
    
    Ecommerce Search 24.27
    
    Ecommerce Search 24.26
    
    Ecommerce Search 24.25
    
    Ecommerce Search 24.24
    
    Ecommerce Search 24.23
    
    Ecommerce Search 24.22
    
    Ecommerce Search 24.21
    
    Ecommerce Search 24.20
    
    Ecommerce Search 24.19
    
    Ecommerce Search 24.18
    
    Ecommerce Search 24.17
    
    Ecommerce Search 24.16
    
    Ecommerce Search 24.15
    
    Ecommerce Search 24.14
    
    Ecommerce Search 24.13
    
    Ecommerce Search 24.12
    
    Ecommerce Search 24.11
    
    Ecommerce Search 24.10
    
    Ecommerce Search 24.9
    
    Ecommerce Search 24.8
    
    Ecommerce Search 24.7
    
    Ecommerce Search 24.6
    
    Ecommerce Search 24.5
    
    Ecommerce Search 24.4
    
    Ecommerce Search 24.3
    
    Ecommerce Search 24.2
    
    Ecommerce Search 24.1
    
    Ecommerce Search 24.0
  - Mail
    Mail
    
    Mail 25.0
    
    Mail 24.5
    
    Mail 24.4
    
    Mail 24.3
    
    Mail 24.1
    
    Mail 24.0
  - Users
    Users
    
    User Management 25.0
    
    User Management 24.1
    
    Users 24.0
  - CMS Legacy
    CMS Legacy
    
    CMS 25.0
    
    CMS 24.3
    
    CMS 24.2
    
    CMS 24.1
    
    CMS 24.0
- Site updates
Become partner

api courier developer

Courier API Reference

You can learn more about the API structure in Courier API Explorer.