GET
/
public
/
v1
/
catalog-search-service
/
catalogs
/
products
Get Products
curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
  --header 'Authorization: Bearer <token>'
{
  "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",
      "globalId": "PROD-12345",
      "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"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI.

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.

Search terms to look for in product names and descriptions.

Response

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.

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