Empire Medical API (1.0.0)

Download OpenAPI specification:Download

David Frailey: dfrailey+api@empire-medical.com

Important Notes

Accept: application/json MUST be sent with all requests.
The current data set in the testing environment is not 100% accurate, it is missing:
- Tracking Numbers
- Serial Numbers
- Logical grouping of Order Lines with Order Numbers.

Deprecations

Paths, Properties, Object Schema Properties and Schemas will be flagged as deprecated two versions prior to their removal.

Support and Requests

Please send all support and request emails to the e-mail address above with a subject that includes the title "Support" or "Request" respectively.

Authentication

OAuth2

Security Scheme Type: OAuth2

Flow type: authorizationCode

Authorization URL: /oauth/authorize

Token URL: /oauth/token

Refresh URL: /oauth/token/refresh

Scopes:

view-orders -
Read Order Lines

OAuthClientCredentials

Security Scheme Type: OAuth2

Flow type: clientCredentials

Token URL: /oauth/token

Refresh URL: /oauth/token/refresh

Scopes:

view-orders -
Read Order Lines

Order Lines

Provides operations for dealing with the current authorized users facilities order lines.

List Order Lines

Authorizations:

OAuth2

query Parameters

order_number	Array of integers <int32> [ items <int32 > ] Example: order_number=2003,2004,2005 A CSV list of order numbers to filter the result set by. Returned response will contain all Order Lines belonging to the specified Order Numbers.
manufacturer_name	Array of strings Example: manufacturer_name=Fus,Roh,Dah A CSV list of Manufacturer Names to filter the result set by. This is a prefix match.
part_number	Array of strings Example: part_number=%24D-28%2C+1C50%3DR26-5-P%2F15N A CSV list of URL encoded part numbers to filter the result set by. This is a prefix match.
job_number	Array of strings Example: job_number=200341,D203123,NV12321412 A CSV list of Job Numbers to filter the result set by. This is done with an exact match.
user_ordered_timestamp_before	string <date-time> Examples: user_ordered_timestamp_before=2019-02-01T03:45:27+0000 - user_ordered_timestamp_before=2019-07-08T20:30:21Z - user_ordered_timestamp_before=20190708T203021Z - Filters the result set by records that were Ordered before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
user_ordered_timestamp_after	string <date-time> Examples: user_ordered_timestamp_after=2019-02-01T03:45:27+0000 - user_ordered_timestamp_after=2019-07-08T20:30:21Z - user_ordered_timestamp_after=20190708T203021Z - Filters the result set by records that were Ordered after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_before	string <date-time> Examples: date_needed_before=2019-02-01T03:45:27+0000 - date_needed_before=2019-07-08T20:30:21Z - date_needed_before=20190708T203021Z - Filters the result set by records that have a Need By date before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_after	string <date-time> Examples: date_needed_after=2019-02-01T03:45:27+0000 - date_needed_after=2019-07-08T20:30:21Z - date_needed_after=20190708T203021Z - Filters the result set by records that have a Need By Date after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_before	string <date-time> Examples: date_received_before=2019-02-01T03:45:27+0000 - date_received_before=2019-07-08T20:30:21Z - date_received_before=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_after	string <date-time> Examples: date_received_after=2019-02-01T03:45:27+0000 - date_received_after=2019-07-08T20:30:21Z - date_received_after=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
is_for_stock	boolean Filters the result set by records that have been flagged as items for Stock.
rma_return_number	Array of strings CSV list of rma return numbers to search by.
vendor_confirmation_number	Array of strings CSV list of vendor confirmation numbers.
shipping_address	Array of strings CSV list of shipping addresses.
cost_center	Array of strings CSV list of cost centers.
tracking_number	Array of strings CSV list of tracking numbers.
return_tracking_numbers	Array of strings CSV list of return tracking numbers.
order_status_name	Array of strings Items Enum: "On Hold" "Ordered" "Partially Received" "Received" "Return Requested" "Returned" "Backordered" A CSV list of order status names. This is a case insensitive query parameter.
billing_status_name	Array of strings Items Enum: "Unbilled" "Billed" "Credited" A CSV list of billing status names.
since	string <date-time> Examples: since=2019-02-01T03:45:27+0000 - since=2019-07-08T20:30:21Z - since=20190708T203021Z - Filters the result set by records that been updated since the time provided by the query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
page	integer <int32> >= 1 Default: 1 Indicates the page of items the client wishes to receive when working with a paginated result set.
per_page	integer <int32> [ 1 .. 500 ] Default: 200 Indicates the number of items that should be returned to the client when working with a paginated result set. The server will automatically reduce the per_page value if the value sent by the client exceeds the maximum.

