Supplements

Search all supplements

get/supplements/search/{terms}

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/supplements/search/{terms}
  • Auth: HTTP basic

Path parameters

termsstring urlencoded required

You can enter several terms with spaces between each (make sure to url-encode the search string, so spaces would be %20). Each term is treated as potentially a wildcard search so “vitam%20D” (“vitam D”) would return “Vitamin D”, “Vitamin D1000”, etc.

Query parameters

limitinteger

Defaults to 100, but can be overridden (max is 100)

offsetinteger

If the returned data indicates that there is more than the limit responses (has_more: true), then it will offset the list to allow you to cycle through long supplement list

active_onlyboolean

If this parameter is set it will only include ACTIVE supplements

vendor_codestring

If this parameter is set it will only supplements with matching vendor code (note, this is different from the external_ref_id).

classstring

If this parameter is set it will only supplements with that class specified

external_ref_idstring

If this parameter is set it will only include items with the designated external identifier - generally you will want to make this unique so it only includes a single item.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.