Item Object

Click the links below to view the Item Object properties and examples. See the Item API for more information.

id

string

(Always returned in the response.)

The unique item record ID.

Example: 

"id": "1000057"

updatedDate

string

The datetime of the last update to the record, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ). The system updates this field any time the record is edited or involved in a transaction.

Example: 

"updatedDate": "2013-12-11T19:20:28Z"

createdDate

string

The datetime the record was created, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ) The createDate property can be used to search for an item by its creation date.

Example: 

"createdDate": "2013-12-11T19:04:44Z"

deletedDate

string

(Appears only if the record has been deleted.)

The date the record was deleted, in ISO 8601 format (YYYY-MM-DD).

Example: 

"deletedDate": "2014-01-11"

deleted

boolean

Specifies whether the record has been deleted.

Deleted Records

Deleted records return only their id, deletedDate, and deleted properties.

Example: 

"deleted": true

suppressed

boolean

Specifies whether the record is suppressed from display in the WebPAC.

Example: 

"suppressed": false

bibIds

array

A list of strings, which are the IDs of bibliographic records to which the item is attached.

Example: 

"bibIds": [
  "1996365"
]

location

object

The location property contains a Location object, which contains the shelf location code and display name for the item.

Example: 

"location": {
  "code": "ccfic",
  "name": "Conrad Library Fiction"
}

code

string

The location code.

Example: 

"code": "ccfic"

name

string

The location display name.

Example: 

"name": "Conrad Library Fiction"

status

object

The status property contains an ItemStatus object, which contains the status code and display value, and a due date ( in ISO 8601 format -yyyyMMdd'T'HHmmssZ) if the item is checked out.

See Fixed-length Fields in Item Records in the Sierra WebHelp for further information and important warnings on the use of status codes.

The standard status codes are:

-   AVAILABLE

m   MISSING

z   CL RETURNED

o   LIB USE ONLY

n   BILLED NOTPAID

$   BILLED PAID

t   IN TRANSIT

!   ON HOLDSHELF

l   LOST

At INN-Reach sites, the following additional codes and definitions are standard:

@   OFF SITE

#   RECEIVED

%   RETURNED

&   REQUEST

_   REREQUEST

(   PAGED

)   CANCELLED

1   LOAN REQUESTED

The library can define STATUS values and meanings in addition to the standard list.

Example: 

"status": {
  "code": "-",
  "display": "CHECK ON SHELF",
  "duedate": "2013-12-26T12:00:00Z"
}

code

string

The item status code.

Example: 

"code": "-"

display

string

The display value of the item status.

Example: 

"display": "CHECK ON SHELF"

dueDate

string

The due date of a checked-out item, in ISO 8601 format (yyyyMMdd'T'HHmmssZ).

Example: 

"duedate": "2013-12-26T12:00:00Z"

volumes

array

(Available in Sierra 5.2 and later) A list of strings, which are the links to the volume records associated with this item.

Example: 

"volumes": ["https://example-library.edu/iii/sierra-api/v6/volumes/1000126"]

barcode

string

(Provided when available.)

The item's barcode.

Example: 

"barcode": "37689000629276"

callNumber

string

(Provided when available.)

The call number found in the item record or, if the item has no call number, in the bibliographic record.

Example: 

"callNumber": "813/.54"

itemType

string

The type of the item record.

Example: 

"itemType": "University Material - T"

copyNo

integer

(Available in Sierra 5.1 and later) Indicates which copy of the title corresponds to the item record.

Example: 

"copyNo": "1"

holdCount

integer

(Available in Sierra 5.1 and later) The number of holds associated with the item.

Example: 

"holdCount": "8"

fixedFields

object

(Returned only if requested.)

The fixFields property contains a map of FixedField objects, which contain fixed-length data fields from the item record.

Example:

See fixedFields Object.

varFields

array

(Returned only if requested.)

The varFields property contains a list of VarField objects, which contain variable-length data fields from the item record.

Example:

See varFields Array.

The preceding list order reflects the sequence in which the data returns.

Default Response Contents

Default query responses do not include the fixedFields or varFields arrays for items. You must specify these arrays using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/items/3159578?fields=fixedFields

Returns the id property and fixedFields object for a single item record.