Responses

Response samples

Content type

application/json

{"data": [{"order_number": 2005,
"manufacturer_name": "Red Hat",
"quantity": 1,
"quantity_received": 0,
"price": 359,
"part_number": "RHEL",
"job_number": "NY123115",
"user_ordered_timestamp": "2019-06-13T03:45:27+0000",
"date_needed": null,
"date_expected": "2019-06-15T00:00:00+0000",
"date_received": null,
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Redhat Enterpice Linux Server License",
"rma_return_number": null,
"order_status_name": "Ordered",
"billing_status_name": "Unbilled",
"vendor_confirmation_number": null,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "Why is this so expensive?",
"customer_internal_memo": "Purchased for the blade server under the stairs.",
"serial_numbers": ["A8675B309"
],
"tracking_numbers": ["1Z000123122140"
],
"return_tracking_numbers": [ ]
},
{"order_number": 2006,
"manufacturer_name": "Slackware",
"quantity": 1,
"quantity_received": 1,
"price": 0,
"part_number": "SLCKWL",
"job_number": "NY12311412",
"user_ordered_timestmap": "2019-14T03:45:27+0000",
"date_needed": "2019-06-20T00:00:00+0000",
"date_expected": "2019-06-17T00:00:00+0000",
"date_received": "2019-06-16T04:15:00+0000",
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Slackware Linux",
"rma_return_number": null,
"order_status_name": "Received",
"billing_status_name": "Billed",
"vendor_confirmation_number": 123412314123,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "./configure --prefix=/usr/local/bin/ && make && make install",
"customer_internal_memo": null,
"serial_numbers": [ ],
"tracking_numbers": ["1Z000123122141"
],
"return_tracking_numbers": [ ]
}
],
"meta": {"current_page": 1,
"last_page": 1,
"from": 1,
"to": 2,
"total": 2,
"path": "<current path>"
}
}

Read Only - Order Lines For Order

Provides operations for retrieving order lines specific to an order without an authenticated User. The owner of the Order Lines must have enabled this feature in their Facility settings inside of the Empire Medical application.

listOrderLinesForOrder

Authorizations:

OAuthClientCredentials

path Parameters

order_id

required

integer <int32>

The unique numeric identifier of an Order.

query Parameters

manufacturer_name	Array of strings Example: manufacturer_name=Fus,Roh,Dah A CSV list of Manufacturer Names to filter the result set by. This is a prefix match.
part_number	Array of strings Example: part_number=%24D-28%2C+1C50%3DR26-5-P%2F15N A CSV list of URL encoded part numbers to filter the result set by. This is a prefix match.
job_number	Array of strings Example: job_number=200341,D203123,NV12321412 A CSV list of Job Numbers to filter the result set by. This is done with an exact match.
user_ordered_timestamp_before	string <date-time> Examples: user_ordered_timestamp_before=2019-02-01T03:45:27+0000 - user_ordered_timestamp_before=2019-07-08T20:30:21Z - user_ordered_timestamp_before=20190708T203021Z - Filters the result set by records that were Ordered before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
user_ordered_timestamp_after	string <date-time> Examples: user_ordered_timestamp_after=2019-02-01T03:45:27+0000 - user_ordered_timestamp_after=2019-07-08T20:30:21Z - user_ordered_timestamp_after=20190708T203021Z - Filters the result set by records that were Ordered after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_before	string <date-time> Examples: date_needed_before=2019-02-01T03:45:27+0000 - date_needed_before=2019-07-08T20:30:21Z - date_needed_before=20190708T203021Z - Filters the result set by records that have a Need By date before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_after	string <date-time> Examples: date_needed_after=2019-02-01T03:45:27+0000 - date_needed_after=2019-07-08T20:30:21Z - date_needed_after=20190708T203021Z - Filters the result set by records that have a Need By Date after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_before	string <date-time> Examples: date_received_before=2019-02-01T03:45:27+0000 - date_received_before=2019-07-08T20:30:21Z - date_received_before=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_after	string <date-time> Examples: date_received_after=2019-02-01T03:45:27+0000 - date_received_after=2019-07-08T20:30:21Z - date_received_after=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
is_for_stock	boolean Filters the result set by records that have been flagged as items for Stock.
rma_return_number	Array of strings CSV list of rma return numbers to search by.
vendor_confirmation_number	Array of strings CSV list of vendor confirmation numbers.
shipping_address	Array of strings CSV list of shipping addresses.
cost_center	Array of strings CSV list of cost centers.
tracking_number	Array of strings CSV list of tracking numbers.
return_tracking_numbers	Array of strings CSV list of return tracking numbers.
order_status_name	Array of strings Items Enum: "On Hold" "Ordered" "Partially Received" "Received" "Return Requested" "Returned" "Backordered" A CSV list of order status names. This is a case insensitive query parameter.
billing_status_name	Array of strings Items Enum: "Unbilled" "Billed" "Credited" A CSV list of billing status names.
page	integer <int32> >= 1 Default: 1 Indicates the page of items the client wishes to receive when working with a paginated result set.
per_page	integer <int32> [ 1 .. 500 ] Default: 200 Indicates the number of items that should be returned to the client when working with a paginated result set. The server will automatically reduce the per_page value if the value sent by the client exceeds the maximum.

