Get Advertiser Products Endpoint Schema

The get products endpoint needs to respond to a GET request, and has the following request schema.

URL Parameters

ParameterDescription
advertiser_id stringThe advertiser ID
limit integerThe number of records to return (maximum 100).
starting_after string (optional)The last product ID in the previous page. We'll use this field as a cursor for pagination if required.

Response
The response should be in a JSON format, and successful requests should return a 200 status code.

ValueDescription
id stringAn identifier for the product.
image_url stringAn image to use as a thumbnail when advertisers are selecting the products to promote. Should be at least 256x256 if possible, otherwise the image may be scaled up.
name stringThe name of the product.
description stringA longer description of the product.
quantity integerThe number of products that are available. If this is 0, no ads will be shown by default.