When you use the fields parameter, the API returns only the ID and specified properties. You can specify the value "default" to retrieve all default properties in addition to any explicitly specified properties, such as fixedFields. For example:

https://example-library.edu/iii/sierra-api/v6/items/3159578?fields=default,fixedFields

Returns the default properties plus the fixedFields object for a single item record.

The following example sends a call to GET /v6/items to return an item using a supplied item ID.

In the call below, the item ID is highlighted in red. In the response, the ID is highlighted in bold.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/items/3159578?fields=default,fixedFields,varFields
{
  "id": "3159578",
  "updatedDate": "2007-12-14T21:03:00Z",
  "createdDate": "2004-04-22T17:34:00Z",
  "deleted": false,
  "bibIds": [
    "1996365"
  ],
  "volumes": [],
  "location": {
    "code": "ccfic",
    "name": "Conrad Library Fiction"
  },
  "status": {
    "code": "-",
    "display": "CHECK ON SHELF"
  },
  "barcode": "37689000629276",
  "callNumber": "813/.54",
  "itemType": "University Material - T",
  "fixedFields": [
    {
      "label": "BIB HOLD",
      "number": 57,
      "value": "0"
    },
    {
      "label": "COPY #",
      "number": 58,
      "value": 1
    },
    {
      "label": "ICODE1",
      "number": 59,
      "value": "0"
    },
    {
      "label": "ICODE2",
      "number": 60,
      "value": "-"
    },
    {
      "label": "I TYPE",
      "number": 61,
      "value": 0,
      "display": "Books"
    },
    {
      "label": "PRICE",
      "number": 62,
      "value": "2495"
    },
    {
      "label": "LPATRON",
      "number": 67,
      "value": 1354780
    },
    {
      "label": "LCHKIN",
      "number": 68,
      "value": "2013-11-22T14:14:00Z"
    },
    {
      "label": "INVDA",
      "number": 69,
      "value": "2010-07-15T10:45:00Z",
    },
    {
      "label": "IN LOC",
      "number": 70,
      "value": "ccfic",
      "display": "Conrad Library Fiction"
    },
    {
      "label": "# RENEWALS",
      "number": 71,
      "value": 0
    },
    {
      "label": "# OVERDUE",
      "number": 72,
      "value": 0
    },
    {
      "label": "IUSE3",
      "number": 74,
      "value": "0"
    },
    {
      "label": "TOT CHKOUT",
      "number": 76,
      "value": 1
    },
    {
      "label": "TOT RENEW",
      "number": 77,
      "value": 0
    },
    {
      "label": "LOUTDATE",
      "number": 78,
      "value": "2013-11-15T11:30:00Z",
    },
    {
      "label": "LOCATION",
      "number": 79,
      "value": "ccfic",
      "display": "Conrad Library Fiction"
    },
    {
      "label": "LOANRULE",
      "number": 87,
      "value": 0
    },
    {
      "label": "STATUS",
      "number": 88,
      "value": "-",
      "display": "CHECK ON SHELF"
    },
    {
      "label": "INTL USE",
      "number": 93,
      "value": "0"
    },
    {
      "label": "COPY USE",
      "number": 94,
      "value": "0"
    },
    {
      "label": "IMESSAGE",
      "number": 97,
      "value": "-",
      "display": "--"
    },
    {
      "label": "OPACMSG",
      "number": 108,
      "value": "-",
      "display": "---"
    },
    {
      "label": "YTDCIRC",
      "number": 109,
      "value": 1
    },
    {
      "label": "LYRCIRC",
      "number": 110,
      "value": 0
    },
    {
      "label": "AGENCY",
      "number": 127,
      "value": "0",
      "display": "North"
    },
    {
      "label": "VI CENTRAL",
      "number": 161,
      "value": "0",
      "display": ""
    }
  ],
  "varFields": [
    {
      "fieldTag": "b",
      "content": "37689000629276"
    },
    {
      "fieldTag": "c",
      "marcTag": "092",
      "ind1": " ",
      "ind2": " ",
      "content": [
        {
          "tag": "a",
          "content": "813/.54"
        }
      ]
    },
    {
      "fieldTag": "I",
      "marcTag": "948",
      "ind1": "1",
      "ind2": "0",
      "content": [
        {
          "tag": "1",
          "content": "gs"
        },
        {
          "tag": "2",
          "content": "gsb"
        },
        {
          "tag": "b",
          "content": "37689000629276"
        },
        {
          "tag": "g",
          "content": "04/16/2002"
        },
        {
          "tag": "h",
          "content": "04/16/2002"
        },
        {
          "tag": "t",
          "content": "G21"
        },
        {
          "tag": "z",
          "content": "7"
        },
        {
          "tag": "d",
          "content": "813.54"
        },
        {
          "tag": "m",
          "content": "LLCS"
        },
        {
          "tag": "n",
          "content": "GRS"
        },
        {
          "tag": "k",
          "content": "O"
        },
        {
          "tag": "j",
          "content": "07/27/2002"
        },
        {
          "tag": "c",
          "content": "GA2"
        },
        {
          "tag": "p",
          "content": "2495"
        }
      ]
    }
  ]
}

