{"method":"GET","path":"https://api.revcent.com/v2/products/search","summary":"Search Products","description":"Search previously created products using a search term. Useful for finding a product when you do not know the product ID and wish to retrieve the details of a specific product. Once a product has been found, use an individual search results' id property and the GetProduct operation to retrieve the sale details.<br><br>Note: If you have multiple stores with the same products it is important to differentiate found products using the store property. I.e. if searching by SKU or name you may receive multiple results as each store has the same details.","operationId":"SearchProducts","parameters":[{"name":"search_term","description":"The single search term or phrase. The search term will be used to find products using a full-text search engine. The search engine analyzes the following fields:<br><table class=\"table table-bordered\"><thead class=\"small\"><tr><th>Field</th> <th>Description</th></tr></thead> <tbody><tr><td>id</td> <td>The RevCent ID of the product.</td></tr> <tr><td>name</td> <td>The name of the product.</td></tr> <tr><td>sku</td> <td>Product SKU.</td></tr> <tr><td>internal_id</td> <td>The product internal ID.</td></tr> <tr><td>additional_id</td> <td>Any additional ID's associated with the product.</td></tr> <tr><td>metadata</td> <td>Metadata values associated with the product.</td></tr></tbody></table>","in":"query","required":true,"schema":{"type":"string"},"style":"form"}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"additionalProperties":false,"properties":{},"type":"object"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"API call response code.","type":"integer","format":"int32","enum":[1]},"results":{"items":{"type":"object","additionalProperties":false,"properties":{"item_type":{"type":"string","description":"The item type returned in the search result.","enum":["product"]},"id":{"title":"Product ID","type":"string","description":"A 20 character product ID.","minLength":20,"maxLength":20},"created_date_unix":{"description":"The unix timestamp of when the item was created.","type":"integer","format":"unix-time"},"name":{"type":"string","description":"The product name."},"description":{"type":"string","description":"The product description."},"price":{"type":"number","format":"float","description":"The product price."},"sku":{"type":"string","description":"The product SKU."},"internal_id":{"type":"string","description":"The product internal ID specific to the product."},"shop":{"type":"string","description":"The name of the store associated with the product, if applicable."},"url":{"type":"string","description":"The direct URL to the product page in RevCent."},"highlights":{"items":{"type":"object","additionalProperties":false,"properties":{"field":{"type":"string","description":"The search field where the highlighted match was found."},"values":{"type":"array","description":"The values that matched within the search field.","items":{"type":"string","description":"The individual value that matched."}}}},"type":"array","description":"The fields that matched within the result, indicated by the search engine."},"score":{"type":"number","description":"The score for the individual search result. The score is determined by the search engine, with a higher score meaning a better match.","format":"float"}}},"type":"array"}},"type":"object","additionalProperties":false}}},"description":"Successful response."},"default":{"content":{"application/json":{"schema":{"description":"","properties":{"api_call_id":{"type":"string","description":"A 20 character API call ID.","minLength":20,"maxLength":20},"api_call_unix":{"description":"Unix timestamp of when the API call was initiated.","type":"integer","format":"unix-time"},"code":{"description":"This value indicates that there is an error. Will always be 0.","type":"integer","enum":[0]},"error_code":{"description":"The specific error code.","type":"string"},"message":{"description":"A human readable description of the error.","type":"string"},"result":{"description":"A description of the API call result.","type":"string"}},"title":"APIStandardErrors","type":"object","additionalProperties":false}}},"description":"Error response."}}}