BuyRadar - AI Smart Shopping Assistant (USA) · Actions GPT

{
  "openapi": "3.0",
  "info": {
    "description": "API for interfacing with BuyRadar",
    "title": "BuyRadar API",
    "contact": {
      "name": "Support",
      "email": "support@buyradar.com"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://www.buyradar.com/api"
    }
  ],
  "paths": {
    "/search_gpt": {
      "post": {
        "operationId": "searchProducts",
        "description": "Allows users to search all kinds of products by various criteria.",
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "description": "The search query string",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "min_price",
            "in": "query",
            "description": "Filter products prices by this minimum price",
            "required": false,
            "schema": {
              "type": "float"
            }
          },
          {
            "name": "max_price",
            "in": "query",
            "description": "Filter products prices by this maximum price",
            "required": false,
            "schema": {
              "type": "float"
            }
          },
          {
            "name": "orderBy",
            "in": "query",
            "description": "Whether to sort the results by asc or desc order",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category_id",
            "in": "query",
            "description": "Category ID to filter categories",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Offset for pagination",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Number of items per page",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "status_code": {
                      "type": "integer"
                    },
                    "data": {
                      "$ref": "#/components/schemas/ProductData"
                    },
                    "single_product_mode": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          },
          "201": {
            "description": "No results"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Incorrect request"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "description": "Server error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ProductData": {
        "type": "object",
        "properties": {
          "products": {
            "$ref": "#/components/schemas/Products"
          }
        }
      },
      "Products": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductItem"
            }
          },
          "offset": {
            "type": "integer"
          },
          "total_records": {
            "type": "integer"
          },
          "num_results": {
            "type": "integer"
          }
        }
      },
      "ProductItem": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the shopping product"
          },
          "description": {
            "type": "string",
            "description": "The description text of the shopping product"
          },
          "deal_type": {
            "type": "string",
            "description": "Defines whether this product is a good deal, a bad deal, or a normal/average deal"
          },
          "price": {
            "type": "string",
            "description": "The current price of the product"
          },
          "ratingAvg": {
            "type": "float",
            "description": "The average review rarting from this product out of 5, if review data exists. The minimum is 1."
          },
          "currency_symbol": {
            "type": "string",
            "description": "The currency symbol for the price of the product. Usually $ for USD."
          },
          "image_url": {
            "type": "string",
            "description": "The image_url of the product, to show how the product looks like"
          },
          "purchase_link": {
            "type": "string",
            "description": "The url to proceed to view and purchase the product. THIS IS THE MOST IMPORTANT PROPERTY!"
          },
          "in_stock": {
            "type": "boolean",
            "description": "Whether the product is in stock"
          },
          "price_is_monthly_installment": {
            "type": "boolean",
            "description": "Whether the product price is a monthly installment"
          },
          "merchant": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Merchant"
            }
          }
        }
      },
      "Merchant": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the merchant that has this product in stock"
          }
        }
      }
    }
  }
}