Go To Top

Private Products API

Insert or update (if they already exist) a batch of products

POST
https://api.trustpilot.com/v1/private/business-units/{businessUnitId}/products
Parameters
businessUnitId, Required String
The BusinessUnitId that owns the products.
Example: …/v1/private/business-units/{businessUnitId}/products

Request
{
  "products": [
    {
      "sku": "Prod123",
      "googleMerchantCenterProductId": "Product_DK_1007653571_2874605123",
      "title": "Toy car",
      "link": "http://myshop.com/products/toy-car",
      "imageLink": "http://myshop.com/products/images/toy-car.jpg",
      "price": "99.95 EUR",
      "currency": "USD",
      "gtin": "3200000003774",
      "mpn": "HSC0424PP",
      "brand": "ToyProducer",
      "description": "A very soft shoe built for walking long distances.",
      "productCategoryGoogleId": "1267"
    }
  ],
  "skuSameAsGoogleMerchantCenterProductId": true
}
Response
{
  "products": [
    {
      "id": "507f191e810c19729de860ea",
      "sku": "Prod123",
      "googleMerchantCenterProductId": "Product_DK_1007653571_2874605123",
      "title": "Toy car",
      "link": "http://myshop.com/products/toy-car",
      "imageLink": "http://myshop.com/products/images/toy-car.jpg",
      "processedImages": [
        {
          "type": "100pxWide",
          "url": "https://product-reviews-images.trustpilot.com/5837640412df3f0aabf9989a_100pxWide.png"
        }
      ],
      "price": "99.95",
      "currency": "EUR",
      "gtin": "3200000003774",
      "mpn": "HSC0424PP",
      "brand": "ToyProducer",
      "groupId": "123456",
      "variationAttributes": {
        "color": "blue",
        "pattern": "striped",
        "material": "suede",
        "ageGroup": "adult",
        "gender": "female",
        "size": "XS",
        "customVariationAttributes": [
          {
            "key": null,
            "value": null
          }
        ]
      }
    }
  ]
}

Get products

GET
https://api.trustpilot.com/v1/private/business-units/{businessUnitId}/products
Parameters
businessUnitId, Required String
The BusinessUnitId that owns the products.
Example: …/v1/private/business-units/{businessUnitId}/products

skus, Optional Array
Optional sku filter for products.
Example: ?skus={skus}
* provide multiple values using comma seperation

groupId, Optional String
Optional group id filter for products. When sku filter is given, the group id filter is ignored.
Example: ?groupId={groupId}

page, Optional Integer
The page to retrieve.
Default value: 1
Example: ?page=0

perPage, Optional Integer
The number of products to retrieve per page.
Default value: 10000
Example: ?perPage=0

locale, Optional String
The language in which the attributes attached to the products, if any, are returned
Example: ?locale={locale}

Response
{
  "products": [
    {
      "id": "507f191e810c19729de860ea",
      "sku": "Prod123",
      "googleMerchantCenterProductId": "Product_DK_1007653571_2874605123",
      "title": "Toy car",
      "link": "http://myshop.com/products/toy-car",
      "imageLink": "http://myshop.com/products/images/toy-car.jpg",
      "processedImages": [
        {
          "type": "100pxWide",
          "url": "https://product-reviews-images.trustpilot.com/5837640412df3f0aabf9989a_100pxWide.png"
        }
      ],
      "businessUnitId": "507f191e810c19729de860ea",
      "price": "99.95",
      "gtin": "3200000003774",
      "mpn": "HSC0424PP",
      "brand": "ToyProducer",
      "currency": "EUR",
      "description": "A metal toy car",
      "productCategory": {
        "id": "507f191e810c19729de860ea",
        "name": "Clothing"
      },
      "attributes": [
        {
          "id": "attributes-default-comfort",
          "name": "Comfort"
        }
      ],
      "groupId": "123456",
      "variationAttributes": {
        "color": "blue",
        "pattern": "striped",
        "material": "suede",
        "ageGroup": "adult",
        "gender": "female",
        "size": "XS",
        "customVariationAttributes": [
          {
            "key": null,
            "value": null
          }
        ]
      }
    }
  ],
  "isLastPage": false
}