Skip to main content

Overview

Line Item Minimum Bid Details returns the lowest valid bid for a line item. Call it before you set the line item’s max bid so you know the minimum you can use. If you set a max bid below this value, the request is rejected.
Availability: AvailableThis endpoint is available in the Experimental Retail Media API.
The endpoint supports Onsite Display and Sponsored Products auction line items. The response depends on the line item’s bidding type:
  • Onsite Display line items bid use CPM bidding.
  • Sponsored Products line items bid use CPC bidding.

Endpoint

Retrieve Line Item Minimum Bid Details

Path parameter

The authenticated user must have permission to view the requested line item.

Sample request

Response attributes

All attributes below are nested under data.attributes in the response envelope. Amounts are in the line item’s currency.

How minimum bids are calculated

Onsite Display (CPM)

The retailer sets CPM rates per page type. The rate for a page type depends on the creative format and the product category. For each page type configured on the line item, the endpoint finds the rates that match the line item’s creatives and category targets, then calculates:
  • minBid: The lowest rate across the line item’s page types, ignoring rates of 0. A bid below this value is rejected.
  • recommendedMinBid: The highest rate across the line item’s page types. A bid below this value is accepted but returns a warning. A bid at or above it meets the applicable rate for every page type, but doesn’t guarantee delivery. Delivery also depends on auction conditions and other line item settings.
If the line item has no page types, minBid is 0 and recommendedMinBid is null. The retailer sets a minimum CPC bid for each product category. The minimum bid is calculated from the categories of the SKUs on the line item.
  • minBid: The highest minimum bid across the categories of the SKUs on the line item. A bid below this value is rejected.
If the line item has no SKUs, minBid is the retailer’s default minimum bid.

Sample responses

An Onsite Display line item:
A Sponsored Products line item:

Responses