Get Products

GET

public

catalog-search-service

catalogs

products

curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products

{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "response": [
    {
      "active": true,
      "brand": {
        "id": "es5086vyV",
        "name": "Delirium"
      },
      "categories": [
        "ahEDqV5uhjj8"
      ],
      "description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
      "ean": "4003994155486",
      "id": "eyGqR4YQgBJa",
      "imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
      "metadata": {},
      "name": "Delirium Tremens Beer Bottle 330cc x6",
      "price": 18.99,
      "quality_score": 0.5,
      "vendors": [
        "9SiwYqqL8vdG",
        "BRAND-48795"
      ]
    }
  ]
}

Query Parameters

next_page

string

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

ean

string

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

vendor_id

string

Vendor ID to filter products by.

string

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

object[]

required

Array of products.

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

response.categories

string[]

required

IDs of the categories this product belongs to.

Example:

["ahEDqV5uhjj8"]

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

Example:

"eyGqR4YQgBJa"

response.name

string

required

Name of the product. Shown in Topsort UI.

Minimum length: 1

Example:

"Delirium Tremens Beer Bottle 330cc x6"

response.vendors

string[]

required

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

Example:

["9SiwYqqL8vdG", "BRAND-48795"]

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. Note: Active products being upserted will be added to existing campaigns created through the Building Blocks service using the Promote My Shop feature.

response.brand

object

Brand information of the product.

response.description

string

Description of the product.

Minimum length: 1

Example:

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

response.ean

string

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

Required string length: 13

Example:

"4003994155486"

response.imageURL

string

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

Example:

"https://cdn.example.com/products/eyGqR4YQgBJa.jpg"

response.metadata

object

Additional metadata for the product.

response.price

number

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

Required range: x > 0

Example:

18.99

response.quality_score

number

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

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="

Get Category Upsert Products

curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products

{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "response": [
    {
      "active": true,
      "brand": {
        "id": "es5086vyV",
        "name": "Delirium"
      },
      "categories": [
        "ahEDqV5uhjj8"
      ],
      "description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
      "ean": "4003994155486",
      "id": "eyGqR4YQgBJa",
      "imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
      "metadata": {},
      "name": "Delirium Tremens Beer Bottle 330cc x6",
      "price": 18.99,
      "quality_score": 0.5,
      "vendors": [
        "9SiwYqqL8vdG",
        "BRAND-48795"
      ]
    }
  ]
}

General

Auction examples

Asset examples

Webhook examples

Auctions

Events

Toptimize

Assets API

Billing API

Campaign API

Catalog API

Invitation API

Modal API

Reporting API

Segments Service

Toppie API

User API

Webhooks API

Query Parameters

Response