Skip to main content
Version: V2

GET Search Products

Route​

/api/v2/product/search

Ability​

  • search-product

Query Parameters​

  • query (required, string, min 3)
  • results (optional, int 1-50)
  • page (optional, int >= 1)

Response 200 (success)​

{
  "error": false,
  "results": [
    {
      "product_name": "string|null",
      "product_brand": "string|null",
      "product_category": "string|null",
      "product_unique_id": "string|null",
      "product_style_code": "string|null",
      "product_release_date": "YYYY-MM-DD|string|null",
      "product_description": "string|null",
      "product_colorway": "string|null",
      "product_retail_price": "string|number|null",
      "product_image": "https://.../api/image/uid/{product_unique_id}|null",
      "match_count": 1
    }
  ],
  "pagination": {
    "total": 123,
    "per_page": 20,
    "current_page": 1,
    "last_page": 7
  },
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": true
}

Response 200 (no matches)​

{
  "error": true,
  "message": "No products could be found for this search query.",
  "response_time": "XXXms",
  "request_fulfilled": true,
  "request_debited": false
}

Response 400 or 403​

{
  "error": true,
  "message": "validation errors object or token depleted message",
  "response_time": "XXXms",
  "request_fulfilled": false,
  "request_debited": false
}