Responses

Response samples

Content type

application/json

{"data": [{"order_number": 2005,
"manufacturer_name": "Red Hat",
"quantity": 1,
"quantity_received": 0,
"price": 359,
"part_number": "RHEL",
"job_number": "NY123115",
"user_ordered_timestamp": "2019-06-13T03:45:27+0000",
"date_needed": null,
"date_expected": "2019-06-15T00:00:00+0000",
"date_received": null,
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Redhat Enterpice Linux Server License",
"rma_return_number": null,
"order_status_name": "Ordered",
"billing_status_name": "Unbilled",
"vendor_confirmation_number": null,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "Why is this so expensive?",
"customer_internal_memo": "Purchased for the blade server under the stairs.",
"serial_numbers": ["A8675B309"
],
"tracking_numbers": ["1Z000123122140"
],
"return_tracking_numbers": [ ]
},
{"order_number": 2006,
"manufacturer_name": "Slackware",
"quantity": 1,
"quantity_received": 1,
"price": 0,
"part_number": "SLCKWL",
"job_number": "NY12311412",
"user_ordered_timestmap": "2019-14T03:45:27+0000",
"date_needed": "2019-06-20T00:00:00+0000",
"date_expected": "2019-06-17T00:00:00+0000",
"date_received": "2019-06-16T04:15:00+0000",
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Slackware Linux",
"rma_return_number": null,
"order_status_name": "Received",
"billing_status_name": "Billed",
"vendor_confirmation_number": 123412314123,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "./configure --prefix=/usr/local/bin/ && make && make install",
"customer_internal_memo": null,
"serial_numbers": [ ],
"tracking_numbers": ["1Z000123122141"
],
"return_tracking_numbers": [ ]
}
],
"meta": {"current_page": 1,
"last_page": 1,
"from": 1,
"to": 2,
"total": 2,
"path": "<current path>"
}
}

Read Only - Order Lines For Integration

Provides operations for retrieving order lines readable by a specific integration.

listOrderLinesForIntegration

query Parameters

order_number	Array of integers <int32> [ items <int32 > ] Example: order_number=2003,2004,2005 A CSV list of order numbers to filter the result set by. Returned response will contain all Order Lines belonging to the specified Order Numbers.
manufacturer_name	Array of strings Example: manufacturer_name=Fus,Roh,Dah A CSV list of Manufacturer Names to filter the result set by. This is a prefix match.
part_number	Array of strings Example: part_number=%24D-28%2C+1C50%3DR26-5-P%2F15N A CSV list of URL encoded part numbers to filter the result set by. This is a prefix match.
job_number	Array of strings Example: job_number=200341,D203123,NV12321412 A CSV list of Job Numbers to filter the result set by. This is done with an exact match.
user_ordered_timestamp_before	string <date-time> Examples: user_ordered_timestamp_before=2019-02-01T03:45:27+0000 - user_ordered_timestamp_before=2019-07-08T20:30:21Z - user_ordered_timestamp_before=20190708T203021Z - Filters the result set by records that were Ordered before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
user_ordered_timestamp_after	string <date-time> Examples: user_ordered_timestamp_after=2019-02-01T03:45:27+0000 - user_ordered_timestamp_after=2019-07-08T20:30:21Z - user_ordered_timestamp_after=20190708T203021Z - Filters the result set by records that were Ordered after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_before	string <date-time> Examples: date_needed_before=2019-02-01T03:45:27+0000 - date_needed_before=2019-07-08T20:30:21Z - date_needed_before=20190708T203021Z - Filters the result set by records that have a Need By date before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_needed_after	string <date-time> Examples: date_needed_after=2019-02-01T03:45:27+0000 - date_needed_after=2019-07-08T20:30:21Z - date_needed_after=20190708T203021Z - Filters the result set by records that have a Need By Date after the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_before	string <date-time> Examples: date_received_before=2019-02-01T03:45:27+0000 - date_received_before=2019-07-08T20:30:21Z - date_received_before=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
date_received_after	string <date-time> Examples: date_received_after=2019-02-01T03:45:27+0000 - date_received_after=2019-07-08T20:30:21Z - date_received_after=20190708T203021Z - Filters the result set by records that have a Date Received before the provided query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
is_for_stock	boolean Filters the result set by records that have been flagged as items for Stock.
rma_return_number	Array of strings CSV list of rma return numbers to search by.
vendor_confirmation_number	Array of strings CSV list of vendor confirmation numbers.
shipping_address	Array of strings CSV list of shipping addresses.
cost_center	Array of strings CSV list of cost centers.
tracking_number	Array of strings CSV list of tracking numbers.
return_tracking_numbers	Array of strings CSV list of return tracking numbers.
order_status_name	Array of strings Items Enum: "On Hold" "Ordered" "Partially Received" "Received" "Return Requested" "Returned" "Backordered" A CSV list of order status names. This is a case insensitive query parameter.
billing_status_name	Array of strings Items Enum: "Unbilled" "Billed" "Credited" A CSV list of billing status names.
since	string <date-time> Examples: since=2019-02-01T03:45:27+0000 - since=2019-07-08T20:30:21Z - since=20190708T203021Z - Filters the result set by records that been updated since the time provided by the query parameter. Date Time's should be formatted by the ISO8601 standard, and converted to UTC.
page	integer <int32> >= 1 Default: 1 Indicates the page of items the client wishes to receive when working with a paginated result set.
per_page	integer <int32> [ 1 .. 500 ] Default: 200 Indicates the number of items that should be returned to the client when working with a paginated result set. The server will automatically reduce the per_page value if the value sent by the client exceeds the maximum.

