Skip to content
Topsort Documentation
API

Get Sponsored Products

GET
/v1/campaign-service/sponsored-products

This endpoint is deprecated. Use /products-in-campaign instead.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Query Parameters

object
vendor_id
required

The ID of the vendor to get sponsored products.

string

The ID of the vendor to get sponsored products.

offset

The pagination offset.

integer

The pagination offset.

limit

The pagination limit.

integer
default: 100 <= 100

The pagination limit.

fetch_active_products

Whether to fetch only active products. If false, all products will be fetched even if the campaign or the bid are inactive.

boolean

Whether to fetch only active products. If false, all products will be fetched even if the campaign or the bid are inactive.

Responses

Successful Response

Paginated response for sponsored products in a vendor.

application/json
object
hasMore
required

Whether this is the last page of results or not.

boolean
next

The parameters that should be used to fetch the next page.

object
limit
required

How many items to return.

integer format: int32
offset
required

How many items to skip from the beginning of the list.

integer format: int32
sponsoredProducts
required

List of sponsored product ids.

Array<string>