Upsert Vendors

Upsert vendors.

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

Try it

Upsert Vendors

cURL

curl --request PUT \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/vendors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendors": [
    {
      "id": "<string>",
      "name": "<string>",
      "imageURL": "https://cdn.example.com/logos/9SiwYqqL8vdG.jpg",
      "vendor_role": "admin",
      "merchant_center_id": 1456723,
      "globalId": "vendor_group_123"
    }
  ]
}
'

204

{}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Body

application/json

vendors · Vendor · object[] · required

Create or replace one or more vendors in the catalog.

Required array length: 1 - 500 elements

Show child attributes

vendors. 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 string length: 1

vendors. name · string · required

Name of the Vendor. Shown in Topsort UI.

Minimum string length: 1

vendors. imageURL · string<uri>

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 string length: 1

Example:

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

vendors. vendor_role · enum<string> | null

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

vendors. merchant_center_id · integer | null

The Google Merchant Center ID.

Example:

1456723

vendors. globalId · string | null

Global identifier for grouping vendors across marketplaces.

Maximum string length: 255

Example:

"vendor_group_123"

Response

204

Successful Response