Packetek By AGAPE
by packetekdev

Packetek By AGAPE

Same day package and prescription delivery
Get an API Key

Sign in to your Packetek Pharmacy Account here https://sandbox.packetek.nyc.
enter these credentials

username: pharmacy@bestrx.com
password: bestrx12345

click menu on top right menu, click corporate Information
Generate Keys if not created already
Copy the App key
To use the API key in a request header, specify the key in the X-API-KEY parameter in the request header.

Authenticate
GET /api/bestrx/v1/authenticate

Request headers

X-API-KEY
string optional

Authentication Appkey generated from Pharmacy Login

Example:
************************************
X-PROVIDER-KEY
string optional

Authentication key for integration provider issued by Packetek

Example:
994ba545ba9b619460899bfd0a28edb589acabd44136dd48887acccc7edc5a20

Responses

200 OK
Body
Object
Code
string

Http Status Code

Example:
200
ErrorCode
string

Http Status Code description

Example:
Bad Request
Details
Object

Indicates the response Payload

default_location_id
string

This can be used in createOrder API to Identify the default pickup address for Pharmacy

Example:
88
name
string

Name of Pharmacy

Example:
New York City Pharmacy
contact_name
string

Name of contact person in the Pharmacy

Example:
Pharmacy Contact Person Name
address
Object
address_line_1
string

Complete Address of Pharmacy Pickup Location

Example:
Butterfield Rd Suite 200S Oak Brook IL 60523 60523
address_line_2
string

Street Address Line 2 of the pharmacy.

city
string

City of the pharmacy.

state
string

State of the pharmacy.

zip_code
string

Zipcode of the pharmacy.

longitude
string

Map coordinates of the pharmacy.

latitude
string

Map coordinates of the pharmacy.

is_default_location
string

Confirmation bit for default address

Msg
string

Customized description

Status
string

Indicates request validity

show more
Create Order
POST /api/bestrx/v1/Order/CreateOrder

Request headers

X-API-KEY
string optional

Authentication Appkey generated from Pharmacy Login

Example:
************************************
X-PROVIDER-KEY
string optional

Authentication key for integration provider issued by Packetek

Example:
994ba545ba9b619460899bfd0a28edb589acabd44136dd48887acccc7edc5a20

Request body

Object
bestrx_order_id
integer required

The Order ID generated within the BestRx system for the delivery order.

Example:
123456789
pickup_date
string required

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

Example:
2020-05-31
requested_delivery_date
string required

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

Example:
2020-06-02
service_level
string required

The service level that describes the order. Suppored values are …

Examples:
normaltoday_rushnext_dayfuture_day
prescription_amount
number required

The sum of the cost of all prescription items in the order.

Example:
20.5
otc_amount
number required

The sum of the cost of all OTC or non-prescription items in the order.

Example:
30.5
tax_amount
number required

The total tax amount for the order.

Example:
10.5
total_amount
number required

The total dollar amount for this order. This should be equal to (prescription_amount + otc_amount + tax_amount).

Example:
70.5
amount_to_collect
number required

The amount to collect 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:
70.5
declared_amount
number required

The dollar amount that is being declared for insurance purposes.

Example:
50
height
string required

The height of the package.

Example:
2 in
width
string required

The width of the package.

Example:
2 in
length
string required

The length of the package.

Example:
3 in
weight
string required

The weight of the package.

Example:
8 oz
refrigeration_needed
boolean required

Indicates if this order contains items that need to be refrigerated.

Example:
false
signature_required
boolean required

Indicates if the recipient’s signature is required at the time of delivery.

Example:
true
photo_id_required
boolean required

Indicates if the recipient’s Photo ID needs to be checked at the time of delivery.

Example:
false
delivery_notes
string nullable

Enter any delivery notes here that would help the courier or delivery person properly delivery the order. This will be also used for verification of DOB at the time of delivery. formate supported

Example:
[2023-12-28] :note text:Please leave on back porch if no one is home.
store
Object

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

Account number that the BestRx client has with the delivery/shipping provider. this can be same as X-APP-KEY

Example:
*******************
name
string required

The name of the pharmacy.

Example:
BestRx Pharmacy
address
Object

Object with address details.

address_line_1
string required

Street Address Line 1 of the pharmacy.

