Recommendation Item Object

Recommendations are the mechnism by which practitioners create prescriptions to suggest supplements to their patients. Once a recommendation is sent via email, it remains accessible to the patient in their store dashboard. They may reorder these recommendations at any given time. Addtiionally the practitioner may specify a recurrening schedule to automatically ship refills at automatic intervals.

Creating recommendations requires a patient_id, so a patient record must be created prior to creating a recommendation.

The Recommendation Item Object

{
    "item_id": "ae483c8c-11b5-4aa7-871f-17080ab7cdb4",
        "sku":"SP907",
        "qty":1,
        "note":"Take 1 in the morning and 1 at bedtime.",
        "autoship_interval":"30d",
        "fullfillment_type":"1L",
        "availability":"In Stock"
        "doctor_id": 25,
        "location_id": 123,
        "additional_options":[]
    }
    
}

item_id uuid The main identifier for this object.

sku string The sku for the recommended item. You can derive skus from the catalog product object.

qty integer The recommended quantity for this item. Default: 1

note string

A note specific to this item. Typically dosage instrunctions.

autoship_interval string The interval at which to ship this item to the patient. Default: once Possible values are the literal string of once or a timespec comprised of an integer and a time unit. The time unit is once of d for days, w for weeks or m for months.

Example: 30d This will ship the item every 30 days. A valid credit card must be on file for this to succeed.

fulfillment_type string This allows control over how the item will be delivered. Default: automatic The primary use case is in practice / on location fulfillment where the practitioner hands the item to the patient. Unless specifically set for in practice fulfillment, the system will pick the proper fulfillment options based on our internal item definitions. Accepted values: LC One Time local fulfillment. Use this code to fulfill a single purchase on location. 1L First Time local fulfillment. Use this code when add an autoship item but fulfill the initial item on location.

availability string read-only

The availability property reports the stock status for an item. Availability can also be checked prior to adding items to a recommendation, using the availability endpoint. In Stock The item is available for purchase at time of recommendation. This is not a guarantee that the item will remain in stock by the time the recommendation is converted to a purchase, depending on the time between recommendation and purchase. Backordered This item is available purchase but it will be back ordered. The item will ship once it's back in stock.

Out of Stock This item is currently not available for purchase.

doctor_id integer The id of a doctor object associated with this item. Commonly only set when different than the doctor associated with the patient record.

location_id integer The id of a location object associated with this item. Commonly only set when different than the location associated with the patient.

additional_options array read-only

An array of supplemental item data such as a birthdate or patient name for tests.

Recommendation Item Object

Core Attributes