Get Sponsored Products

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

Query Parameters

vendor_id

string

required

The ID of the vendor to get sponsored products.

offset

integer

default:

0

The pagination offset.

Required range: x > 0

limit

integer

default:

100

The pagination limit.

Required range: 0 < x < 100

fetch_active_products

boolean

default:

false

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

Response

200

application/json

Successful Response

Paginated response for sponsored products in a vendor.

hasMore

boolean

required

Whether this is the last page of results or not.

sponsoredProducts

string[]

required

List of sponsored product ids.

next

object

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

Show child attributes

next.limit

integer

required

How many items to return.

next.offset

integer

required

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