# Product Catalog API

**GET** `/{catalog-id}/products`

Product: [WhatsApp](https://devdocs.pinnacle.in/docs/whatsapp.md)  
Version: [3.0](https://devdocs.pinnacle.in/docs/whatsapp/3-0.md)

This API is used to fetch the products in the given catalog id.

## Request

URL: `https://partnersv1.pinbot.ai/v3/{catalog-id}/products`

Authentication location: `header`

Authentication name: `apikey`

### Request schema


```json
{
  "type": "object",
  "properties": {
    "limit": {
      "type": "string",
      "x-parameter-in": "query"
    },
    "fields": {
      "type": "string",
      "x-parameter-in": "query"
    },
    "filter": {
      "type": "string",
      "x-parameter-in": "query"
    },
    "summary": {
      "type": "string",
      "x-parameter-in": "query"
    }
  }
}
```

### Request example


```json
{
  "limit": "2",
  "fields": "[\"category\",\"name\",\"retailer_id\",\"price\",\"availability\",\"description\",\"country\",\"brand\",\"image_url\",\"size\",\"color\",\"retailer_product_group_id\",\"thumbnail_product_retailer_id\"]",
  "filter": "{\"name\":{\"i_contains\":\"productchangedname\"}}",
  "summary": "true"
}
```

## Response schema


```json
{
  "type": "object",
  "properties": {
    "raw_example": {
      "type": "string"
    }
  }
}
```

## Response examples


```json
{
  "200": {
    "raw_example": "{\n\"data\": [\n{\n\"category\": \"Shirt\",\n\"name\": \"product changed name\",\n\"retailer_id\": \"group1\",\n\"price\": \"₹10.00\",\n\"availability\": \"in stock\",\n\"description\": \"product description\",\n\"brand\": \"Pinnacle\",\n\"image_url\":\n\"https:\n4-english-oven-bread-pav.jpg\",\n\"retailer_product_group_id\": \"1\",\n\"id\": \"catalog-id\"\n},\n{\n\"category\": \"Shirt\",\n\"name\": \"product changed name 3\",\n\"retailer_id\": \"group3\",\n\"price\": \"₹10.00\",\n\"availability\": \"in stock\",\n\"description\": \"product description\",\n\"brand\": \"Pinnacle\",\n\n\"image_url\":\n\"https:\n4-english-oven-bread-pav.jpg\",\n\"retailer_product_group_id\": \"1\",\n\"id\": \"catalog-id\"\n}\n],\n\"paging\": {\n\"cursors\": {\n\"before\": \"eyJvZAmZAzZAXQiOjB9\",\n\"after\": \"eyJvZAmZAzZAXQiOjF9\"\n},\n\"next\":\n\"https:\n%22i_contains%22%3A%22product%20changed%20name%22%7D%7D&summary=tr\nue&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22pr\nice%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22\nbrand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%20%22ret\nailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&limit=2&af\nter=eyJvZAmZAzZAXQiOjF9\",\n\"previous\":\n\"https:\n%22i_contains%22%3A%22product%20changed%20name%22%7D%7D&summary=tr\nue&fields=%5B%22category%22%2C%22name%22%2C%22retailer_id%22%2C%22pr\nice%22%2C%22availability%22%2C%22description%22%2C%22country%22%2C%22\nbrand%22%2C%22image_url%22%2C%22size%22%2C%22color%22%2C%20%22ret\nailer_product_group_id%22%2C%22thumbnail_product_retailer_id%22%5D&limit=2&b\nefore=eyJvZAmZAzZAXQiOjB9\"\n},\n\"summary\": {\n\"total_count\": 11\n}\n}\n"
  }
}
```

## Status codes


```json
[
  {
    "code": 200,
    "description": "The request was successful."
  },
  {
    "code": 400,
    "description": "Bad request or invalid parameters."
  },
  {
    "code": 401,
    "description": "API key is missing or invalid."
  },
  {
    "code": 403,
    "description": "The request is not authorized for this resource."
  },
  {
    "code": 404,
    "description": "The requested resource was not found."
  },
  {
    "code": 500,
    "description": "The server encountered an error."
  }
]
```