Skip to main content

Search products

Search products

Endpoint​

GET /api/v1/products

Parameters​

{
  "parameters": [
    {
      "name": "q",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "category",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "minPrice",
      "in": "query",
      "schema": {
        "type": "number"
      }
    },
    {
      "name": "maxPrice",
      "in": "query",
      "schema": {
        "type": "number"
      }
    },
    {
      "name": "currency",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "country",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "cursor",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "schema": {
        "type": "integer"
      }
    }
  ]
}

Request Schema​

{
  "title": "Body"
}

Response Codes​

{
  "responses": {
    "200": {
      "description": "Products envelope",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "data": {},
              "meta": {
                "type": "object"
              },
              "error": {
                "type": "string"
              }
            },
            "title": "Envelope"
          }
        }
      }
    }
  }
}