API docs by Redocly

HealNow API (1.0)

Download OpenAPI specification:Download

Api Support: api-support@healnow.io URL: https://healnow.io

Introduction

Welcome to the HealNow REST API Documentation. Using this API, you can leverage our on-demand pharmacy payments platform to get your prescriptions paid and delivered easily without the hassle of changing your team's workflow.

Here is the typical flow:

  • Create a Patient. This will enable you to get started with any of the additional API's.
  • Add prescriptions to a patient's cart
  • An order is created & executed once the customer completes payment.

Request Content-Type

The Content-Type for POST and PUT requests can be set to application/x-www-form-urlencoded, multipart/form-data, or application/json.

CURL example:

You will have to replace ${apiKey} curl -H "Authorization: Bearer ${apikey}" -v https://api.healnow.io/v1/orders/${id} with your specific API key.

Authentication

ApiKey

Use "Authorization" header to send api key as Bearer token.

Security Scheme Type: API Key
Header parameter name: Authorization

Idempotency

The API supports idempotency for safely retrying POST operations without accidentally performing the same action twice. When you include an idempotency key on a POST request, the first successful response (status code and response body) is stored and returned for any retry with the same key and endpoint, avoiding duplicate side effects.

To perform an idempotent request, include the Idempotency-Key header on your POST request.

Stored responses live for 24 hours and are then purged; reusing an expired key is treated as a new request.

If you retry with the same key but change the request payload, the original response is still returned. Always generate a new key for any logically different operation or payload.

Only POST endpoints accept idempotency key. Supplying it on GET or DELETE requests has no effect.

Address

Address endpoints

List patient addresses

List patient address records

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create patient address

Create patient address record

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

Request Body schema: application/json
eid
string

External ID

street
required
string

Street name/number

street2
string or null

Floor, apt, etc.

city
required
string

City

postcode
required
string

Postcode (Zip)

state
required
string

State

country_code
required
string
Default: "us"

ISO 3166-1 Country Code

Responses

Request samples

Content type
application/json
{
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us"
}

Response samples

