Create Order - BestRx APIs

INFO

This endpoint is used to create an order.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/json

bestrx_order_id

integer

required

Order ID generated within the BestRx System for the Delivery/Shipping Order.

Example:

123456789

bestrx_unique_order_id

integer

required

BestRx Unique Order ID generated within the BestRx System for the Delivery/Shipping Order.

Example:

1001

pickup_date

string | null

optional

Date that the courier/carrier should pick up the order from the pharmacy.

Example:

2020-05-31

requested_delivery_date

string | null

optional

Date that the order should be delivered, if a specific delivery date was requested.

Example:

2020-06-02

service_level

string | null

optional

Service Level that Describes the Order. Supported values are ...

Example:

normal

prescription_amount

number

required

Sum of the Cost of all Prescription Items in the Order.

Example:

32.15

otc_amount

number

required

Sum of the Cost of all OTC OR Non-Prescription Items in the Order.

Example:

65.24

tax_amount

number

required

Total Tax Amount for the Order.

Example:

54.23

total_amount

number

required

Total Dollar Amount for this Order. This should be equal to (prescription_amount + otc_amount + tax_amount).

Example:

97.83

amount_to_collect

number

required

Amount to be Collected from the Patient at time of Delivery. This does not necessarily have to be equal to the total_amount field. The Patient could have already prepaid for all or part of the order, or the pharmacy could have an arrangement with the recipient to collect payment at a later time.

Example:

97.83

declared_amount

number

required

Dollar Amount that is being declared for Insurance Purposes.

Example:

height

string

required

Height of the package

Example:

2 in

width

string

required

Width of the package

Example:

2 in

length

string

required

Length of the package

Example:

3 in

weight

string

required

Weight of the package

Example:

8 oz

refrigeration_needed

boolean

required

Indicates if this order contains items that need to be Refrigerated. (Allowed Values: TRUE or FALSE)

Example:

false

signature_required

boolean

required

Indicates if the Recipient's Signature is required at the Time of Delivery. (Allowed Values: TRUE or FALSE)

Example:

true

photo_id_required

boolean

required

Indicates if the Recipient's Photo ID needs to be checked at the Time of Delivery. (Allowed Values: TRUE or FALSE)

Example:

false

delivery_notes

string | null

optional

Enter any Delivery Notes here that would help the Courier or Delivery Person properly Delivery the Order.

Example:

Please leave on back porch if no one is home.

store

object

optional

Object with details about the pharmacy creating the order.

bestrx_pharmacy_id

string

required

Unique GUID representing the Pharmacy ID of the BestRx client.

Example:

ef0a4740-0be9-44f7-b89d-9e66eeba0b9a

delivery_provider_acct_no

string

optional

Account number that the BestRx client has with the delivery/shipping provider.

Example:

98989898

name

string

required

Name of the Pharmacy

Example:

BestRx Pharmacy

address

object

optional

Object with Address Details

phone

string

required

Phone Number of the Pharmacy

Example:

6308939210

fax

string

required

Fax Number of the Pharmacy

Example:

6303393171

string

required

Email Address of the Pharmacy

Example:

pharmacy@bestrx.com

ncpdp

number

optional

NCPDP Number of the Pharmacy

Example:

1234567

npi

string

required

NPI Number of the Pharmacy

Example:

1234567890

dea

string

optional

DEA Number of the Pharmacy

Example:

BR1234563

recipient

object

optional

Object with Details about the Recipient of the Order

entity_name

string

required

Entity Name of the Recipient if it's a Business, Facility, School, or Other Type of Organization.

Example:

Doe Industries

last_name

string

required

Last name of the recipient.

Example:

Doe

first_name

string

required

First name of the recipient.

Example:

Jane

middle_name

string

optional

Middle name of the recipient.

Example:

Joplin

address

object

optional

Object with address details.

home_phone

string

required

Home phone number of the reipient.

Example:

6305551111

work_phone

string

optional

Work phone number of the reipient.

Example:

6305551111

mobile_phone

string

optional

Mobile/cell phone number of the reipient.

Example:

45678946785

fax

string

optional

Fax number of the reipient.

Example:

6305552222

