List Stocks

curl --request GET \
  --url https://api.decodahealth.com/inventory/stocks/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "name": "<string>",
      "unit": "AMPOULES",
      "id": "<string>",
      "description": "<string>",
      "notes": "<string>",
      "category": "<string>",
      "isArchived": false,
      "shipments": [
        {
          "stockId": "<string>",
          "supplierId": "<string>",
          "locationId": "<string>",
          "quantity": 123,
          "remainingQuantity": 123,
          "locationName": "<string>",
          "id": "<string>",
          "lotNumber": "<string>",
          "expiryDate": "2023-11-07T05:31:56Z",
          "sku": "<string>",
          "cost": 123,
          "supplier": {
            "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
          },
          "createdDate": "2023-11-07T05:31:56Z",
          "note": "<string>"
        }
      ],
      "items": [
        {
          "itemId": "<string>",
          "stockId": "<string>",
          "quantityUsed": 123
        }
      ],
      "locationSummaries": [
        {
          "locationId": "<string>",
          "locationName": "<string>",
          "totalQuantity": 123,
          "remainingQuantity": 123,
          "percentage": 123
        }
      ],
      "note": "<string>"
    }
  ],
  "total": 123
}

GET

inventory

stocks

list

List Stocks

curl --request GET \
  --url https://api.decodahealth.com/inventory/stocks/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "name": "<string>",
      "unit": "AMPOULES",
      "id": "<string>",
      "description": "<string>",
      "notes": "<string>",
      "category": "<string>",
      "isArchived": false,
      "shipments": [
        {
          "stockId": "<string>",
          "supplierId": "<string>",
          "locationId": "<string>",
          "quantity": 123,
          "remainingQuantity": 123,
          "locationName": "<string>",
          "id": "<string>",
          "lotNumber": "<string>",
          "expiryDate": "2023-11-07T05:31:56Z",
          "sku": "<string>",
          "cost": 123,
          "supplier": {
            "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
          },
          "createdDate": "2023-11-07T05:31:56Z",
          "note": "<string>"
        }
      ],
      "items": [
        {
          "itemId": "<string>",
          "stockId": "<string>",
          "quantityUsed": 123
        }
      ],
      "locationSummaries": [
        {
          "locationId": "<string>",
          "locationName": "<string>",
          "totalQuantity": 123,
          "remainingQuantity": 123,
          "percentage": 123
        }
      ],
      "note": "<string>"
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

Optional ID of the location to filter shipments by

name

string | null

Optional name of the stock

ids

string[] | null

Optional IDs of the stock

item_id

string | null

Optional ID of the item

Response

Successful Response

data

StockDetail · object[]

required

Show child attributes

data.name

string

required

Name of the stock

data.unit

enum<string>

required

Unit of measurement

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

data.id

string

Unique identifier for the stock

data.description

string | null

Optional description of the stock

data.notes

string | null

Notes about the stock

data.category

string | null

Category name (references category.name)

data.isArchived

boolean

default:false

Whether the stock is archived

data.shipments

Shipment · object[] | null

Shipments in the stock

Show child attributes

data.shipments.stockId

string

required

ID of the stock

data.shipments.supplierId

string

required

ID of the supplier

data.shipments.locationId

string

required

ID of the location where the shipment was delivered

data.shipments.quantity

number

required

Total quantity

data.shipments.remainingQuantity

number

required

Remaining quantity

data.shipments.locationName

string | null

required

Get the location name from the related location object

data.shipments.id

string

Unique identifier for the shipment

data.shipments.lotNumber

string | null

Optional lot number of the shipment

data.shipments.expiryDate

string<date-time> | null

Optional expiry date of the shipment

data.shipments.sku

string | null

Optional SKU (Stock Keeping Unit)

data.shipments.cost

integer | null

Cost of the shipment in cents

data.shipments.supplier

Supplier · object

Optional supplier details

Show child attributes

data.shipments.supplier.name

string

required

Name of the supplier

data.shipments.supplier.id

string

Unique identifier for the supplier

data.shipments.supplier.description

string | null

Optional description of the supplier

data.shipments.supplier.website

string | null

Optional website of the supplier

data.shipments.supplier.email

string | null

Optional email of the supplier

data.shipments.supplier.preferredContactMethod

string | null

Optional preferred contact method

data.shipments.supplier.phoneNumber

string | null

Optional phone number of the supplier

data.shipments.supplier.addressLineOne

string | null

Optional first line of address

data.shipments.supplier.addressLineTwo

string | null

Optional second line of address

data.shipments.supplier.city

string | null

Optional city

data.shipments.supplier.state

string | null

Optional state or province

data.shipments.supplier.zipCode

string | null

Optional ZIP or postal code

data.shipments.supplier.country

string | null

Optional country

data.shipments.supplier.isArchived

boolean

default:false

Whether the supplier is archived

data.shipments.createdDate

string<date-time> | null

Date and time the shipment was created

data.shipments.note

string | null

Optional note for inventory log when updating shipment

data.items

ItemStock · object[] | null

Items in the stock

Show child attributes

data.items.itemId

string

required

ID of the item

data.items.stockId

string

required

ID of the stock

data.items.quantityUsed

number

required

Quantity of the item

data.locationSummaries

StockLocationSummary · object[] | null

Stock quantities grouped by location

Show child attributes

data.locationSummaries.locationId

string

required

ID of the location

data.locationSummaries.locationName

string

required

Name of the location

data.locationSummaries.totalQuantity

number

required

Total quantity at this location

data.locationSummaries.remainingQuantity

number

required

Remaining quantity at this location

data.locationSummaries.percentage

number

required

Percentage of stock remaining

data.note

string | null

Optional note for inventory log when updating stock

total

integer

required

List Shipments List Suppliers

⌘I

Getting Started

API

Tenant

Webhook

List Stocks

Headers

Query Parameters

Response