Getting Started
API
- POSTArchive Banked Item
- PUTArchive Commission Report
- DELArchive Membership
- DELArchive Stock
- DELArchive Supplier
- POSTAssign Provider To Structure
- POSTBill Members
- POSTBulk Assign Providers To Structure
- DELBulk Remove Providers From Structure
- PUTCancel Sold Package
- POSTCreate Banked Item
- POSTCreate Commission Structure
- POSTCreate Item
- POSTCreate Membership
- POSTCreate Package
- POSTCreate Shipments
- POSTCreate Stock
- POSTCreate Stock From Csv
- POSTCreate Stock From Image
- POSTCreate Suppliers
- DELDelete Commission Structure
- DELDelete Item
- DELDelete Package
- DELDelete Shipment
- POSTDrawdown Stock
- POSTDuplicate Commission Structure
- POSTEnroll Member Deferred Billing
- POSTGenerate Commission Report
- GETGet Banked Item
- GETGet Banked Item Charge Items
- GETGet Commission Report
- GETGet Commission Structure
- GETGet Commissions For Provider
- GETGet Inventory Logs
- GETGet Issued Discounts
- GETGet Item Brand Names
- GETGet Member
- GETGet Member Logs
- GETGet Membership
- GETGet Package
- GETGet Package Usage
- GETGet Provider Commission Structures
- GETGet Shipment
- GETGet Sold Package Charge Items
- GETGet Stock
- GETGet Supplier
- POSTLink Stock To Item
- GETList Commission Reports
- GETList Commission Structures
- GETList Item
- GETList Membership Usage
- GETList Memberships
- GETList Packages
- GETList Patient Banked Items
- GETList Patient Packages
- GETList Providers With Commission Structures
- GETList Shipments
- GETList Stocks
- GETList Suppliers
- POSTManual Payment
- DELRemove Provider From Structure
- POSTSave Commission Report
- GETSearch Stocks
- POSTUnfreeze Members
- POSTUnlink Stock From Item
- POSTUpdate Billing Date
- PUTUpdate Commission Structure
- POSTUpdate Discount
- PUTUpdate Item
- POSTUpdate Member Sold By Provider
- PUTUpdate Membership
- PUTUpdate Package
- POSTUpdate Payment Method
- PUTUpdate Shipments
- POSTUpdate Status
- PUTUpdate Stock
- PUTUpdate Supplier
- POST
Tenant
List Suppliers
Copy
curl --request GET \
--url https://api.decodahealth.com/inventory/suppliers/list \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'Copy
{
"data": [
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
}
],
"total": 123
}Inventory
List Suppliers
GET
/
inventory
/
suppliers
/
list
List Suppliers
Copy
curl --request GET \
--url https://api.decodahealth.com/inventory/suppliers/list \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'Copy
{
"data": [
{
"name": "<string>",
"id": "<string>",
"description": "<string>",
"website": "<string>",
"email": "<string>",
"preferredContactMethod": "<string>",
"phoneNumber": "<string>",
"addressLineOne": "<string>",
"addressLineTwo": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"isArchived": false
}
],
"total": 123
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Name of the supplier
Archived status of the supplier
City of the supplier
State of the supplier
Number of suppliers per page
Page number to retrieve
Response
Successful Response
Show child attributes
Show child attributes
Name of the supplier
Unique identifier for the supplier
Optional description of the supplier
Optional website of the supplier
Optional email of the supplier
Optional preferred contact method
Optional phone number of the supplier
Optional first line of address
Optional second line of address
Optional city
Optional state or province
Optional ZIP or postal code
Optional country
Whether the supplier is archived
⌘I