Update Order Status - BestRx APIs

INFO

This endpoint is used to update order status. The message is sent from the delivery/shipping provider to BestRx.

Request

Header Params

Content-Type

string

optional

Example:

application/json

Body Params application/json

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

bestrx_order_id

integer

required

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:

123456789

provider_order_id

string

required

Order ID for this Order that was generated within the Delivery/Shipping Provider's System.

Example:

POI123456

tracking_id

string

required

Tracking Number generated for this Order within the Delivery/Shipping Provider's System.

Example:

15646323

order_status

object

optional

An object containing details about the Status of the Order.

date

string

required

Date/Time that the status of this Order was Last Updated.

Example:

2022-09-10T09:47:27.5232761Z

status_code

enum<integer>

required

Current Status Code of this Order

Allowed values:

12345678910

status_Code_description

string

required

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 | null

optional

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").

signature

string

optional

Base64 string of the Signature Image for this Order

signature_url

string

optional

URL that can be used to Retrieve the Image, if the Signature Image for the Order is Hosted Online

signer_info

object

optional

An Object containing Information about the Recipient that Signed for the Order.

relation

enum<integer>

optional

Code to Indicate the Relationship of the Signer/Recipient to the Patient/Customer

Allowed values:

123499

Example:

first_name

string

optional

First Name of the Signer/Recipient

Example:

John

last_name

string

optional

Last Name of the Signer/Recipient

Example:

Doe

jurisdiction

string

optional

Example:

id_type

enum<integer>

optional

Code to Indicate the Type of ID that was checked at the Time of Delivery

Allowed values:

1234567899

Example:

id_no

string

optional

ID Number from the ID that was checked at the Time of Delivery

Example:

D200-3333-4444

consent_info

array [object {2}]

optional

An Array of Objects containing Information about the Consents that were asked During the Delivery.

consent_type

integer

required

A Code Indicating the Consent Type

Example:

consent_response

string

optional

Response to the Consent that was asked at the Time of Delivery

Example:

Yes

bestrx_unique_order_id

integer

optional

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

Example

{
  "bestrx_pharmacy_id": "ef0a4740-0be9-44f7-b89d-9e66eeba0b9a",
  "bestrx_order_id": 123456789,
  "bestrx_unique_order_id": 1001,
  "provider_order_id": "POI123456",
  "tracking_id": "15646323",
  "order_status": {
    "date": "2022-09-10T09:47:27.5232761Z",
    "status_code": "2",
    "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\")."
  },
  "signature": "",
  "signature_url": "",
  "signer_info": {
    "relation": "3",
    "first_name": "John",
    "last_name": "Doe",
    "jurisdiction": "IL",
    "id_type": "6",
    "id_no": "D200-3333-4444"
  },
  "consent_info": [
    {
      "consent_type": 1,
      "consent_response": "Yes"
    }
  ]
}

Responses

🟢200OK

application/json

Body

data

object

optional

status_updated

boolean

required

Indicates if the Status was Successfully Updated in the BestRx System.

Example:

true

messages

array [object {3}]

optional

An Array of Message Objects

message_code

string

optional

Message code.

Example:

TP0005

message

string

optional

The text of the message.

Example:

Status updated successfully.

message_type

enum<integer>

optional

Specifies the type of message.

Allowed values:

0123-1

Example

{
  "data": {},
  "status_updated": "true",
  "messages": [
    {
      "message_code": "TP0005",
      "message": "Status updated successfully.",
      "message_type": 0
    }
  ]
}