Checkout Object

Click the links below to view the Checkout Object properties and an example.

id

string

(Always returned in the response.)

The ID of the checkout, returned as an API endpoint.

Example: 

"id": "https://example-library.edu/iii/sierra-api/v6/patrons/checkouts/4519234"

patron

string

The patron record number associated with the checkout, returned as an API endpoint.

Example: 

"patron": "https://example-library.edu/iii/sierra-api/v6/patrons/1042514"

item

string

The item record number associated with the checkout, returned as an API endpoint.

Example: 

"item": "https://example-library.edu/iii/sierra-api/v6/items/1000012"

barcode

string

(Returned only if requested.)

The barcode of the associated item.

Example: 

"barcode": "30800022790361"

dueDate

string

The due date of the item, in ISO 8601 format (YYYY-MM-DD).

Example: 

"dueDate": "2015-05-01"

callNumber

string

(Returned only if requested.)

The call number of the associated item.

Example: 

"callNumber": "|aPG3476.B425|bZ513"

numberOfRenewals

integer

(Returned only if requested.)

The total number of times the item has been renewed by the patron.

Example: 

"numberOfRenewals": 2

outDate

string

The checkout date and time for the item, in ISO 8601 format (YYYY-MM-DD'T'hh:mm:ssZZ).

Example: 

"outDate": "2015-04-14T18:12:57Z"

recallDate

string

The date the item was recalled (blank if the item has not been recalled), in ISO 8601 format (YYYY-MM-DD'T'hh:mm:ssZZ).

Example: 

"recallDate": "2015-04-28T20:10:44Z"

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

Default Response Contents

Default query responses for the Checkout object do not include the barcode, callNumber, or numberOfRenewals properties. You must specify these additional properties using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/patrons/1042514/checkouts?fields=barcode

Returns the id and barcode properties for any applicable Checkout objects.

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 barcode. For example:

https://example-library.edu/iii/sierra-api/v6/patrons/1042514/checkouts?fields=default,barcode

Returns the default properties plus the barcode property for any applicable Checkout objects.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/patrons/1042514/checkouts?fields=default,barcode,callNumber,numberOfRenewals
{
  "total": 2,
  "entries": [
    {
      "id": "https://example-library.iii.com/iii/sierra-api/v6/
             patrons/checkouts/4519234",
      "patron": "https://example-library.iii.com/iii/sierra-api/v6/
                 patrons/1042514",
      "item": "https://example-library.iii.com/iii/sierra-api/v6/
               items/1000012",
      "barcode": "30800022790361",
      "dueDate": "2015-05-01",
      "callNumber": "|aPG3476.B425|bZ513",
      "numberOfRenewals": 0,
      "outDate": "2015-04-14T18:12:57Z"
      "recallDate": "2015-04-28T20:10:44Z"
    },
    {
      "id": "https://example-library.iii.com/iii/sierra-api/v6/
             patrons/checkouts/4519235",
      "patron": "https://example-library.iii.com/iii/sierra-api/v6/
                 patrons/1042514",
      "item": "https://example-library.iii.com/iii/sierra-api/v6/
               items/1000004",
      "barcode": "30800005315459",
      "dueDate": "2015-05-01",
      "callNumber": "|aHX157|b.H8",
      "numberOfRenewals": 0,
      "outDate": "2015-04-28T20:10:58Z"
    }
  ]
}