Upsert Products

Upsert products.

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

Try it

Upsert Products

cURL

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

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Body

application/json

products · Product · object[] · required

The products to create or substitute.

Required array length: 1 - 500 elements

Show child attributes

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

products. name · string · required

Name of the product. Shown in Topsort UI.

Minimum string length: 1

products. vendors · string[] · required

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

products. categories · string[] · required

IDs of the categories this product belongs to.

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

products. brand · Brand · object

Brand information of the product.

Show child attributes

products.brand. id · string · required

The brand ID.

Minimum string length: 1

products.brand. name · string · required

The brand name.

Minimum string length: 1

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

products. price · number | null

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

Required range: x > 0

Example:

18.99

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

products. ean · string | null

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

Required string length: 13

Example:

"4003994155486"

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

products. metadata · Metadata · object

Additional metadata for the product.

Show child attributes

products.metadata. {key}

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

Response

204

Successful Response