Example:
361 E Gun Hill Rd, Bronx
address_line_2
string nullable

Street Address Line 2 of the pharmacy.

Example:
Suite 200S
city
string required

City of the pharmacy.

Example:
New York City
state
string required

State of the pharmacy.

Example:
New York
zip_code
string

Zip Code of the pharmacy.

phone
string required

Phone number of the pharmacy.

Example:
7186632000
fax
string required

Fax number of the pharmacy.

Example:
7186632000
email
string required

Email address of the pharmacy.

Example:
pharmacy@bestrx.com
ncpdp
number required

NCPDP number of the pharmacy.

Example:
1234567
npi
string required

NPI number of the pharmacy.

Example:
1234567890
dea
string required

DEA number of the pharmacy.

Example:
BR1234563
recipient
Object

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 required

Middle name of the recipient.

Example:
Joplin
address
Object

Object with address details.

address_line_1
string required

Street Address Line 1 of the reipient.

Example:
500 Second Ave
address_line_2
string nullable

Street Address Line 2 of the reipient.

Example:
Suite 100
city
string required

City of the reipient.

Example:
Bloomingdale
state
string required

State of the reipient.

Example:
IL
zip_code
string

Zip Code of the reipient.

home_phone
string required

Home phone number of the reipient.

Example:
6305551111
work_phone
string required

Work phone number of the reipient.

Example:
6305551111
mobile_phone
string required

Mobile/cell phone number of the reipient.

Example:
45678946785
fax
string required

Fax number of the reipient.

Example:
6305552222
email
string required

Email address of the reipient.

Example:
jane.doe@doeind.com
customers
Array

An array of objects containing info 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.

Object
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 required

Middle name of the customer.

Example:
Joplin
address
Object

Object with address details.

address_line_1
string required

Street Address Line 1 of the customer.

Example:
123 Main St
address_line_2
string nullable

Street Address Line 2 of the customer.

Example:
Suite 10
city
string required

City of the customer.

Example:
Lombard
state
string required

State of the customer.

Example:
IL
zip_code
string

Zip Code of the customer.

prescriptions
Array

An array of objects containing information about the prescriptions that are in the order.

Object
customer_unique_id
integer required

The 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

The due amount that the patient is responsible for for this prescription.

Example:
10
partial_fill_seqno
number

Partial fill sequence number (if this is a partial fill)

Example:
0
otc_items
Array

An array of objects containing info about the OTC (non-prescription) items in the order.

Object
customer_unique_id
integer required

The unique BestRx Customer ID that this item is intended for.

Example:
111111
upc
string required

The UPC/SKU of the item.

Example:
616784366630
item_description
string required

The description or name of the item.

Example:
BANDAGE ELASTIC 6IN N LTX 3666
quantity
number required

The number of units of this item in the order for this customer.

Example:
1
amount_due
number required

The total due amount of this item for the customer.

Example:
25.26
consents
Array

An array of objects containing information about the Consents that need to displayed at the time of delivery.

Object
consent_header
string required

The header or title of the consent.

Example:
Enroll in Auto-Refills?
consent_text
string required

The 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

An array containing the various options that should be displayed for this consent.

string
Examples:
yesno
consent_type
integer

A code indicating the Consent Type.

Enumeration:
0

Custom Consents

1

Auto Refill

bestrx_unique_order_id
integer

The BestRx Unique Order ID generated within the BestRx system for the delivery/shipping order.

Example:
1001
show more
Examples

Responses

200 OK

If the order is created successfully, please return a HTTP response of 200

Body
Object
data
Object
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

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.

date
string

The date/time that the status of this order was last updated.

Example:
2022-09-10T09:47:27.5232761Z
status_code
integer

The current status code of this order.

Enumeration:
1

Order Created

2

Order Acknowledged

3

Delivery/Shipment Cancelled

4

Picked Up by Courier/Carrier

5

Delivery/Shipment In Transit

6

Out For Delivery

7

Delivery/Shipment Delivered

8

Delivery Attempted

9

Unable To Deliver

10

Returned To Pharmacy/Store

status_code_description
string

The current status description of this order. This should match up with the description of the status code. This field is for informational purposes to help make troubleshooting easier when there are problems.

Example:
Order Created
status_notes
string

Any notes that would help clarify the current status of the order.

