INFO

This endpoint is used to get the status of POS transaction from BestPOS system.

POS Transaction Status

Status	Description
Initiated	Transaction received by our service endpoint
Received	Transaction received by pharmacy
Completed	Transaction completed at pharmacy
Failed	Transaction failed while creating on pharmacy database
Deleted	Transaction canceled by pharmacy

Request

Header Params

Content-Type

string

optional

Example:

application/json; charset=utf-8

Body Params application/json

PharmacyNumber

string

required

Pharmacy NPI Number

<= 15 characters

Example:

1234567890

PosServiceTrackingIDs

array[string]

optional

Array of POS Service Tracking IDs. Tracking ID returned when transaction was created.

Startdate

string | null

optional

To get any transactions starting from specific date. (YYYY-MM-DD or ISO 8601 Format)

Examples:

2023-01-012023-01-01T23:59:59Z

Enddate

string | null

optional

To get any transactions till specific date. (YYYY-MM-DD or ISO 8601 Format)

Examples:

2023-12-312023-12-31T23:59:59Z

Status

enum<integer> | enum<null>

optional

To get any transactions with particular status.

Allowed values:

12345

Example:

Example

{
    "PharmacyNumber": "1234567890",
    "PosServiceTrackingIDs": [
        "6f817bfc-7519-485a-883f-8ba2beed262c",
        "33218ed7-e59e-4291-b04c-4ed08cb6730d"
    ],
    "Startdate": "2023-01-01T23:59:59Z",
    "Enddate": "2023-12-31T23:59:59Z",
    "Status": 1
}

Responses

🟢200OK

application/json

Body

Data

array [object {5}]

required

Array for POS tracking data

PosServiceTrackingID

string

required

Unique POS service tracking ID

TransactionDate

string <date-time>

required

Date and time when transaction occurred. ISO8601 datetime

StatusID

integer

required

Numeric value of tracking status

StatusDesc

string

required

Status description

LastStatusDate

string <date-time>

required

Last status updated date and time. ISO8601 datetime

IsValid

boolean

required

True when Successful OR False when Failed

Messages

array[string]

required

Contains messages when failed

Example

{
    "Data": [
        {
            "PosServiceTrackingID": "6f817bfc-7519-485a-883f-8ba2beed262c",
            "TransactionDate": "2023-06-22T00:00:00Z",
            "StatusID": 2,
            "StatusDesc": "Completed",
            "LastStatusDate": "2023-06-22T00:00:00Z"
        },
        {
            "PosServiceTrackingID": "33218ed7-e59e-4291-b04c-4ed08cb6730d",
            "TransactionDate": "2023-06-22T00:00:00Z",
            "StatusID": 2,
            "StatusDesc": "Completed",
            "LastStatusDate": "2023-06-22T00:00:00Z"
        }
    ],
    "IsValid": true,
    "Messages": []
}

🟢200Other Errors

Get POS Transaction Status

POS Transaction Status#

Request

Responses

POS Transaction Status