Add Items

whether the original recommendation was created using the comprehensive or simple format, items can be added individually the requirements for items are them same as for comprehensive format and require at minimum a sku and qty attribute the rest of the attributes are optional see the recommendation item object documention for details items with the same sku that already exist in the recommendation will be ignored return this call returns the entire recommendation object to which the items were added { "tab" "examples", "url" "/v1/dispensary/recommendation/\ recommendation id/item", "name" "api", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "recommendation id", "type" "integer", "children" \[], "description" "the recommendation to which the item should be added " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "authorization", "type" "string", "children" \[], "description" "the access token" } ], "bodydataparameters" \[ { "kind" "required", "name" "recommendation", "type" "object", "children" \[ { "kind" "required", "name" "item", "type" "object", "children" \[ { "kind" "required", "name" "sku", "type" "string", "description" "the item sku to add" }, { "kind" "required", "name" "qty", "type" "number", "description" "the item quantity to add" }, { "kind" "optional", "name" "note", "type" "string", "description" "a note for this item" }, { "kind" "optional", "name" "fulfillment type", "type" "string", "description" "lc for in practice fulfillment\n1l for first time in practice fulfillment on subscriptions" }, { "kind" "optional", "name" "autoship interval", "type" "string", "description" "for subscription recommendations see the recommendation item object spec for details " }, { "kind" "optional", "name" "doctor id", "type" "integer", "description" "to associate this item with a specific doctor see the doctor object spec for details " }, { "kind" "optional", "name" "location id", "type" "integer", "description" "to associate this item with a specific location see the location object spec for details " } ], "description" "item array" } ], "description" "recommendation object" } ], "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 },\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 \\"availability\\" \\"in stock\\",\n \\"additional options\\" \[]\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "st7x5ecla7vjy6twnarmd" }, "examples" { "languages" \[ { "id" "gumf2667lujndwb9cvr3w", "code" "curl location g request post 'https //{{api host}}/rest/{{scope}}/v1/dispensary/recommendation/6e6e08cf e2a0 4e0e 9359 e2e42896b56/item' \\\\\n header 'content type application/json' \\\\\n header 'authorization bearer {{access token}}' \\\\\n data raw '{\n \\"recommendation\\" {\n \\"items\\" \[{\n \\"sku\\" \\"sf811\\",\n \\"qty\\" \\"1\\",\n \\"autoship interval\\" \\"once\\",\n \\"note\\" \\"take two before bedtime \\"\n },{\n \\"sku\\" \\"sp607\\",\n \\"qty\\" 3,\n \\"fulfillment type\\" \\"1l\\",\n \\"autoship interval\\" \\"30d\\",\n \\"note\\" \\"this is really good stuff take 1 in the morning with food\\"\n }]\n }\n}'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "gumf2667lujndwb9cvr3w" }, "description" "", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }