support Contact support
    • Kamino
    • Developers
    • Kamino platform API integration
    • Manage sponsored product campaigns (API v3)

    Create and manage sponsored product campaigns

    Table of Contents

    Overview Main endpoints Campaign attributes Product settings Automatic settings for external campaigns

    Overview

    This article describes how to create and retrieve sponsored product campaigns using API version 3.

    Main endpoints

    The following table lists the primary endpoints for sponsored product campaigns:

    Method Endpoint Description Link
    GET https://api.kaminoretail.dev/v3/ksp-campaigns Get all sponsored product campaigns. This endpoint only returns category IDs, not full category data. List KSP campaigns
    GET https://api.kaminoretail.dev/v3/ksp-campaigns/{campaign_id} Get a single sponsored product campaign by its ID. Get a KSP campaign
    POST https://api.kaminoretail.dev/v3/ksp-campaigns Create a sponsored product campaign. Create KSP Campaign

    Campaign attributes

    All elements are mandatory unless explicitly stated otherwise. The following table describes the attributes for a campaign:

    Attribute Data type Description Example
    brandId integer Unique identifier of the brand associated with this campaign. 12
    budget string Monetary amount with no decimals. The value must be equal to or greater than zero. 1000
    dates.lower array[string<date-time>] Campaign start date using an ISO 8601 UTC timestamp. 2025-09-01T14:15:22Z
    dates.upper array[string<date-time>] Campaign end date using an ISO 8601 UTC timestamp. 2025-09-15T14:15:22Z
    DSA object

    Buyer and brand of the campaign. If you don’t set the brand, it defaults to the campaign brand.

     

    ⓘ Note: the Digital Services Act (DSA) applies only within the European Union.

    		 Buyer
    includeOptout boolean Indicator specifying whether opt-out users should be targeted.  true
    keywords array[string] List of keywords to target. ["keyword1", "keyword2", "keyword3"]
    name string Unique name for the campaign. My amazing campaign name
    pacing string

    Option that defines how to distribute the budget delivery over time. 

     

    Accepted values are daily, asap, or adaptative.

    		 daily
    pageType array[string]

    List of targeted page types. At least one page type is required. Duplicate values are ignored. 

     

    Accepted values are home, category, product, universe, search, or confirmation.

    		 ["home","category"]
    promotedProducts array[string]

    List of product IDs for products promoted in the campaign. 

     

    The IDs must match the retailer_product_id field from the Products Catalog Feed. 

     

    At least one product is required, and duplicates aren’t allowed.

    		 ["1234", "4536-abc", "EFGH"]
    websiteId integer Unique identifier of the website associated with this campaign. 8

    Product settings

    For each product, you must complete the following configuration actions:

    • Define a maxBid value, which is a monetary amount with up to two decimals.
    • Select the Enable status.

    Automatic settings for external campaigns

    When you create an external campaign, Kamino automatically adds the following non-editable settings:

    • Priority: default
    • Categories: targets all native categories associated with the promoted products. You can retrieve full information for these categories (including the ID, name, level, full path, and parent ID) when you perform a GET campaign request.
    • Attribution: 14-day post-click and post-view.
    • Campaign type: monetization

     

    RELATED ARTICLES