API

Upsert Vendors

PUT

/v1/catalog-search-service/catalogs/vendors

Upsert vendors.

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>

application/json

object

vendors

required

The vendors to create or substitute.

Array<object>

>= 1 items <= 500 items

A vendor is the provider for one or more products within a marketplace catalog.

object

required

The vendor ID. If there is no ID for vendors in the marketplace, this can be the vendor name as long as it is unique.

string

>= 1 characters

imageURL

The vendor logo. Its size should be between 250x250 and 600x600 pixels. This is recommended in case the Topsort UI will be used to manage campaigns.

string format: uri

>= 1 characters

name

required

The vendor name.

string

>= 1 characters

vendor_role

The vendor’s Role. Default is None

string

Allowed values: admin analytics

Successful Response