Responses

Response samples

Content type

application/json

{"data": [{"order_number": 2005,
"manufacturer_name": "Red Hat",
"quantity": 1,
"quantity_received": 0,
"price": 359,
"part_number": "RHEL",
"job_number": "NY123115",
"user_ordered_timestamp": "2019-06-13T03:45:27+0000",
"date_needed": null,
"date_expected": "2019-06-15T00:00:00+0000",
"date_received": null,
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Redhat Enterpice Linux Server License",
"rma_return_number": null,
"order_status_name": "Ordered",
"billing_status_name": "Unbilled",
"vendor_confirmation_number": null,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "Why is this so expensive?",
"customer_internal_memo": "Purchased for the blade server under the stairs.",
"serial_numbers": ["A8675B309"
],
"tracking_numbers": ["1Z000123122140"
],
"return_tracking_numbers": [ ]
},
{"order_number": 2006,
"manufacturer_name": "Slackware",
"quantity": 1,
"quantity_received": 1,
"price": 0,
"part_number": "SLCKWL",
"job_number": "NY12311412",
"user_ordered_timestmap": "2019-14T03:45:27+0000",
"date_needed": "2019-06-20T00:00:00+0000",
"date_expected": "2019-06-17T00:00:00+0000",
"date_received": "2019-06-16T04:15:00+0000",
"is_for_stock": false,
"return_requested_customer_timestamp": null,
"description": "Slackware Linux",
"rma_return_number": null,
"order_status_name": "Received",
"billing_status_name": "Billed",
"vendor_confirmation_number": 123412314123,
"shipping_address": "Home",
"cost_center": "Company",
"customer_note": "./configure --prefix=/usr/local/bin/ && make && make install",
"customer_internal_memo": null,
"serial_numbers": [ ],
"tracking_numbers": ["1Z000123122141"
],
"return_tracking_numbers": [ ]
}
],
"meta": {"current_page": 1,
"last_page": 1,
"from": 1,
"to": 2,
"total": 2,
"path": "<current path>"
}
}

Read Only - Inventory Redemptions

Provides operations for retrieving inventory redemption records without an authenticated User. The owner of the Inventory Redemption Records must have enabled this feature in their Facility settings inside of the Empire Medical application.

/inventory-redemptions/{prescription_id}

path Parameters

prescription_id

required

string

A Nymbl Prescription ID.

query Parameters

occurred_at_start	string <date-time> Examples: occurred_at_start=2019-02-01T03:45:27+0000 - occurred_at_start=2019-07-08T20:30:21Z - occurred_at_start=20190708T203021Z -
occurred_at_end	string <date-time> Examples: occurred_at_end=2019-02-01T03:45:27+0000 - occurred_at_end=2019-07-08T20:30:21Z - occurred_at_end=20190708T203021Z -

Responses

Response samples

Content type

application/json

{"data": [{"address_name": "string",
"inventory_location_name": "string",
"user_name": "string",
"quantity": 0,
"action": "INCREASE",
"prescription_id": "string",
"serial_numbers": "string"
}
]
}