Example:
An example would be if there was a delivery exception, the reason for that exception could be displayed here ("recipient not home").
label_url
string

Url to download label

Example:
https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG
label_file_type
integer

Label File Types

Enumeration:
1

PNG

2

JPEG

3

GIF

4

PDF

label_image
string

Base64 encoded string

Example:
Image in base 64 encoded string
manifesto_url
string

Url to download manifesto

Example:
https://developer.bestrxconnect.com/TestDispensingConsumerapi/images/BestRxDispenseLable.PNG
manifesto_file_type
integer

Manifesto File Types

Enumeration:
1

PNG

2

JPEG

3

GIF

4

PDF

manifesto_image
string

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

Tracking URL to track order

Example:
"https://developer.bestrxconnect.com/ordes/789456123"
request_is_valid
boolean

Indicates if the request was a good/valid request.

Example:
true
messages
Array

Any additional notes needed to clarify the current status of the order.

Object
message_code
string

Message code.

Example:
TP0001
message
string

The text of the message.

Example:
Error when insert order information.
message_type
integer

Specifies the type of message.

Enumeration:
0

Information

1

Warning

2

[Error]

3

Success

-1

Unknown

show more
SUCCESS
POST .../Order/CreateOrder HTTP/1.1 

Content-Type: application/json

{
    "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"
        }
    ]
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "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": "10",
            "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": []
}
show more
Address Validation
POST /api/bestrx/v1/Address/ValidateAddress

This endpoint is used to validate a address and return a list of suggested address

Request headers

X-API-KEY
string optional

Authentication Appkey generated from Pharmacy Login

Example:
************************************
X-PROVIDER-KEY
string optional

Authentication key for integration provider issued by Packetek

Example:
994ba545ba9b619460899bfd0a28edb589acabd44136dd48887acccc7edc5a20

Request body

Object
store
Object
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

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

Example:
98989898
name
string required

The name of the pharmacy.

Example:
BestRx Pharmacy
address
Object

Object with address details.

address_line_1
string required

Street Address Line 1 of the pharmacy.

Example:
2625 Butterfield Rd
address_line_2
string nullable

Street Address Line 2 of the pharmacy.

Example:
Suite 200S
city
string required
Example:
Oak Brook
state
string required
Example:
IL
zip_code
string required
Example:
60523
phone
string required

Phone number of the pharmacy.

Example:
6308939210
fax
string required

Fax number of the pharmacy.

Example:
6303393171
email
string required

Email address of the pharmacy.

Example:
pharmacy@bestrx.com
ncpdp
string required

NCPDP number of the pharmacy.

Example:
1234567
npi
string required

NPI number of the pharmacy.

Example:
1234567890
dea
string required

DEA number of the pharmacy.

Example:
BR1234563
address_to_validate
Object

Object to validate address details.

address_line_1
string required

Street Address Line 1.

Example:
908 ATLANTIC AVE APT A APT A
address_line_2
string required nullable

Street Address Line 2.

city
string required

City

Example:
HOFFMAN ESTATES
state
string required

State

Example:
IL
zip_code
string required

Zip Code

Example:
60169
show more

Responses

200 OK
Body
Object
data
Object
suggested_address
Array

List object with suggested address

Object
address_line_1
string
Example:
908 ATLANTIC AVE APT A APT A
address_line_2
string
city
string
Example:
HOFFMAN ESTATES
state
string
Example:
IL
zip_code
string
Example:
60169
messages
Array
Object
message_code
string
Example:
DIS0001
message
string
Example:
Invalid Address
message_type
integer
Enumeration:
0

Information

1

Warning

2

[Error]

3

Success

-1

Unknown

request_is_valid
boolean
Example:
true
show more
SUCCESS
POST .../Address/ValidateAddress HTTP/1.1 

Content-Type: application/json

{
    "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"
    },
    "address_to_validate": {
        "address_line_1": "908 ATLANTIC AVE APT A APT A",
        "address_line_2": "",
        "city": "HOFFMAN ESTATES",
        "state": "IL",
        "zip_code": "60169"
    }
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "suggested_address": [
            {
                "address_line_1": "908 ATLANTIC AVE APT A APT A",
                "address_line_2": "",
                "city": "HOFFMAN ESTATES",
                "state": "IL",
                "zip_code": "60169"
            }
        ]
    },
    "messages": [],
    "request_is_valid": "true"
}
show more
Cancel Order
POST /api/bestrx/v1/Order/CancelOrder