The following example sends a call to GET /v6/items to request a return that searches for items by creation date. The createdDate property defines the creation date. When used in a call, the date does not follow a timestamp format. It is defined as YYYY-MM-DD. For example, 2020-02-13

In the following example:

  • limit specifies the number of items to return.
  • createdDate specifies the date applied to the search.
  • deleted indicates to retrieve deleted or nondeleted items. True=include deleted items. False=include nondeleted items.
  • suppressed indicates whether to retrieve suppressed records. True=include suppressed records. False=exclude suppressed records.

Each instance of the created date is highlighted in the following return.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/items/?limit=5&createdDate=2009-01-05&deleted=false&suppressed=false
{
  "total": 5,
  "entries": [
    {
      "id": "6325329",
      "updatedDate": "2013-07-03T20:59:11Z",
      "createdDate": "2009-01-05T15:55:00Z",
      "deleted": false,
      "bibIds": [
        "3659096"
      ],
      "volumes": [],
      "location": {
        "code": "06jm",
        "name": "Hillview Children's Media"
      },
      "status": {
        "code": "-",
        "display": "AVAILABLE"
      },
      "barcode": "31197079244734",
      "callNumber": "J DVD Carole"
    },
    {
      "id": "6325330",
      "updatedDate": "2013-07-03T20:59:11Z",
      "createdDate": "2009-01-05T15:55:00Z",
      "deleted": false,
      "bibIds": [
        "3659096"
      ],
      "volumes": [],
      "location": {
        "code": "12jm",
        "name": "Edenvale Children's Media"
      },
      "status": {
        "code": "-",
        "display": "AVAILABLE"
      },
      "barcode": "31197079244742",
      "callNumber": "J DVD Carole"
    },
    {
      "id": "6325331",
      "updatedDate": "2013-07-03T20:59:11Z",
      "createdDate": "2009-01-05T15:55:00Z",
      "deleted": false,
      "bibIds": [
        "3659096"
      ],
      "volumes": [],
      "location": {
        "code": "00jm",
        "name": "King Children's Media 1st Floor"
      },
      "status": {
        "code": "-",
        "display": "AVAILABLE"
      },
      "barcode": "31197079244759",
      "callNumber": "J DVD Carole"
    },
    {
      "id": "6325334",
      "updatedDate": "2013-07-03T20:59:11Z",
      "createdDate": "2009-01-05T15:55:00Z",
      "deleted": false,
      "bibIds": [
        "3659096"
      ],
      "volumes": [],
      "location": {
        "code": "03jm",
        "name": "Rose Garden Children's Media"
      },
      "status": {
        "code": "-",
        "display": "AVAILABLE"
      },
      "barcode": "31197079244601",
      "callNumber": "J DVD Carole"
    },
    {
      "id": "6325335",
      "updatedDate": "2014-01-17T19:03:35Z",
      "createdDate": "2009-01-05T15:55:00Z",
      "deleted": false,
      "bibIds": [
        "3659096"
      ],
      "volumes": [],
      "location": {
        "code": "10jm",
        "name": "Almaden Children's Media"
      },
      "status": {
        "code": "-",
        "display": "AVAILABLE",
        "duedate": "2014-02-07T12:00:00Z"
      },
      "barcode": "31197079244726",
      "callNumber": "J DVD Carole"
    }
  ]
}