<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/billing/products/list-products -->

# List Products

Retrieve a paginated list of products with optional filtering and sorting.

<EndpointHeader verb="GET" path="/merchant/api/v1/products" />

## Request

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
    { name: "Content-Type", required: true, desc: "`application/json`" },
  ]}
/>

### Query Parameters

<ParamTable
  rows={[
    { name: "status", type: "string", desc: "Filter by status: `ACTIVE`, `INACTIVE`, `ARCHIVED`" },
    { name: "currency", type: "string", desc: "Filter by currency code" },
    { name: "categoryId", type: "number", desc: "Filter by category ID" },
    { name: "page", type: "number", desc: "Page number (default: `1`)" },
    { name: "limit", type: "number", desc: "Items per page (default: `20`, max: `100`)" },
    { name: "sortBy", type: "string", desc: "Sort field (default: `createdAt`)" },
    { name: "sortOrder", type: "string", desc: "Sort direction: `ASC` or `DESC` (default: `DESC`)" },
    { name: "searchTerm", type: "string", desc: "Search by product name or SKU" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "items": [
      {
        "productId": "prod_a1b2c3d4e5f6g7h8",
        "name": "Pro Plan",
        "description": "Professional subscription plan with advanced features",
        "price": 4999,
        "currency": "INR",
        "sku": "PRO-PLAN-001",
        "status": "ACTIVE",
        "categoryId": 1,
        "images": [
          {
            "url": "https://example.com/images/pro-plan.png",
            "alt": "Pro Plan",
            "isPrimary": true
          }
        ],
        "pricingTiers": [],
        "metadata": {},
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  },
  "message": "Products retrieved successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 35,
    "api_version": "v1",
    "endpoint": "GET /products",
    "user_type": "merchant"
  }
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "VALIDATION_ERROR", status: "400", message: "Invalid query parameters" },
    { code: "UNAUTHORIZED", status: "401", message: "Invalid API key" },
  ]}
/>

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/products?status=ACTIVE&page=1&limit=20" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json"
```

  </TabItem>
  <TabItem value="javascript" label="JavaScript">

```javascript
const params = new URLSearchParams({
  status: 'ACTIVE',
  page: '1',
  limit: '20',
});

const response = await fetch(`https://api.zenpayz.com/merchant/api/v1/products?${params}`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
});

const result = await response.json();
console.log(result.data.items); // Array of products
console.log(result.data.total); // Total count
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const products = await zenpays.products.list({
  status: 'ACTIVE',
  page: 1,
  limit: 20,
});

console.log(products.items); // Array of products
console.log(products.total); // Total count
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Create Product](/docs/rest-api/endpoints/billing/products/create-product)
- [Get Product](/docs/rest-api/endpoints/billing/products/get-product)
- [Update Product](/docs/rest-api/endpoints/billing/products/update-product)
- [Delete Product](/docs/rest-api/endpoints/billing/products/delete-product)
