The Item API

The Item API contains methods for creating, retrieving, updating, and deleting item records.

With the Item API, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Create an Item Record

This endpoint is available in Sierra 5.1 and later. To use this endpoint, your key must be assigned the Items Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

POST /v6/items

Creates a new item record. Requires an ItemPatch request object.

If created successfully, HTTP 200 and a link to the item’s ID are returned.

Try it out!

Get a List of Item Records

To use this endpoint, your key must be assigned the Items Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/items/

Returns the properties of the first x Item Objects, where x = the value specified in the limit parameter. If you do not enter a limit, the system returns 50 records by default.

You can specify a list or a range of records IDs to retrieve specific records. Additionally, you can specify certain record properties to return only records that contain the corresponding data. See Search Parameters for more information.

You can also specify which fields in the item record to return. By default, queries do not return all data for the item record; you must specify additional properties using filter parameters. For example, to retrieve variable-length field information, specify "varFields" in the fields parameter. See Filter Parameters for more information.

If you do not specify filter parameters, queries return the following item record information by default:

  • item record ID
  • the date and time of the last update to the record
  • the date and time the record was created
  • the date the record was deleted (appears only if the record has been deleted)
  • whether the record has been deleted
  • the ID of each bibliographic records to which this item is linked
  • location code and name
  • status code and name
  • volumes
  • barcode
  • call number

Try it out!

Get Checkout Item Data

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Items Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/items/checkouts

Returns the total number of items checked-out and a Checkout Object for each checkout.

By default, this endpoint returns the first 50 results. You can limit the number of results to a value from 1 to 2000 and specify the beginning record to return. See Pagination Parameters for more information on using these limiters.

Try it out!

Check-In an Item

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Items Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

DELETE /v6/items/checkouts/{barcode}

Checks in an item using the specified item barcode. This functionality supports patron self-checkin using selfcheck and automated library return kiosks.

If successful, a 204 status is returned. Otherwise, an error code is returned.

Try it out!

Filter the Records by a Query in JSON Format

To use this endpoint, your key must be assigned the Items Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

POST /v6/items/query

Returns a list of records that satisfy the JSON query.

See Creating a JSON Query for information about the structure of Sierra JSON queries.

Try it out!

Delete an Item by Record ID

This endpoint is available in Sierra 5.1 and later. To use this endpoint, your key must be assigned the Items Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

DELETE /v6/items/{id}

Deletes the item record for the specified ID. If the item record has been deleted successfully, an HTTP 204 is returned. If the record cannot be deleted (for example, because the item is currently checked out), an HTTP 409 is returned.

Try it out!

Get an Item Record by Record ID

To use this endpoint, your key must be assigned the Items Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/items/{id}

Returns a single Item Object with the specified record ID. By default, queries do not return all data for the item record; you must specify additional properties using filter parameters. For example, to retrieve variable-length field information, specify "varFields" in the fields parameter. See Filter Parameters for more information.

If you do not specify filter parameters, queries return the following item record information by default:

  • item record ID
  • the date and time of the last update to the record
  • the date and time the record was created
  • the date the record was deleted (appears only if the record has been deleted)
  • whether the record has been deleted
  • the ID of each bibliographic record that this item is linked to
  • location code and name
  • status code and name
  • volumes
  • barcode
  • call number

Try it out!

Update an Item Record

This endpoint is available in Sierra 5.1 and later. To use this endpoint, your key must be assigned the Items Write role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

PUT /v6/items/{id}

Updates a specified item record. Requires an item record ID and an ItemPatch object. See Creating an Item Record for a list of fields you can specify in the ItemPatch object.

If updated successfully, HTTP 204 is returned. Otherwise, an error code is returned.

You can use this endpoint to suppress or unsuppress an item record from displaying in the WebPAC. To do so, you must update the item record to meet the suppression rules specified by the library. For example, if the library's suppression rules state that item records with a location of "pend" are suppressed, updating an item record to that location code automatically suppresses it from display.

If an item record matches multiple suppression rules, you must change the values of all fields specified in the suppression rule to unsuppress the item.

See Rules for Suppression in the Sierra WebHelp for more information.

Try it out!

Get Checkout Data by Item Record ID

This endpoint is available in Sierra 5.2 and later. To use this endpoint, your key must be assigned the Items Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/items/{id}/checkouts

Returns a Checkout Object for the specified item record. You can specify which fields to return. See Filter Parameters for more information.

Try it out!