Skip to main content
PUT
/
inventory
/
stocks
/
update
Update Stock
curl --request PUT \
  --url https://api.decodahealth.com/inventory/stocks/update \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
[
  {
    "name": "<string>",
    "unit": "AMPOULES",
    "id": "<string>",
    "description": "<string>",
    "notes": "<string>",
    "category": "<string>",
    "minStockLevel": 123,
    "isArchived": false,
    "items": [
      {
        "itemId": "<string>",
        "stockId": "<string>",
        "quantityUsed": 123
      }
    ],
    "suppliers": [
      {
        "supplierId": "<string>",
        "stockId": "<string>",
        "id": "<string>",
        "uoms": [
          {
            "supplierPartNumber": "<string>",
            "uom": "AMPOULES",
            "id": "<string>",
            "supplierToStockId": "<string>",
            "conversionFactor": 1,
            "isDefault": false,
            "displayLabel": "<string>",
            "price": 123,
            "leadTime": 1,
            "createdDate": "2023-11-07T05:31:56Z",
            "updatedDate": "2023-11-07T05:31:56Z",
            "isArchived": false
          }
        ],
        "createdDate": "2023-11-07T05:31:56Z",
        "updatedDate": "2023-11-07T05:31:56Z",
        "isArchived": false
      }
    ],
    "shipments": [
      {
        "stockId": "<string>",
        "supplierId": "<string>",
        "locationId": "<string>",
        "quantity": 123,
        "remainingQuantity": 123,
        "id": "<string>",
        "poLineItemId": "<string>",
        "lotNumber": "<string>",
        "expiryDate": "2023-11-07T05:31:56Z",
        "sku": "<string>",
        "actualConversionFactor": 123,
        "cost": 123,
        "supplier": {
          "name": "<string>",
          "description": "<string>",
          "website": "<string>",
          "email": "<string>",
          "preferredContactMethod": "<string>",
          "phoneNumber": "<string>",
          "addressLineOne": "<string>",
          "addressLineTwo": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "country": "<string>",
          "shipmentTime": 123,
          "isArchived": false,
          "defaultNotes": [
            {
              "content": "<string>",
              "id": "<string>",
              "supplierId": "<string>",
              "name": "<string>"
            }
          ],
          "id": "<string>"
        },
        "createdDate": "2023-11-07T05:31:56Z",
        "note": "<string>",
        "location": {
          "id": "<string>",
          "name": "<string>",
          "isVirtual": false
        }
      }
    ],
    "locationSummaries": [
      {
        "locationId": "<string>",
        "locationName": "<string>",
        "totalQuantity": 123,
        "remainingQuantity": 123,
        "percentage": 123
      }
    ],
    "note": "<string>"
  }
]
'
[
  {
    "name": "<string>",
    "unit": "AMPOULES",
    "id": "<string>",
    "description": "<string>",
    "notes": "<string>",
    "category": "<string>",
    "minStockLevel": 123,
    "isArchived": false,
    "items": [
      {
        "itemId": "<string>",
        "stockId": "<string>",
        "quantityUsed": 123
      }
    ],
    "suppliers": [
      {
        "supplierId": "<string>",
        "stockId": "<string>",
        "id": "<string>",
        "uoms": [
          {
            "supplierPartNumber": "<string>",
            "uom": "AMPOULES",
            "id": "<string>",
            "supplierToStockId": "<string>",
            "conversionFactor": 1,
            "isDefault": false,
            "displayLabel": "<string>",
            "price": 123,
            "leadTime": 1,
            "createdDate": "2023-11-07T05:31:56Z",
            "updatedDate": "2023-11-07T05:31:56Z",
            "isArchived": false
          }
        ],
        "createdDate": "2023-11-07T05:31:56Z",
        "updatedDate": "2023-11-07T05:31:56Z",
        "isArchived": false
      }
    ],
    "shipments": [
      {
        "stockId": "<string>",
        "supplierId": "<string>",
        "locationId": "<string>",
        "quantity": 123,
        "remainingQuantity": 123,
        "locationName": "<string>",
        "id": "<string>",
        "poLineItemId": "<string>",
        "lotNumber": "<string>",
        "expiryDate": "2023-11-07T05:31:56Z",
        "sku": "<string>",
        "actualConversionFactor": 123,
        "cost": 123,
        "supplier": {
          "name": "<string>",
          "description": "<string>",
          "website": "<string>",
          "email": "<string>",
          "preferredContactMethod": "<string>",
          "phoneNumber": "<string>",
          "addressLineOne": "<string>",
          "addressLineTwo": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "country": "<string>",
          "shipmentTime": 123,
          "isArchived": false,
          "defaultNotes": [
            {
              "content": "<string>",
              "id": "<string>",
              "supplierId": "<string>",
              "name": "<string>"
            }
          ],
          "id": "<string>"
        },
        "createdDate": "2023-11-07T05:31:56Z",
        "note": "<string>"
      }
    ],
    "locationSummaries": [
      {
        "locationId": "<string>",
        "locationName": "<string>",
        "totalQuantity": 123,
        "remainingQuantity": 123,
        "percentage": 123
      }
    ],
    "note": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json
​
name
string
required

Name of the stock

​
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
​
id
string

Unique identifier for the stock

​
description
string | null

Optional description of the stock

​
notes
string | null

Notes about the stock

​
category
string | null

Category name (references category.name)

​
minStockLevel
number | null

Minimum stock level before alerting

​
isArchived
boolean
default:false

Whether the stock is archived

​
items
ItemStock · object[] | null

Items in the stock

​
suppliers
SupplierToStock · object[] | null

Suppliers linked to the stock

​
shipments
ShipmentWithLocation · object[] | null

Shipments in the stock

​
locationSummaries
StockLocationSummary · object[] | null

Stock quantities grouped by location

​
note
string | null

Optional note for inventory log when updating stock

Response

Successful Response

​
name
string
required

Name of the stock

​
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
​
id
string

Unique identifier for the stock

​
description
string | null

Optional description of the stock

​
notes
string | null

Notes about the stock

​
category
string | null

Category name (references category.name)

​
minStockLevel
number | null

Minimum stock level before alerting

​
isArchived
boolean
default:false

Whether the stock is archived

​
items
ItemStock · object[] | null

Items in the stock

​
suppliers
SupplierToStock · object[] | null

Suppliers linked to the stock

​
shipments
ShipmentWithLocation · object[] | null

Shipments in the stock

​
locationSummaries
StockLocationSummary · object[] | null

Stock quantities grouped by location

​
note
string | null

Optional note for inventory log when updating stock