REST API
Recommendations
View a specific Recommendation
you can retrieve a recommendation by it's id it is important to store the recommendation id as a reference in your application return this call returns the entire recommendation object { "tab" "examples", "url" "/v1/dispensary/recommendation/\ recommendation id", "name" "api", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "recommendation id", "type" "integer", "children" \[], "description" "the patient id for which to view this recommendation" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "the access token" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "st7x5ecla7vjy6twnarmd", "code" "{\n \\"recommendation id\\" \\"6e6e08cf e2a0 4e0e 9359 e2e42896b56e\\",\n \\"note\\" \\"overall recommendation notes\\",\n \\"status\\" \\"pending\\",\n \\"patient\\" {\n \\"patient id\\" 71,\n \\"firstname\\" \\"juergen\\",\n \\"lastname\\" \\"schreck\\",\n \\"email\\" \\"juergen+uat\@gethealthy store\\"\n },\n \\"practice id\\" 1,\n \\"notify email\\" 1,\n \\"notify sms\\" 0,\n \\"practice conversion url\\" \\"https //uat gethealthy store/admin/dispensary/recommendation/convert/rid/6e6e08cf e2a0 4e0e 9359 e2e42896b56e/\\",\n \\"patient conversion url\\" \\"https //uat gethealthy store/dispensary/recommendation/convert/rid/6e6e08cf e2a0 4e0e 9359 e2e42896b56e/\\" \n \\"items\\" \[\n {\n \\"item id\\" \\"54dddeea 19d6 4914 8b52 4064f050737c\\",\n \\"sku\\" \\"sf811\\",\n \\"qty\\" 1,\n \\"autoship interval\\" \\"once\\",\n \\"fulfillment type\\" \\"lc\\",\n \\"note\\" \\"item specific note\\",\n \\"additional options\\" \[],\n \\"availability\\" \\"in stock\\",\n \\"doctor id\\" 25,\n \\"location id\\" 123\n },\n {\n \\"item id\\" \\"179a7ef1 e1c7 42a2 a468 bd50dbee71f8\\",\n \\"sku\\" \\"sp607\\",\n \\"qty\\" 2,\n \\"autoship interval\\" \\"30d\\",\n \\"fulfillment type\\" \\"1l\\",\n \\"note\\" \\"this is really good stuff\\",\n \\"additional options\\" \[],\n \\"availability\\" \\"in stock\\"\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "st7x5ecla7vjy6twnarmd" }, "examples" { "languages" \[ { "id" "hpvb1zgoji teuayldtf", "code" "curl location g request get 'https //{{api host}}/rest/{{scope}}/v1/dispensary/recommendation/6e6e08cf e2a0 4e0e 9359 e2e42896b56' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer {{access token}}' ", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "hpvb1zgoji teuayldtf" }, "description" "", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }