Skip to content
Topsort Documentation
API

Get Products

GET
/v1/catalog-search-service/catalogs/products

Get products.

Authentication

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>

Query Parameters

object
next_page

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

string

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

ean

Thirteen digit EAN-13 code.

string

Thirteen digit EAN-13 code.

vendor_id

Filter products by the Vendor ID.

string

Filter products by the Vendor ID.

search

Search query.

string
""

Search query.

Responses

Successful Response

application/json
object
hasMore
required

Whether this is the last page of results or not.

boolean
nextPage

A token to retrieve the next page of results.

string
>= 1 characters
response
required

Array of products.

Array<object>

A product is the minimum unit that can be sold within a marketplace catalog.

object
active

Products that exist in the catalog, whether they have stock or not. Change this to ‘false’ if you want to deactivate this product from the catalog. Soft-deleted products will be removed from active campaigns. Note: Any active products being upserted will be added to existing campaigns created through the Building Blocks service using the Promote My Shop feature.

boolean
default: true
brand

The product brand information.

object
id
required

The brand ID.

string
>= 1 characters
name
required

The brand name.

string
>= 1 characters
categories
required

The category IDs.

Array<string>
description

The product description.

string
>= 1 characters
ean

Thirteen digit EAN-13 code.

string
>= 13 characters <= 13 characters
id
required

The product ID.

string
>= 1 characters
imageURL

The product image URL. 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 product name.

string
>= 1 characters
price

The product price in the configured currency.

number
quality_score

Marketplace’s internal quality score for the product. This in an optional advanced use case, for which we can provide some insights. Examples of metrics include the product’s rating, conversion rate, click through rate, combination of other metrics, etc.

number
<= 1
vendors
required

The vendor IDs.

Array<string>