Get Product

The ID of the product to retrieve.

IDs of the categories this product belongs to.

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

Name of the product. Shown in Topsort UI.

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

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.

Brand information of the product.

Description of the product.

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

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.

Additional metadata for the product.

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

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.