Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
CampaignMinbid

Retrieve minimum bid details for keywords

Retrieve individual minimum bid details and the overall campaign minimum bid for an array of specified keywords in Search and Category & Search placement type campaigns.

post/v3/min-bid/keywords

Request body

teamIdstring required

Specifies the unique identifier for the team associated with the campaign.

catalogIdsstring[] required

Specifies the unique identifiers for the retailer's catalogs associated with the campaign. You can specify more than one catalog ID, separated by commas. Ensure that all specified catalog IDs meet the following criteria: - They are not empty and contain products. - They use the same currency (e.g., AUD or USD). - They belong to the same namespace.

keywordsstring[] required

Specifies the search keywords for Search and Category & Search placement type campaigns. You can specify up to 1000 search keywords.

namespacestring required

The unique identifier of the namespace.

placementIdstring required

The unique identifier of the campaign's placement.

campaignType'CAMPAIGN_TYPE_DISPLAY' | 'CAMPAIGN_TYPE_BANNER' | 'CAMPAIGN_TYPE_BANNERX' | 'CAMPAIGN_TYPE_WILDCARD' required
retailerTeamIdstring

The unique identifier for a retailer-managed team. As a retailer, you can retrieve minimum bid details of the supplier team by specifying the retailerTeamId. Ensure that API requests are authenticated with the retailer's bearer token.

Response

Provides the minimum bid details for the specified keywords in Search and Category & Search placement type campaigns.