Content type
application/json
{
  • "id": "O9NGaN38CR4TK3s2",
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch address

Fetch address record

path Parameters
address_id
required
string
Examples: H4Z2WajQTJBW5aqQ

Address ID

Responses

Response samples

Content type
application/json
{
  • "id": "O9NGaN38CR4TK3s2",
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update address

Update address record

path Parameters
address_id
required
string
Examples: H4Z2WajQTJBW5aqQ

Address ID

Request Body schema: application/json
eid
string

External ID

street
required
string

Street name/number

street2
string or null

Floor, apt, etc.

city
required
string

City

postcode
required
string

Postcode (Zip)

state
required
string

State

country_code
required
string
Default: "us"

ISO 3166-1 Country Code

Responses

Request samples

Content type
application/json
{
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us"
}

Response samples

Content type
application/json
{
  • "id": "O9NGaN38CR4TK3s2",
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete address

Delete address record

path Parameters
address_id
required
string
Examples: H4Z2WajQTJBW5aqQ

Address ID

Responses

Fetch address by EID

Fetch address record by EID

path Parameters
address_eid
required
string

Address External ID

Responses

Response samples

Content type
application/json
{
  • "id": "O9NGaN38CR4TK3s2",
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update address by EID

Update address record by EID

path Parameters
address_eid
required
string

Address External ID

Request Body schema: application/json
eid
string

External ID

street
required
string

Street name/number

street2
string or null

Floor, apt, etc.

city
required
string

City

postcode
required
string

Postcode (Zip)

state
required
string

State

country_code
required
string
Default: "us"

ISO 3166-1 Country Code

Responses

Request samples

Content type
application/json
{
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us"
}

Response samples

Content type
application/json
{
  • "id": "O9NGaN38CR4TK3s2",
  • "eid": "72cf943c-cccc-55gg-0528-de5050d9473d",
  • "street": "Mulholland Drive 1",
  • "street2": "string",
  • "city": "Los Angeles",
  • "postcode": "90068",
  • "state": "ca",
  • "country_code": "us",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete address by EID

Delete address record by EID

path Parameters
address_eid
required
string

Address External ID

Responses

Card

Card endpoints

List patient cards

List patient cards

path Parameters
patient_id
required
string

Patient id

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create patient card

Create patient card record

path Parameters
patient_id
required
string

Patient id

Request Body schema: application/json
token
required
string

Card token

Responses

Request samples

Content type
application/json
{
  • "token": "3LfiTGqiG6mUXQP8"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "card_type": "string",
  • "last4": "string",
  • "phone": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch card

Fetch card

path Parameters
card_id
required
string

Card id

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "card_type": "string",
  • "last4": "string",
  • "phone": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete card

Delete card

path Parameters
card_id
required
string

Card id

Responses

Checkout Session

Checkout Session endpoints

Create checkout session

Create Checkout Session

Request Body schema: application/json
success_url
required
string <uri>
cancel_url
required
string <uri>
eid
string
required
object
required
Array of objects

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "id": "sXJtLlP83G5fOia3",
  • "eid": "62cf833c-cccc-55gg-9528-de5959d9472d",
  • "status": "paid",
  • "checkout_url": "https://healnowpayments.com/s/sXJtLlP83G5fOia3",
  • "success_url": "https://healnow.io/success",
  • "cancel_url": "https://healnow.io/cancel",
  • "total_in_cents": 0,
  • "totals": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "patient": {
    },
  • "order": {
    }
}

Fetch checkout session

Fetch checkout session record

path Parameters
session_id
required
string

Session ID

Responses

Response samples

Content type
application/json
{
  • "id": "sXJtLlP83G5fOia3",
  • "eid": "62cf833c-cccc-55gg-9528-de5959d9472d",
  • "status": "paid",
  • "checkout_url": "https://healnowpayments.com/s/sXJtLlP83G5fOia3",
  • "success_url": "https://healnow.io/success",
  • "cancel_url": "https://healnow.io/cancel",
  • "total_in_cents": 0,
  • "totals": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "patient": {
    },
  • "order": {
    }
}

Expire checkout session

Expire checkout session

path Parameters
session_id
required
string

Session ID

Responses

Response samples

Content type
application/json
{
  • "error": "Session is not opened"
}

Fee

Fee endpoints

List patient fees

List patient fees

path Parameters
patient_id
required
string

Patient ID

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

status
string

Filter records by status

name
string

Filter records by name

from
string <date>
Examples: from=2023-12-31

Filter records by created at date time

to
string <date>
Examples: to=2023-12-31

Filter records by created at date time

updated_at[from]
string <date>
Examples: updated_at[from]=2023-12-31

Filter records by updated at date time

updated_at[to]
string <date>
Examples: updated_at[to]=2023-12-31

Filter records by updated at date time

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create patient fee

Create patient fee record

path Parameters
patient_id
required
string

Patient ID

Request Body schema: application/json
name
required
string
price_in_cents
required
integer
eid
string

Responses

Request samples

Content type
application/json
{
  • "name": "Some fee",
  • "price_in_cents": 699
}

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": null,
  • "name": "Some fee",
  • "price_in_cents": 699,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch fee

Fetch fee record

path Parameters
fee_id
required
string

Fee ID

Responses

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": null,
  • "name": "Some fee",
  • "price_in_cents": 699,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update fee

Update fee record

path Parameters
fee_id
required
string

Fee ID

Request Body schema: application/json
name
required
string
price_in_cents
required
integer
eid
string

Responses

Request samples

Content type
application/json
{
  • "name": "Some fee",
  • "price_in_cents": 699
}

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": null,
  • "name": "Some fee",
  • "price_in_cents": 699,
  • "status": "pending",
  • "created_at": "2019-08-24T14:15:22Z"
}

Cancel fee

Cancel fee record

path Parameters
fee_id
required
string

Fee ID

Responses

Response samples

Content type
application/json
{
  • "error": "Only pending fee can be canceled"
}

Order

Order endpoints

List orders

List order records

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

archived
boolean

Filter records by archived state

status
string

Filter records by status

ref
string

Filter records by ref

description
string

Filter records by description

from
string <date>
Examples: from=2023-12-31

Filter records by created at date time

to
string <date>
Examples: to=2023-12-31

Filter records by created at date time

updated_at[from]
string <date>
Examples: updated_at[from]=2023-12-31

Filter records by updated at date time

updated_at[to]
string <date>
Examples: updated_at[to]=2023-12-31

Filter records by updated at date time

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_pate": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create order

Create new order

Request Body schema: application/json
description
string

Additional order info

object

Additional key-value order data. Specify up to 50 keys, with key names up to 40 characters long and values up to 255 characters long for strings.

required
object
required
Array of objects non-empty

Order should have at least one item to be valid

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "patient": {
    },
  • "card": {
    },
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "vk1AJK1exCI5QxBX",
  • "ref": "000005",
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "New patient order",
  • "archived": false,
  • "status": "paid",
  • "total_in_cents": 0,
  • "totals": {
    },
  • "signature": "URL to .png",
  • "answers": [
    ],
  • "meta": { },
  • "patient": {
    },
  • "payment": {
    },
  • "shipment": {
    },
  • "address": {
    },
  • "items": [
    ],
  • "source": {
    }
}

Fetch order

Fetch order record

path Parameters
order_id
required
string
Examples: UdAdI0Wm6cG1oVUG

Order ID

Responses

Response samples

Content type
application/json
{
  • "id": "vk1AJK1exCI5QxBX",
  • "ref": "000005",
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "New patient order",
  • "archived": false,
  • "status": "paid",
  • "total_in_cents": 0,
  • "totals": {
    },
  • "signature": "URL to .png",
  • "answers": [
    ],
  • "meta": { },
  • "patient": {
    },
  • "payment": {
    },
  • "shipment": {
    },
  • "address": {
    },
  • "items": [
    ],
  • "source": {
    }
}

Fetch order receipt

Fetch order receipt pdf

path Parameters
order_id
required
string
Examples: UdAdI0Wm6cG1oVUG

Order ID

Responses

List patient orders

List patient order records

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_pate": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Fetch order signature

Fetch order signature image

path Parameters
order_id
required
string

Responses

Patient

Patient endpoints

List patients

List patient records

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

eid
string

Filter records by eid

first_name
string

Filter records by first name

last_name
string

Filter records by last name

cart_state
string
Enum: "open" "empty" "abandoned" "error"
Examples: cart_state=open

Filter records by cart state

dob
string <date>
Examples: dob=2023-12-31

Filter records by date of birth

from
string <date>
Examples: from=2023-12-31

Filter records by created at date time

to
string <date>
Examples: to=2023-12-31

Filter records by created at date time

updated_at[from]
string <date>
Examples: updated_at[from]=2023-12-31

Filter records by updated at date time

updated_at[to]
string <date>
Examples: updated_at[to]=2023-12-31

Filter records by updated at date time

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create patient

Create patient record

Request Body schema: application/json
eid
string

External ID

first_name
string

First Name

last_name
string

Last Name

dob
string

Date of Birth

phone
string

Phone Number

email
string

Email Address

Array of objects (PrescriptionCreate)
Array of objects (AddressCreate)

Responses

Request samples

Content type
application/json
{
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "prescriptions": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "mHlcouikWQp9JCy2",
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "animal": false,
  • "checkout_url": "https://healnowpayments.com/mHlcouikWQp9JCy2",
  • "cart_state": "open",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch patient

Fetch patient record

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

Responses

Response samples

Content type
application/json
{
  • "id": "mHlcouikWQp9JCy2",
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "animal": false,
  • "checkout_url": "https://healnowpayments.com/mHlcouikWQp9JCy2",
  • "cart_state": "open",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update patient

Update patient record

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

Request Body schema: application/json
eid
string

External ID

first_name
string

First Name

last_name
string

Last Name

dob
string

Date of Birth

phone
string

Phone Number

email
string

Email Address

Responses

Request samples

Content type
application/json
{
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io"
}

Response samples

Content type
application/json
{
  • "id": "mHlcouikWQp9JCy2",
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "animal": false,
  • "checkout_url": "https://healnowpayments.com/mHlcouikWQp9JCy2",
  • "cart_state": "open",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch patient by EID

Fetch patient record by EID

path Parameters
patient_eid
required
string

Patient External ID

Responses

Response samples

Content type
application/json
{
  • "id": "mHlcouikWQp9JCy2",
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "animal": false,
  • "checkout_url": "https://healnowpayments.com/mHlcouikWQp9JCy2",
  • "cart_state": "open",
  • "created_at": "2019-08-24T14:15:22Z"
}

Update patient by EID

Update patient record by EID

path Parameters
patient_eid
required
string

Patient External ID

Request Body schema: application/json
eid
string

External ID

first_name
string

First Name

last_name
string

Last Name

dob
string

Date of Birth

phone
string

Phone Number

email
string

Email Address

Responses

Request samples

Content type
application/json
{
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io"
}

Response samples

Content type
application/json
{
  • "id": "mHlcouikWQp9JCy2",
  • "eid": "62bf832b-bbbd-44ff-9417-cd4949c8362c",
  • "first_name": "Jane",
  • "last_name": "Doe",
  • "dob": "string",
  • "phone": "+1111111111",
  • "email": "jane@healnow.io",
  • "animal": false,
  • "checkout_url": "https://healnowpayments.com/mHlcouikWQp9JCy2",
  • "cart_state": "open",
  • "created_at": "2019-08-24T14:15:22Z"
}

Fetch patient cart

Fetch patient cart record

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

Responses

Response samples

Content type
application/json
{
  • "total_in_cents": 0,
  • "totals": {
    },
  • "prescriptions": [
    ],
  • "patient": {
    }
}

Prescription

Prescription endpoints

List patient prescriptions

List patient prescription records

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

status
string

Filter records by status

eid
string

Filter records by eid

rx_number
string

Filter records by RX number

name
string

Filter records by name

from
string <date>
Examples: from=2023-12-31

Filter records by created at date time

to
string <date>
Examples: to=2023-12-31

Filter records by created at date time

updated_at[from]
string <date>
Examples: updated_at[from]=2023-12-31

Filter records by updated at date time

updated_at[to]
string <date>
Examples: updated_at[to]=2023-12-31

Filter records by updated at date time

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_pate": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create patient prescription

Create patient prescription record

path Parameters
patient_id
required
string
Examples: dhOK9luFA6t7Wg5I

Patient ID

Request Body schema: application/json
eid
string
name
required
string
rx_number
required
string
refill_number
string
price_in_cents
required
integer
provider
string
qty
required
integer
days_supply
integer
is_refill
boolean
Default: false
drug_strength
string
ndc
string
filled_at
string
upc
string
drug_schedule
integer
refills_count
integer

Responses

Request samples

Content type
application/json
{
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": "string",
  • "price_in_cents": 1299,
  • "provider": "Dr Jones",
  • "qty": 30,
  • "days_supply": 30,
  • "is_refill": false,
  • "drug_strength": "250 mg",
  • "ndc": "0777-3105-02",
  • "filled_at": "2024-12-10",
  • "upc": "30093314505",
  • "drug_schedule": "4",
  • "refills_count": "2"
}

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": null,
  • "price_in_cents": 1299,
  • "status": "pending",
  • "provider": "Dr Jones",
  • "days_supply": 30,
  • "qty": 30,
  • "is_refill": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "ndc": "string",
  • "filled_at": "YYYY-mm-DD",
  • "upc": "string",
  • "drug_schedule": 4,
  • "refills_count": 2,
  • "drug_strength": "string"
}

Fetch prescription

Fetch prescription record

path Parameters
prescription_id
required
string

Prescription ID

Responses

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": null,
  • "price_in_cents": 1299,
  • "status": "pending",
  • "provider": "Dr Jones",
  • "days_supply": 30,
  • "qty": 30,
  • "is_refill": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "ndc": "string",
  • "filled_at": "YYYY-mm-DD",
  • "upc": "string",
  • "drug_schedule": 4,
  • "refills_count": 2,
  • "drug_strength": "string"
}

Update prescription

Update prescription record

path Parameters
prescription_id
required
string

Prescription ID

Request Body schema: application/json
eid
string
name
required
string
rx_number
required
string
refill_number
string
price_in_cents
required
integer
provider
string
qty
required
integer
days_supply
integer
is_refill
boolean
Default: false
drug_strength
string
ndc
string
filled_at
string
upc
string
drug_schedule
integer
refills_count
integer

Responses

Request samples

Content type
application/json
{
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": "string",
  • "price_in_cents": 1299,
  • "provider": "Dr Jones",
  • "qty": 30,
  • "days_supply": 30,
  • "is_refill": false,
  • "drug_strength": "250 mg",
  • "ndc": "0777-3105-02",
  • "filled_at": "2024-12-10",
  • "upc": "30093314505",
  • "drug_schedule": "4",
  • "refills_count": "2"
}

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": null,
  • "price_in_cents": 1299,
  • "status": "pending",
  • "provider": "Dr Jones",
  • "days_supply": 30,
  • "qty": 30,
  • "is_refill": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "ndc": "string",
  • "filled_at": "YYYY-mm-DD",
  • "upc": "string",
  • "drug_schedule": 4,
  • "refills_count": 2,
  • "drug_strength": "string"
}

Cancel prescription

Cancel prescription record

path Parameters
prescription_id
required
string

Prescription ID

Responses

Fetch prescription by EID

Fetch prescription record by EID

path Parameters
prescription_eid
required
string

Prescription External ID

Responses

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": null,
  • "price_in_cents": 1299,
  • "status": "pending",
  • "provider": "Dr Jones",
  • "days_supply": 30,
  • "qty": 30,
  • "is_refill": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "ndc": "string",
  • "filled_at": "YYYY-mm-DD",
  • "upc": "string",
  • "drug_schedule": 4,
  • "refills_count": 2,
  • "drug_strength": "string"
}

Update prescription by EID

Update prescription record by EID

path Parameters
prescription_eid
required
string

Prescription External ID

Request Body schema: application/json
eid
string
name
required
string
rx_number
required
string
refill_number
string
price_in_cents
required
integer
provider
string
qty
required
integer
days_supply
integer
is_refill
boolean
Default: false
drug_strength
string
ndc
string
filled_at
string
upc
string
drug_schedule
integer
refills_count
integer

Responses

Request samples

Content type
application/json
{
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": "string",
  • "price_in_cents": 1299,
  • "provider": "Dr Jones",
  • "qty": 30,
  • "days_supply": 30,
  • "is_refill": false,
  • "drug_strength": "250 mg",
  • "ndc": "0777-3105-02",
  • "filled_at": "2024-12-10",
  • "upc": "30093314505",
  • "drug_schedule": "4",
  • "refills_count": "2"
}

Response samples

Content type
application/json
{
  • "id": "BWCTLvfzTklvXmCu",
  • "eid": "35db90c0-97b7-4563-a18f-a364aeec95d9",
  • "name": "Carisoprodol 350 Mg Tablet",
  • "rx_number": "120143",
  • "refill_number": null,
  • "price_in_cents": 1299,
  • "status": "pending",
  • "provider": "Dr Jones",
  • "days_supply": 30,
  • "qty": 30,
  • "is_refill": false,
  • "created_at": "2019-08-24T14:15:22Z",
  • "ndc": "string",
  • "filled_at": "YYYY-mm-DD",
  • "upc": "string",
  • "drug_schedule": 4,
  • "refills_count": 2,
  • "drug_strength": "string"
}

Cancel prescription by EID

Cancel prescription record by EID

path Parameters
prescription_eid
required
string

Prescription External ID

Responses

Refund

Refund endpoints

List order refunds

List order refund records

path Parameters
order_id
required
string

Order ID

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Create order refund

Create order refund record

path Parameters
order_id
required
string

Order ID

Request Body schema: application/json
amount_in_cents
required
integer
reason
string

Responses

Request samples

Content type
application/json
{
  • "amount_in_cents": 999,
  • "reason": "Some refund reason"
}

Response samples

Content type
application/json
{
  • "id": "L1eDQhOWNRFfNG9y",
  • "amount_in_cents": 999,
  • "reason": "Some refund reason",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": {
    }
}

List refunds

List refund records

query Parameters
page
integer
Examples: page=2

Current pagination page

per_page
integer [ 1 .. 100 ]
Default: 20
Examples: per_page=20

Pagination page size

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "per_page": 0,
  • "total_pages": 0,
  • "data": [
    ]
}

Fetch refund

Fetch refund record

path Parameters
refund_id
required
string

Refund ID

Responses

Response samples

Content type
application/json
{
  • "id": "L1eDQhOWNRFfNG9y",
  • "amount_in_cents": 999,
  • "reason": "Some refund reason",
  • "created_at": "2019-08-24T14:15:22Z",
  • "order": {
    }
}

Fetch refund receipt

Fetch refund receipt pdf

path Parameters
refund_id
required
string

Refund ID

Responses