{"info":{"_postman_id":"d224ca56-f66a-4161-a271-c79a6466aa36","name":"3rd Party","description":"

Overview

\n

The 3rd Party API collection is organized around REST architecture style. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

\n

Version

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
VersionRelease NotesDate
1.0Initial Release12/30/2020
\n

Authentication

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
Auth tokenUUIDToken provided by iLocal Box
X-api-keyUUIDSecret Key required for authentication
\n

Authentication will be token based.

\n

Errors

\n

iLocalbox uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Stripe's servers (these are rare).

\n

Some 4xx errors that could be handled programmatically (e.g., a request is declined) include an error code that briefly explains the error reported.

\n

HTTP STATUS CODE SUMMARY

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP Status CodeStatus MessageDescription
200OKEverything worked as expected.
400Bad RequestThe request was unacceptable, often due to missing a required parameter.
401UnauthorizedNo valid API key provided.
402Request FailedThe parameters were valid but the request failed.
403ForbiddenThe API key doesn't have permissions to perform the request.
404Not FoundThe requested resource doesn't exist.
409ConflictThe request conflicts with another request.
429Too Many RequestsToo many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504Server ErrorsSomething went wrong.
\n

Field Definitions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
Client IdentifierUUIDIdentifies the account expecting the order
Vendor IdentfierUUIDIdentifies the provider of the data
Order idNumberVendor order number associated with the order
Order Time StampDate / TimeDate the order was received
Store NCPDPIdNumberThe NCPDPId associated with the account
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3635870","collectionId":"d224ca56-f66a-4161-a271-c79a6466aa36","publishedId":"TVzLnzQa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"155E67","highlight":"4BA686"},"publishDate":"2021-01-05T05:11:45.000Z"},"item":[{"name":"Create Order","id":"812d4f52-9d7d-48d6-afb5-d3e1bcad0aee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"authToken","value":"{token}","type":"text"},{"key":"x-api-key","value":"{X-API key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_identifier\": \"453f39de-d5cb-4b2f-9747-f2149d171d0f\",\n \"vendor_identifier\": \"bf62aa9b-5e8e-4a55-a309-a43475b54a0d\",\n \"order_id\": \"30011\",\n \"order_timestamp\": \"2020-12-21 16:40:00.416+00\",\n \"store_ncpdp\": \"Store123\",\n \"patient\": {\n \"patient_id\": \"230023\",\n \"first_name\": \"Michael\",\n \"last_name\": \"Jordan\",\n \"gender\": \"male\",\n \"dob\": \"11/11/2011\",\n \"email\": \"email@email.com\"\n \"sms_phone\": \"8009947351\"\n \"address_line_1\": \"123 Main\",\n \"address_line_2\": \"\",\n \"city\": \"Palo ALto\",\n \"state\": \"CA\",\n \"zip\": \"60610\"\n },\n \"family_care_patients\": [\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"order_details\": [\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX230041\",\n \"name\": \"Tylenol 2mg\",\n \"ndc\": \"123-4567\",\n \"prescription_txn_id\": \"90800\",\n \"fill_number\": \"001\",\n \"prescription_id\": \"RXID-230014\",\n \"amount_due\": \"100.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300024\",\n \"name\": \"Lipitor 10mg\",\n \"ndc\": \"5644-789\",\n \"prescription_txn_id\": \"90900\",\n \"fill_number\": \"002\",\n \"prescription_id\": \"RXID-230042\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300803\",\n \"name\": \"Amoxicillan 2ml\",\n \"ndc\": \"568-9874\",\n \"prescription_txn_id\": \"10101\",\n \"fill_number\": \"003\",\n \"prescription_id\": \"RXID-230083\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stageapi.localbox.net/orders","description":"

The \"create order\" API is designed to enable authenticated 3rd Party providers with a simple way to provide patient and prescription information to be used in the delivery process or kiosk pick up.

\n","urlObject":{"protocol":"https","path":["orders"],"host":["stageapi","localbox","net"],"query":[],"variable":[]}},"response":[{"id":"2b20f0db-6831-41cd-b04e-f175b43b097f","name":"Create order-Error","originalRequest":{"method":"POST","header":[{"key":"authToken","value":"{auth token}","type":"text"},{"key":"x-api-key","value":"{x api key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_identifier\": \"71ef3sds9de-d5cb-4b2f-9747-f2149d171d0f\",\n \"vendor_identifier\": \"bf62aa9b-5e8e-4a55-a309-a43475b54a0d\",\n \"order_id\": \"30011\",\n \"order_timestamp\": \"2020-12-21 16:40:00.416+00\",\n \"store_ncpdp\": \"Store123\",\n \"patient\": {\n \"patient_id\": \"230023\",\n \"first_name\": \"Michael\",\n \"last_name\": \"Jordan\",\n \"gender\": \"male\",\n \"dob\": \"11/11/2011\",\n \"email\": \"email@email.com\",\n \"sms_phone\": \"8009947351\",\n \"address_line_1\": \"123 Main\",\n \"address_line_2\": \"\",\n \"city\": \"Palo ALto\",\n \"state\": \"CA\",\n \"zip\": \"60610\"\n },\n \"family_care_patients\": [\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"order_details\": [\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX230041\",\n \"name\": \"Tylenol 2mg\",\n \"ndc\": \"123-4567\",\n \"prescription_txn_id\": \"90800\",\n \"fill_number\": \"001\",\n \"prescription_id\": \"RXID-230014\",\n \"amount_due\": \"100.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300024\",\n \"name\": \"Lipitor 10mg\",\n \"ndc\": \"5644-789\",\n \"prescription_txn_id\": \"90900\",\n \"fill_number\": \"002\",\n \"prescription_id\": \"RXID-230042\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300803\",\n \"name\": \"Amoxicillan 2ml\",\n \"ndc\": \"568-9874\",\n \"prescription_txn_id\": \"10101\",\n \"fill_number\": \"003\",\n \"prescription_id\": \"RXID-230083\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stageapi.localbox.net/orders"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"ErrorCode\": 409,\n \"ErrorMessage\": \"prescription_txn_id 90800 is already exists.\"\n },\n {\n \"ErrorCode\": 409,\n \"ErrorMessage\": \"prescription_txn_id 90900 is already exists.\"\n },\n {\n \"ErrorCode\": 409,\n \"ErrorMessage\": \"prescription_txn_id 10101 is already exists.\"\n }\n ]\n}"},{"id":"b6b2c0ce-78da-44de-ba60-fca158b81e8b","name":"Create Order-Success","originalRequest":{"method":"POST","header":[{"key":"authToken","value":"{Auth Token)","type":"text"},{"key":"x-api-key","value":"{x-api key}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_identifier\": \"17sde-d5cb-4b2f-9747-f2149d171d0f\",\n \"vendor_identifier\": \"bf62aa9b-5e8e-4a55-a309-a43475b54a0d\",\n \"order_id\": \"30011\",\n \"order_timestamp\": \"2020-12-21 16:40:00.416+00\",\n \"store_ncpdp\": \"Store123\",\n \"patient\": {\n \"patient_id\": \"230023\",\n \"first_name\": \"Michael\",\n \"last_name\": \"Jordan\",\n \"gender\": \"male\",\n \"dob\": \"11/11/2011\",\n \"email\": \"email@email.com\",\n \"sms_phone\": \"8009947351\",\n \"address_line_1\": \"123 Main\",\n \"address_line_2\": \"\",\n \"city\": \"Palo ALto\",\n \"state\": \"CA\",\n \"zip\": \"60610\"\n },\n \"family_care_patients\": [\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n },\n {\n \"patient_id\": \"\",\n \"dob\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n ],\n \"order_details\": [\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX230041\",\n \"name\": \"Tylenol 2mg\",\n \"ndc\": \"123-4567\",\n \"prescription_txn_id\": \"90800\",\n \"fill_number\": \"001\",\n \"prescription_id\": \"RXID-230014\",\n \"amount_due\": \"100.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300024\",\n \"name\": \"Lipitor 10mg\",\n \"ndc\": \"5644-789\",\n \"prescription_txn_id\": \"90900\",\n \"fill_number\": \"002\",\n \"prescription_id\": \"RXID-230042\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n },\n {\n \"patient_id\": \"230023\",\n \"rx_num\": \"RX2300803\",\n \"name\": \"Amoxicillan 2ml\",\n \"ndc\": \"568-9874\",\n \"prescription_txn_id\": \"10101\",\n \"fill_number\": \"003\",\n \"prescription_id\": \"RXID-230083\",\n \"amount_due\": \"15.00\",\n \"dispensed_qty\": \"10\",\n \"expiry_date\": \"2022-11-11\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://stageapi.localbox.net/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"client_identifier\": \"71ef39de-d5cb-4b2f-9747-f2149d171d0f\",\n \"vendor_identifier\": \"bf62aa9b-5e8e-4a55-a309-a43475b54a0d\",\n \"status\": \"ordered\",\n \"order_id\": \"30011\",\n \"overall_order_status\": \"\",\n \"vendor_order_id\": \"30011\",\n \"order_timestamp\": \"2020-12-21 16:40:00.416+00\"\n}"}],"_postman_id":"812d4f52-9d7d-48d6-afb5-d3e1bcad0aee"}]}