Get Vendors

Get vendors.

Query Parameters

next_page

string

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

Response

200

application/json

Successful Response

hasMore

boolean

required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

response

object[]

required

Array of vendors. Can be empty when the catalog or requested page contains no vendors.

A vendor is a brand or other entity that promotes products in campaigns.

Show child attributes

response.id

string

required

Unique ID of the vendor. Topsort treats IDs as strings, choose any format as long as it is unique within the catalog.

Minimum length: 1

Example:

"9SiwYqqL8vdG"

response.name

string

required

Name of the Vendor. Shown in Topsort UI.

Minimum length: 1

Example:

"Huyghe Brewery"

response.imageURL

string

URL of the vendor image. This image will be displayed in the Topsort UI along with the name of the vendor. Image dimensions between 250x250 and 600x600 pixels are recommended for the best performance of the Topsort UI.

Minimum length: 1

Example:

"https://cdn.example.com/logos/9SiwYqqL8vdG.jpg"

response.merchant_center_id

integer

The Google Merchant Center ID.

Example:

1456723

response.vendor_role

enum<string>

Role of the vendor in the Topsort UI. Defaults to admin. Vendors with the admin role have full control to manage and set up their own campaigns. Vendors with the analytics role have read-only access to campaigns and reporting but require the marketplace admin to manage their campaigns.

Available options:

admin,

analytics

nextPage

string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="