Source:

Module: mod-inventory-storage

Interface: /item-storage/items

Attributes:

Property Name Property Type Property Description
id string Unique ID of the item record
_version integer Record version for optimistic locking
hrid string The human readable ID, also called eye readable ID. A system-assigned sequential alternate ID
holdingsRecordId string ID of the holdings record the item is a member of.
formerIds array Previous identifiers assigned to the item
discoverySuppress boolean Records the fact that the record should not be displayed in a discovery system
displaySummary string Display summary about the item
accessionNumber string Also called inventar number
barcode string Unique inventory control number for physical resources, used largely for circulation purposes
effectiveShelvingOrder string A system generated normalization of the call number that allows for call number sorting in reports and search results
itemLevelCallNumber string Call Number is an identifier assigned to an item, usually printed on a label attached to the item. The call number is used to determine the items physical position in a shelving sequence, e.g. K1 .M44. The Item level call number, is the call number on item level.
itemLevelCallNumberPrefix string Prefix of the call number on the item level.
itemLevelCallNumberSuffix string Suffix of the call number on the item level.
itemLevelCallNumberTypeId string Identifies the source of the call number, e.g., LCC, Dewey, NLM, etc.
effectiveCallNumberComponents object Elements of a full call number generated from the item or holding
effectiveCallNumberComponents/callNumber string Effective Call Number is an identifier assigned to an item or its holding and associated with the item.
effectiveCallNumberComponents/prefix string Effective Call Number Prefix is the prefix of the identifier assigned to an item or its holding and associated with the item.
effectiveCallNumberComponents/suffix string Effective Call Number Suffix is the suffix of the identifier assigned to an item or its holding and associated with the item.
effectiveCallNumberComponents/typeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
volume string Volume is intended for monographs when a multipart monograph (e.g. a biography of George Bernard Shaw in three volumes).
enumeration string Enumeration is the descriptive information for the numbering scheme of a serial.
chronology string Chronology is the descriptive information for the dating scheme of a serial.
yearCaption array In multipart monographs, a caption is a character(s) used to label a level of chronology, e.g., year 1985.
itemIdentifier string Item identifier number, e.g. imported from the union catalogue (read only).
copyNumber string Copy number is the piece identifier. The copy number reflects if the library has a copy of a single-volume monograph; one copy of a multi-volume, (e.g. Copy 1, or C.7.)
numberOfPieces string Number of pieces. Used when an item is checked out or returned to verify that all parts are present (e.g. 7 CDs in a set).
descriptionOfPieces string Description of item pieces.
numberOfMissingPieces string Number of missing pieces.
missingPieces string Description of the missing pieces.
missingPiecesDate string Date when the piece(s) went missing.
itemDamagedStatusId string Item dame status id identifier.
itemDamagedStatusDate string Date and time when the item was damaged.
administrativeNotes array Administrative notes
notes array Notes about action, copy, binding etc.
notes/itemNoteTypeId string ID of the type of note
notes/itemNoteType object Type of item’s note
notes/note string Text content of the note
notes/staffOnly boolean If true, determines that the note should not be visible for others than staff
circulationNotes array Notes to be displayed in circulation processes
circulationNotes/id string The id of the circulation note
circulationNotes/noteType string Type of circulation process that the note applies to
circulationNotes/note string Text to display
circulationNotes/source object The user who added/updated the note. The property is generated by the server and needed to support sorting. Points to /users/{id} resource.
circulationNotes/source/id string The id of the user who added/updated the note. The user information is generated by the server and needed to support sorting. Points to /users/{id} resource.
circulationNotes/source/personal object Personal information about the user
circulationNotes/source/personal/lastName string The user’s last name
circulationNotes/source/personal/firstName string The user’s first name
circulationNotes/date string Date and time the record is added/updated. The property is generated by the server and needed to support sorting.
circulationNotes/staffOnly boolean Flag to restrict display of this note
status object The status of the item
status/name string Name of the status e.g. Available, Checked out, In transit
status/date string Date and time when the status was last changed
materialTypeId string Material type, term. Define what type of thing the item is.
materialType object Item’s material type
permanentLoanTypeId string The permanent loan type, is the default loan type for a given item. Loan types are tenant-defined.
temporaryLoanTypeId string Temporary loan type, is the temporary loan type for a given item.
permanentLocationId string Permanent item location is the default location, shelving location, or holding which is a physical place where items are stored, or an Online location.
permanentLocation object The permanent shelving location in which an item resides
temporaryLocationId string Temporary item location is the temporarily location, shelving location, or holding which is a physical place where items are stored, or an Online location.
temporaryLocation object Temporary location, shelving location, or holding which is a physical place where items are stored, or an Online location
effectiveLocationId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
electronicAccess array References for accessing the item by URL.
electronicAccess/uri string uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources
electronicAccess/linkText string the value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated
electronicAccess/materialsSpecification string materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)
electronicAccess/publicNote string URL public note to be displayed in the discovery
electronicAccess/relationshipId string relationship between the electronic resource at the location identified and the item described in the record as a whole
inTransitDestinationServicePointId string Service point an item is intended to be transited to (should only be present when in transit)
statisticalCodeIds array List of statistical code IDs
purchaseOrderLineIdentifier string ID referencing a remote purchase order object related to this item
tags object List of simple tags that can be added to an object
tags/tagList array List of tags
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)
holdingsRecord2 object Fake property for mod-graphql to determine record relationships.
lastCheckIn object Information about when an item was last scanned in the Inventory app.
lastCheckIn/dateTime string Date and time of the last check in of the item.
lastCheckIn/servicePointId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
lastCheckIn/staffMemberId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/