Get Products

Get multiple products from the catalog.

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

Try it

Get Products

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "response": [
    {
      "id": "<string>",
      "name": "<string>",
      "vendors": [
        "<string>"
      ],
      "categories": [
        "<string>"
      ],
      "description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
      "brand": {
        "id": "<string>",
        "name": "<string>"
      },
      "imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
      "price": 18.99,
      "active": true,
      "ean": "4003994155486",
      "quality_score": 0.5,
      "metadata": {},
      "globalId": "PROD-12345"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

next_page · string | null

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

ean · string | null

European Article Number to filter products by. Formatted as a thirteen digit EAN-13 code.

vendor_id · string | null

Vendor ID to filter products by.

search · string | null · default: ""

Search terms to look for in product names and descriptions.

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 · Product · object[] · required

Array of products.

Show child attributes

response. id · string · required

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

Minimum string length: 1

response. name · string · required

Name of the product. Shown in Topsort UI.

Minimum string length: 1

response. vendors · string[] · required

IDs of the vendors that can promote this product in campaigns.

response. categories · string[] · required

IDs of the categories this product belongs to.

response. description · string | null

Description of the product.

Minimum string length: 1

Example:

"Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois."

response. brand · Brand · object

Brand information of the product.

Show child attributes

response.brand. id · string · required

The brand ID.

Minimum string length: 1

response.brand. name · string · required

The brand name.

Minimum string length: 1

response. imageURL · string<uri>

URL of the product image. This image will be displayed in the Topsort UI. 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/products/eyGqR4YQgBJa.jpg"

response. price · number | null

Price of the product in the currency configured in the marketplace.

Required range: x > 0

Example:

18.99

response. active · boolean · default: true

Flag that indicates whether this product is active. Only active products can take part in campaigns and auctions. Set this value to false to deactivate a product. When a product is deactivated it will be removed from active campaigns. We advise to set this flag to false when a product is out of stock.

response. ean · string | null

European Article Number. Formatted as a thirteen digit EAN-13 code.

Required string length: 13

Example:

"4003994155486"

response. quality_score · number | null

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.

Required range: 0 < x <= 1

response. metadata · Metadata · object

Additional metadata for the product.

Show child attributes

response.metadata. {key}

response. globalId · string | null

Global ID of the product. This is an optional field that can be used to link the product to other marketplaces

Example:

"PROD-12345"

nextPage · string | null

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

Minimum string length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="