This endpoint is used to cancel a shipment order.

Request headers

X-API-KEY
string optional

Authentication Appkey generated from Pharmacy Login

Example:
************************************
X-PROVIDER-KEY
string optional

Authentication key for integration provider issued by Packetek

Example:
994ba545ba9b619460899bfd0a28edb589acabd44136dd48887acccc7edc5a20

Request body

Object
bestrx_order_id
integer required

The Order ID generated within the BestRx system for the delivery/shipping order. This will be sent to the delivery/shipping provider when the order is created.

Example:
106
provider_order_id
string nullable

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

Example:
123456789
tracking_id
string nullable

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

Example:
12345
store
Object

Object with details about the pharmacy cancelling the order.

bestrx_pharmacy_id
string required

Unique GUID representing the Pharmacy ID of the BestRx client. This will be sent to the delivery/shipping provider when the order is created.

Example:
ef0a4740-0be9-44f7-b89d-9e66eeba0b9a
delivery_provider_acct_no
string required

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

Example:
98989898
name
string required
Example:
BestRx Pharmacy
address
Object

Object with address details.

address_line_1
string required

Street Address Line 1 of the pharmacy.

Example:
2625 Butterfield Rd
address_line_2
string nullable

Street Address Line 2 of the pharmacy.

Example:
Suite 200S
city
string required

City of the pharmacy.

Example:
Oak Brook
state
string required

State of the pharmacy.

Example:
IL
zip_code
string required

Zip Code of the pharmacy.

Example:
60523
phone
string required

Phone number of the pharmacy.

Example:
6308939210
fax
string required

Fax number of the pharmacy.

Example:
6303393171
email
string required

Email address of the pharmacy.

Example:
pharmacy@bestrx.com
ncpdp
string required

NCPDP number of the pharmacy.

Example:
1234567
npi
string required

NPI number of the pharmacy.

Example:
1234567890
dea
string required

DEA number of the pharmacy.

Example:
BR1234563
notes
string

Notes to clarify or give context to why the order was cancelled.

Example:
Shipment Cancelled
bestrx_unique_order_id
integer required

The Unique Order ID generated within the BestRx system for the delivery/shipping order. This will be sent to the delivery/shipping provider when the order is created.

Example:
1001
show more

Responses

200 OK
Body
Object
data
Object
bestrx_order_id
integer required

Echo the bestrx_order_id that was sent in the request.

Example:
48
provider_order_id
string

Echo the provider_order_id that was sent in the request.

Example:
132456789
tracking_id
string

Echo the tracking_id that was sent in the request.

Example:
12345
status
boolean

Order status

Example:
true
status_reason
string

status reason

Example:
Success
bestrx_unique_order_id
integer required

Echo the bestrx_unique_order_id that was sent in the request.

Example:
1001
request_is_valid
boolean

Indicates if the request was a good/valid request.

Example:
true
messages
Array
Object
message_code
string

Message code.

Example:
TP0000
message
string

The text of the message.

Example:
Error when cancel order.
message_type
integer

Specifies the type of message.

Enumeration:
0

Information

1

Warning

2

[Error]

3

Success

-1

Unknown

SUCCESS
POST .../Order/CancelOrder HTTP/1.1 

Content-Type: application/json

{
    "bestrx_order_id": 106,
    "bestrx_unique_order_id":1001,
    "provider_order_id": "123456789",
    "tracking_id": "12345",
    "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"
    },
    "notes": "Shipment Cancelled"
}

HTTP/1.1 200 OK 

Content-Type: application/json

{
    "data": {
        "bestrx_order_id": 48,
        "bestrx_unique_order_id":1001,
        "provider_order_id": "132456789",
        "tracking_id": "12345",
        "status": true,
        "status_reason": "Success"
    },
    "request_is_valid": true,
    "messages": []
}
show more
X-PROVIDER-KEY
string optional

Authentication key for integration provider issued by Packetek

Example:
994ba545ba9b619460899bfd0a28edb589acabd44136dd48887acccc7edc5a20
X-API-KEY
string optional

Authentication Appkey generated from Pharmacy Login

Example:
************************************