API Changelog

The changelog lists all changes that have been made to the API (both breaking and non-breaking). The most recent changes appear at the top.

Patch Version: 2020-02-14

Change

• Added a source attribute to the List all patient treatment plans, Retrieve a treatment plan. 2023-04-19
• Added a source attribute to the List All TreatmentPlan Events. 2023-04-19
• Added a expected_return_date attribute to the variant endpoint. 2022-05-13
• Added a margin_type attribute to the Clinic object. 2022-02-09
• Added an invite_accepted attribute to the Practitioner object. 2022-02-04
• Added endpoint for fullscript_protocols under Protocols. 2022-01-18
• Made it possible to return protocols shared with a practitioner by passing in the ownership_type parameter to the list all practitioner protocols endpoint. 2021-06-14
• Made it possible to return a practitioner's custom dosage for a product by passing in the practitioner_id parameter to the retrieve a product endpoint. 2021-06-10
• Made it possible to sort protocols by either their name or current state by passing in the sort_by parameter with a value of either name or current_state to the list protocols endpoint. Ordering defaults to ASC. However, the order_by parameter accepts either ASC or DESC. 2021-01-26
• Made it possible to filter protocols by their current_state by passing an optional current_state parameter to the list protocols endpoint. 2021-01-26
• Made it possible to clear associated metadata by passing null as the metadata's ID. 2021-01-26
• Added a primary_variant object to the product search endpoint. 2020-11-06
• Added primary attribute to the variant endpoint and a variant_count to the product endpoint. 2020-11-02
• Added a bit more information to oauth_access_tokens and included the resource_owner's type and id. 2020-10-01
• Added endpoints for allergens, ingredients, supplement_types, and third_party_certifications under Catalog.
• Added ability to filter on allergens, ingredients, supplement_types, and third_party_certifications in the product search endpoint.
• Added created_at and updated_at fields to the patient treatment plans endpoint. 2020-07-08
• Added order_by to accept values - created_at and updated_atand sort_by to accept - "ASC" and "DESC" to be specified in the patient treatment plans endpoint. It can be used to order the treatment plans by created_at and updated_at and in ascending or descending order 2020-07-08
• Added Dynamic link endpoint to retrieve an existing treatment_plan link. 2020-06-17
• Update and create actions for Patients, practitioners, and treatment plans now accept a metadata object to attach external identifiers. 2020-02-14
• The metadata endpoint can be used to find objects by their external identifier 2020-02-14
• Added a new endpoint to list protocols. 2020-09-21
• Added a new endpoint to retrieve a protocol. 2020-09-21

Breaking Change

• Removed external_ref from patients, practitioners, and treatment plans in favor of the new metadata object 2020-02-14
• Blank values for patients mobile_number now show as null instead of "" 2020-02-14

Patch Version: 2019-03-24

Change

• The external_ref parameter will be removed in the next patch version in favor of metadata. 2020-02-10
• Added metadata endpoint for object lookup by ID 2020-02-10
• Added metadata object to patients, practitioners, and treatment plans 2020-02-10
• Added patient and practitioner id to treatment plan
• Added webhook for when an order is placed. 2019-11-14
• We've introduced OAuth for an improved experience for authorization. 2019-07-22
• Added webhooks for product create and product update actions. 2019-04-11

Breaking Change

• Note these changes to the treatment_plan response hash also apply to treatment_plan webhooks.
• Removed the active attribute from the treatment plan endpoint. Use state instead. 2019-04-10
• Renamed attribute quantity_recommended to units_to_purchase in the recommendations hash of the treatment plan endpoint 2019-04-10
• Renamed the following attributes and moved it into a dosage hash within the recommendations hash of the treatment plan endpoint. dosage_amount to amount, dosage_frequency to frequency, dosage_duration to duration, dosage_permutations to additional_info and dosage_format to format 2019-04-10

Patch Version: 2019-02-08

Change

• Added hash brand and attribute status to category products endpoint so that you can see a more complete picture of the product data. 2019-03-20
• Added endpoint to activate a treatment plan. 2019-03-18
• Added the attribute state to treatment plan. 2019-03-12
• Added the ability to create a draft treatment plan. 2019-03-12
• Added personal_message attribute to templates. 2019-03-11
• Added endpoint to cancel a treatment plan. 2019-03-08
• Added dosage hash to product endpoint. 2019-03-07
• Added status attribute to Products. 2019-03-06
• Added endpoint to update a treatment plan. 2019-02-28
• Added status attribute and ability to filter by status to brands. 2019-02-26
• Added a new endpoint to list similar products. 2019-02-15
• Added item_total attribute to the order endpoint. 2019-02-08

Breaking Change

• Removed the total attribute from the order endpoint. Use payment_total instead. 2019-02-08
• Removed variant_ids array from the order endpoint. This is duplicated as the variant_ids are now available in the line_items object. 2019-02-08

Patch Version: 2018-03-05

Change

• Added documentation for webhooks and an endpoint to see the results of webhook deliveries. 2019-01-23
• Added msrp_total to the order endpoint and clarified the description / difference between total and msrp_total. 2018-12-05
• Added attributes integration_id and integration_activated_at to clinic endpoint. 2018-11-22
• Added endpoints for Events. 2018-11-09
• Added attribute personal_message to the treatment plan endpoint. 2018-10-22
• Bugfix. Fixed a bug that would throw a 500 error when entering a brand_id which was unable to be viewed by some clinics. It now throws a more helpful error instead. Also updated documentation around product search to make it clearer how this endpoint works. 2018-09-26
• Updated the variant endpoint. Added 3 different sizes of image_urls as well as brand information to the response. 2018-09-12
• Added a gender field to the patient endpoints. 2018-08-31
• Added a new endpoint to list all orders for clinic. 2018-08-14
• Added a categories endpoint for clinic. 2018-08-02
• Added an address endpoint for patients. 2018-07-31
• Added attributes line_items, total and payment_total to order object. 2018-07-24
• Added a new endpoint so that practitioner's can create in-office checkouts through the API. 2018-07-23
• Added a new endpoint to list templates. 2018-07-16
• Added a new endpoint to retrieve a template. 2018-07-16
• Added html product descriptions to the product endpoint. 2018-06-18
• Added product information to the variant endpoint. 2018-05-29
• Fixed an issue with some treatment_plans not showing up correctly. 2018-05-30
• Added attribute dispensary_url to the clinic endpoint. 2018-05-23
• Added ability to update the discount level on patients. 2018-05-23
• Added a new endpoint to search for patients. 2018-05-15
• Added an attribute to the patient object so that welcome emails can be disabled when creating new patients. 2018-05-14
• Added a variant endpoint. Fixed an issue with pagination. 2018-05-07
• V2 launched! 2018-04-16