Get Product Catalogs

GET /product-catalogs

Parameters

• searchParam (string, query, optional): Search parameter to filter product catalogs.
• categoryPublicIds (string, query, optional): Comma-separated list of category public IDs to filter product catalogs.
• manufacturerPublicIds (string, query, optional): Comma-separated list of manufacturer public IDs to filter product catalogs.
• warrantyTypePublicIds (string, query, optional): Comma-separated list of warranty type public IDs to filter product catalogs.
• measuringUnitPublicIds (string, query, optional): Comma-separated list of measuring unit public IDs to filter product catalogs.
• page (integer, query, optional): One-based page index for pagination (default: 1).
• size (integer, query, optional): Number of items per page (default: 20).
• sort (array[string], query, optional): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
• countryCode (string, header, required): The country code header.

[
  {
    "productId": "string",
    "productName": "string",
    "description": "string",
    "price": 0.0,
    "category": "string"
  }
]

Responses

200 OK

• Media Type: application/json

Example Value

{
  "message": "string",
  "data": [
    {
      "publicId": "string",
      "productName": "string",
      "productDescription": "string",
      "measurementUnit": "string",
      "productListing": "string",
      "defaultImageUrl": "string",
      "productHighlights": "string",
      "warrantyDuration": "string",
      "warrantyCover": "string",
      "warrantyType": {
        "id": "string",
        "publicId": "string",
        "warrantyTypeName": "string",
        "description": "string",
        "status": "string",
        "new": "string"
      },
      "warrantyAddress": "string",
      "status": "string",
      "variantCount": 0,
      "note": "string",
      "brand": {
        "id": "string",
        "publicId": "string",
        "brandName": "string",
        "description": "string",
        "status": "string"
      },
      "manufacturer": {
        "id": "string",
        "publicId": "string",
        "description": "string",
        "manufacturerName": "string",
        "status": "string",
        "new": true
      },
      "productCategory": {
        "id": "string",
        "publicId": "string",
        "productCategoryName": "string",
        "description": "string",
        "imageUrl": "string",
        "status": "string",
        "depth": 0,
        "new": true
      }
    }
  ],
  "meta": {
    "currentPage": 0,
    "from": 0,
    "to": 0,
    "perPage": 0,
    "total": 0,
    "lastPage": 0
  }
}