A Few Things to Know
- A Onsite Sponsored Products line item holds promoted products to advertise on a single retailer.
- Line items have bid settings, start & end dates, and optional budgeting & pacing controls.
- Target & maximum bid settings must respect minimum bid (
minBid), that can be set at product SKU level, to start delivering ads - Products SKU IDs are available through Catalog endpoints
Endpoints
| Verb | Endpoint | Description |
|---|---|---|
POST | /retailers/{retailerId}/cpc-min-bids | Search for min bid CPC defined by collection of SKU IDs |
Minimum Bid Attributes
| Attribute | Data Type | Description |
|---|---|---|
retailerId* | string | Retailer ID where the line item will serve ads onAccepted values: int64 Writeable? N / Nullable? N |
skuIds* | list<string> | List of SKU IDs in which the minimum bid is requested (usually, the SKUs promoted by the line item). Values are available through Catalog endpointsAccepted values: at least, an empty list [] Writeable? N / Nullable? N |
skuId | string | SKU ID respective to the minBid in the responseAccepted values: SKU IDs from catalog Writeable? N / Nullable? N |
overallMinBid | decimal | Overall minimum bid resulted from the list of SKUs requested, that the line item should respect to, effectively, deliver adsAcceptable values: at least 0.01 Writeable? N / Nullable? N |
minBid | decimal | Minimum bid for the respective SKUAcceptable values: at least 0.01 Writeable? N / Nullable? N |
Retrieve Minimum Bid from SKU IDs
Sample RequestResponses
| Response | Description |
|---|---|
🟢 200 | Call executed with success |
🔴 400 | json-serialization-error Required attribute missing or with unexpected format in request’s body |
🔴 404 | Not Found Retailer ID informed in request’s path was not found |