Products API

The Products API gives access to your product catalog information in the TestFreaks platform.

GET /v1/products (List products)

Request parameters

limit, how many products per page, default 100, maximum 1000

client_id, the unique identifier for your client configuration.

family_id, if set you will filter only products in this product family

after, used for pagination

Response body

See below, and see the separate product feed documentation.

If .links.next is set, additional pages are available by following the link.

If .errors is set, it’s a list of errors.

Example

$ curl -u sk_token: https://api.testfreaks.com/v1/products?client_id=example.com
{
  "data": [
    {
      "id": "P001-02-BLK",
      "family_id": "P001",
      "brand": null,
      "name": "Some Product Name",
      "category": "Some Category",
      "url": "https://example.com/productpage",
      "image_url": "https://example.com/image.jpg",
      "mpn": null,
      "gtin14s": [
        "06413999514019"
      ],
      "tags": [],
      "match_status": null,
      "deleted": false,
      "properties": {
          "color": "BLACK"
      },
      "created_at": "2020-06-23T08:58:20Z",
      "updated_at": "2021-09-14T16:41:59Z"
    }
  ],
  "links": {
    "next": "https://api.testfreaks.com/v1/products?after=1142331"
  }
}