> ## Documentation Index > Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt > Use this file to discover all available pages before exploring further. # List Item ## OpenAPI ````yaml get /inventory/items/list openapi: 3.1.0 info: title: Decoda API description: External API documentation for the Decoda Health platform. version: '1.0' servers: [] security: [] paths: /inventory/items/list: get: tags: - provider - inventory summary: List Item operationId: list_item_inventory_items_list_get parameters: - name: TENANT in: header required: true schema: type: string title: Tenant description: The tenant you are making this request on behalf of - name: API-KEY in: header required: true schema: type: string title: Api-Key description: Your api key - name: page in: query required: false schema: anyOf: - type: integer - type: 'null' title: Page - name: per_page in: query required: false schema: anyOf: - type: integer - type: 'null' title: Per Page - name: sort_by in: query required: false schema: anyOf: - type: string - type: 'null' title: Sort By - name: sort_direction in: query required: false schema: anyOf: - type: string enum: - asc - desc - type: 'null' title: Sort Direction - name: location_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Location Id - name: ids in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: List of item IDs to filter by title: Ids description: List of item IDs to filter by - name: name in: query required: false schema: anyOf: - type: string - type: 'null' description: Name of the item title: Name description: Name of the item - name: category in: query required: false schema: anyOf: - type: string - type: 'null' description: Category of the item title: Category description: Category of the item - name: price_range in: query required: false schema: anyOf: - type: array items: type: integer - type: 'null' description: Price range [min, max] title: Price Range description: Price range [min, max] - name: is_archived in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Archived status of the item title: Is Archived description: Archived status of the item - name: is_physical in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Physical status of the item title: Is Physical description: Physical status of the item responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Page_ItemDetail_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: Page_ItemDetail_: properties: data: items: $ref: '#/components/schemas/ItemDetail' type: array title: Data total: type: integer title: Total type: object required: - data - total title: Page[ItemDetail] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ItemDetail: properties: id: type: string title: Id description: Unique identifier for the item name: type: string title: Name description: Name of the item brandName: anyOf: - type: string - type: 'null' title: Brandname description: Optional brand name of the item description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the item price: type: integer title: Price description: Price of the item in cents category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) unit: anyOf: - $ref: '#/components/schemas/Unit' - type: 'null' description: Unit of measurement for the item isPhysical: type: boolean title: Isphysical description: Whether the item is physical default: true isArchived: type: boolean title: Isarchived description: Whether the item is archived default: false internalNotes: anyOf: - type: string - type: 'null' title: Internalnotes description: Optional internal notes for the item taxable: type: boolean title: Taxable description: Whether the item is subject to taxes default: false sortOrder: anyOf: - type: integer - type: 'null' title: Sortorder description: Optional sort order for the item allowCustomPricing: type: boolean title: Allowcustompricing description: Whether custom pricing is allowed for this item default: false type: $ref: '#/components/schemas/ItemType' description: Type of item (PRODUCT, MEDICATION, etc.) default: PRODUCT stocks: anyOf: - items: $ref: '#/components/schemas/ItemStockDetail' type: array - type: 'null' title: Stocks description: Optional linked stocks for the item usageCount: anyOf: - type: integer - type: 'null' title: Usagecount description: Number of times this item has been used type: object required: - name - price - usageCount title: ItemDetail ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError Unit: type: string enum: - 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 title: Unit ItemType: type: string enum: - ITEM - PRODUCT - MEDICATION - SERVICE - PACKAGE - MEMBERSHIP title: ItemType ItemStockDetail: properties: itemId: type: string title: Itemid description: ID of the item stockId: type: string title: Stockid description: ID of the stock quantityUsed: type: number title: Quantityused description: Quantity of the item stock: $ref: '#/components/schemas/Stock' description: Details of the linked stock type: object required: - itemId - stockId - quantityUsed - stock title: ItemStockDetail Stock: properties: id: type: string title: Id description: Unique identifier for the stock name: type: string title: Name description: Name of the stock description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the stock notes: anyOf: - type: string - type: 'null' title: Notes description: Notes about the stock category: anyOf: - type: string - type: 'null' title: Category description: Category name (references category.name) unit: $ref: '#/components/schemas/Unit' description: Unit of measurement isArchived: type: boolean title: Isarchived description: Whether the stock is archived default: false shipments: anyOf: - items: $ref: '#/components/schemas/Shipment-Output' type: array - type: 'null' title: Shipments description: Shipments in the stock type: object required: - name - unit title: Stock Shipment-Output: properties: id: type: string title: Id description: Unique identifier for the shipment stockId: type: string title: Stockid description: ID of the stock supplierId: type: string title: Supplierid description: ID of the supplier locationId: type: string title: Locationid description: ID of the location where the shipment was delivered lotNumber: anyOf: - type: string - type: 'null' title: Lotnumber description: Optional lot number of the shipment expiryDate: anyOf: - type: string format: date-time - type: 'null' title: Expirydate description: Optional expiry date of the shipment sku: anyOf: - type: string - type: 'null' title: Sku description: Optional SKU (Stock Keeping Unit) quantity: type: number title: Quantity description: Total quantity remainingQuantity: type: number title: Remainingquantity description: Remaining quantity cost: anyOf: - type: integer - type: 'null' title: Cost description: Cost of the shipment in cents supplier: anyOf: - $ref: '#/components/schemas/Supplier' - type: 'null' description: Optional supplier details createdDate: anyOf: - type: string format: date-time - type: 'null' title: Createddate description: Date and time the shipment was created note: anyOf: - type: string - type: 'null' title: Note description: Optional note for inventory log when updating shipment locationName: anyOf: - type: string - type: 'null' title: Locationname description: Get the location name from the related location object readOnly: true type: object required: - stockId - supplierId - locationId - quantity - remainingQuantity - locationName title: Shipment Supplier: properties: id: type: string title: Id description: Unique identifier for the supplier name: type: string title: Name description: Name of the supplier description: anyOf: - type: string - type: 'null' title: Description description: Optional description of the supplier website: anyOf: - type: string - type: 'null' title: Website description: Optional website of the supplier email: anyOf: - type: string - type: 'null' title: Email description: Optional email of the supplier preferredContactMethod: anyOf: - type: string - type: 'null' title: Preferredcontactmethod description: Optional preferred contact method phoneNumber: anyOf: - type: string - type: 'null' title: Phonenumber description: Optional phone number of the supplier addressLineOne: anyOf: - type: string - type: 'null' title: Addresslineone description: Optional first line of address addressLineTwo: anyOf: - type: string - type: 'null' title: Addresslinetwo description: Optional second line of address city: anyOf: - type: string - type: 'null' title: City description: Optional city state: anyOf: - type: string - type: 'null' title: State description: Optional state or province zipCode: anyOf: - type: string - type: 'null' title: Zipcode description: Optional ZIP or postal code country: anyOf: - type: string - type: 'null' title: Country description: Optional country isArchived: type: boolean title: Isarchived description: Whether the supplier is archived default: false type: object required: - name title: Supplier ````