API Reference

Create a checkout session

post
https://api-pharmacy.cannaflow.de/api/v1/prescriptions/checkout

Create a checkout session for a prescription, the prescription will be automatically created on a successful payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1

An ID used to identify the prescription. This id should be unique in your system (e.g. internal ID of your treatment/prescription).

Optional patient identifier from your system

Optional pharmacy identifier from your system

boolean

Send checkout url to the patient after signed document is submitted or always after the prescription is created. Default sends the email directly.

string
required
length ≥ 1

Cannaflow pharmacy ID. If provided, the patient can only choose this pharmacy for their order. If the pharmacy is out of stock, the prescription cannot be created and an error is thrown.

patient
object
required

Patient information

doctor
object
required

Prescribing doctor's information. Can be also provided by submitting the prescription.

products
array of objects
required

Prescription-required cannabis products with optional price expectation.

products*
nonPrescriptionProducts
array of objects

BETA: Optional array of non-prescription products (standard, addon) that do not require a prescription but should be included in the order. Products will be preselected in checkout page.

nonPrescriptionProducts
string

Prescription date in YYYY-MM-DD format. Current date will be used if not provided

notifications
object

Notification settings. Support for SMS notifications is coming soon.

string

Optional reference to a cannaflow lead

string

Discount code

string

Optional dynamic data attached to the prescription. Structure varies based on source.

shippingOption
object
required
string
enum
required

Payment method

redirectParameters
object
required
Responses

Updated 12 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago