Update Products

PATCH

public

catalog-search-service

catalogs

products

curl --request PATCH \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {
      "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"
      ]
    }
  ]
}'

This response does not have an example.

Body

application/json

products

object[]

required

The products to update.

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

products.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"

products.active

boolean

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.

products.brand

object

Brand information of the product.

products.categories

string[]

IDs of the categories this product belongs to.

Example:

["ahEDqV5uhjj8"]

products.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."

products.ean

string

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

Required string length: 13

Example:

"4003994155486"

products.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"

products.metadata

object

Additional metadata for the product.

products.name

string

Name of the product. Shown in Topsort UI.

Minimum length: 1

Example:

"Delirium Tremens Beer Bottle 330cc x6"

products.price

number

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

Required range: x > 0

Example:

18.99

products.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

products.vendors

string[]

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

Example:

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

Response

204

_mintlify/placeholder

Successful Response

Delete Products Get Products Count

curl --request PATCH \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {
      "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"
      ]
    }
  ]
}'

This response does not have an example.

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

Body

Response