string

optional

Email address of the reipient.

Example:

jane.doe@doeind.com

customers

array [object {5}]

optional

An Array of Objects containing information about the Customers in the Order. An order may contain Items for Multiple Individuals. For example if delivering items for multiple members of the same family or delivering items to an orgranization such as an LTC facility.

customer_unique_id

integer

required

Unique ID of the Customer from the BestRx system

Example:

111111

last_name

string

required

Last Name of the Customer

Example:

Doe

first_name

string

required

First Name of the Customer

Example:

Jane

middle_name

string

optional

Middle Name of the Customer

Example:

Joplin

address

object

optional

Object with Address Details

prescriptions

array [object {5}]

optional

An Array of Objects containing information about the Prescriptions that are in the Order.

customer_unique_id

integer

required

Unique BestRx Customer ID of the Customer that this Prescription is intended for.

Example:

111111

rx_number

integer

required

Prescription Number

Example:

610011

fill_date

string

required

Fill Date / Date of Service of the Prescription

Example:

2022-05-31

amount_due

number

required

Due Amount that the Patient is Responsible for for this Prescription.

Example:

partial_fill_seqno

number

optional

Partial Fill Sequence Number (if it's a Partial Fill)

Example:

otc_items

array [object {5}]

optional

An Array of Objects containing info about the OTC (Non-Prescription) Items in the Order.

customer_unique_id

integer

required

Unique BestRx Customer ID that this Item is intended for

Example:

111111

upc

string

required

UPC/SKU of the Item

Example:

616784366630

item_description

string

required

Description OR Name of the Item

Example:

BANDAGE ELASTIC 6IN N LTX 3666

quantity

number

required

Number of Units of this Item in the Order for this Customer

Example:

amount_due

number

required

Total Due Amount of this Item for the Customer

Example:

25.26

consents

array [object {4}]

optional

An Array of Objects containing information about the Consents that need to displayed at the Time of Delivery.

consent_header

string

required

Header OR Title of the Consent

Example:

Enroll in Auto-Refills?

consent_text

string

required

Detailed Description to present to the Recipient so that they can decide whether or not they would like to Accept or Decline this Specific Consent.

Example:

The prescriptions in your order are eligible for our auto-refill program. Would you like to enroll in that program so that your prescriptions can be automatically refilled without you having to contact the pharmacy?

consent_inputs

array[string]

optional

An Array containing the Various Options that should be displayed for this Consent.

consent_type

enum<integer>

optional

A Code indicating the Consent Type.

Allowed values:

Example

{
  "bestrx_order_id": 123456789,
  "bestrx_unique_order_id": 1001,
  "pickup_date": "2020-05-31",
  "requested_delivery_date": "2020-06-02",
  "service_level": "normal",
  "prescription_amount": 32.15,
  "otc_amount": 65.24,
  "tax_amount": 54.23,
  "total_amount": 97.83,
  "amount_to_collect": 97.83,
  "declared_amount": 50,
  "height": "2 in",
  "width": "2 in",
  "length": "3 in",
  "weight": "8 oz",
  "refrigeration_needed": "false",
  "signature_required": "true",
  "photo_id_required": "false",
  "delivery_notes": "Please leave on back porch if no one is home.",
  "store": {
    "bestrx_pharmacy_id": "ef0a4740-0be9-44f7-b89d-9e66eeba0b9a",
    "delivery_provider_acct_no": "98989898",
    "name": "BestRx Pharmacy",
    "address": {
      "address_line_1": "2625 Butterfield Rd",
      "address_line_2": "Suite 200S",
      "city": "Oak Brook",
      "state": "IL",
      "zip_code": "60523"
    },
    "phone": "6308939210",
    "fax": "6303393171",
    "email": "pharmacy@bestrx.com",
    "ncpdp": 1234567,
    "npi": "1234567890",
    "dea": "BR1234563"
  },
  "recipient": {
    "entity_name": "Doe Industries",
    "last_name": "Doe",
    "first_name": "Jane",
    "middle_name": "Joplin",
    "address": {
      "address_line_1": "500 Second Ave",
      "address_line_2": "Suite 100",
      "city": "Bloomingdale",
      "state": "IL",
      "zip_code": "60108"
    },
    "home_phone": "6305551111",
    "work_phone": "6305551111",
    "mobile_phone": "45678946785",
    "fax": "6305552222",
    "email": "jane.doe@doeind.com"
  },
  "customers": [
    {
      "customer_unique_id": 111111,
      "last_name": "Doe",
      "first_name": "Jane",
      "middle_name": "Joplin",
      "address": {
        "address_line_1": "123 Main St",
        "address_line_2": "Suite 10",
        "city": "Lombard",
        "state": "IL",
        "zip_code": "60523"
      }
    }
  ],
  "prescriptions": [
    {
      "customer_unique_id": 111111,
      "rx_number": 610011,
      "fill_date": "2022-05-31",
      "amount_due": 10,
      "partial_fill_seqno": 1
    }
  ],
  "otc_items": [
    {
      "customer_unique_id": 111111,
      "upc": "616784366630",
      "item_description": "BANDAGE ELASTIC 6IN N LTX 3666",
      "quantity": 1,
      "amount_due": 25.26
    }
  ],
  "consents": [
    {
      "consent_header": "Enroll in Auto-Refills?",
      "consent_text": "The prescriptions in your order are eligible for our auto-refill program. Would you like to enroll in that program so that your prescriptions can be automatically refilled without you having to contact the pharmacy?",
      "consent_inputs": [
        "no"
      ],
      "consent_type": "0"
    }
  ]
}

Responses

🟢200OK

application/json

Body

data

object

optional

bestrx_order_id

integer

required

Echo the bestrx_order_id that was sent in the request.

provider_order_id

string

required

The Order ID for this order that was generated within the delivery/shipping provider's system.

Example:

123456

tracking_id

string

required

The tracking number generated for this order within the delivery/shipping provider's system.

Example:

789456123

bestrx_pharmacy_id

string

optional

Echo the bestrx_pharmacy_id that was sent in the request.

Example:

ef0a4740-0be9-44f7-b89d-9e66eeba0b9a

order_status

object

required

An object containing details about the status of the order.

label_url

string

optional

Url to download label

Example:

https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG

label_file_type

enum<integer>

optional

Label File Types

Allowed values:

1234

label_image

string

optional

Base64 encoded string

Example:

Image in base 64 encoded string

manifesto_url

string

optional

Url to download manifesto

Example:

https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG

manifesto_file_type

enum<integer>

optional

Manifesto File Types

Allowed values:

1234

manifesto_image

string

optional

Base64 encoded string

Example:

Image in base 64 encoded string

bestrx_unique_order_id

integer

required

Echo the bestrx_unique_order_id that was sent in the request.

Example:

1001

tracking_url

string

optional

Tracking URL to track order

Example:

"https://developer.bestrxconnect.com/ordes/789456123"

request_is_valid

boolean

optional

Indicates if the request was a Good/Valid Request

Example:

true

messages

array [object {3}]

optional

Any additional notes needed to Clarify the Current status of the Order

message_code

string

optional

Message Code

Example:

TP0001

message

string

optional

Text of the Message

Example:

Error when insert order information.

message_type

enum<integer>

optional

Specifies the Type of Message

Allowed values:

0123-1

Example

{
  "data": {
    "bestrx_order_id": 123456789,
    "bestrx_unique_order_id": 1001,
    "provider_order_id": "123456",
    "tracking_id": "789456123",
    "tracking_url": "https://developer.bestrxconnect.com/ordes/789456123",
    "bestrx_pharmacy_id": "ef0a4740-0be9-44f7-b89d-9e66eeba0b9a",
    "label_url": "https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG",
    "label_image": "",
    "label_file_type": 1,
    "manifesto_url": "https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG",
    "manifesto_image": "",
    "manifesto_file_type": 1,
    "order_status": {
      "date": "2022-09-10T09:47:27.5232761Z",
      "status_code": "1",
      "status_code_description": "Order Created",
      "status_notes": "An example would be if there was a delivery exception, the reason for that exception could be displayed here (\"recipient not home\")."
    }
  },
  "request_is_valid": "true",
  "messages": []
}