Order Object

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

id

integer

(Always returned in the response.)

The unique order record ID.

Example: 

"id": "1000032"

updatedDate

string (optional)

The date and time 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 (optional)

The date and time the record was created, in ISO 8601 format. (YYYY-MM-DD'T'hh:mm:ssZZ)

Example: 

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

deletedDate

string (optional)

(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 (optional)

Indicates whether the record is suppressed from public display.

Example: 

"suppressed": false

accountingUnit

integer (optional)

The accounting unit of the order.

Example: 

"accountingUnit": 1

estimatedPrice

number (optional)

The estimated price for one copy of the ordered item.

Example: 

"estimatedPrice": 73.44

vendorRecordCode

string (optional)

A library-defined code for the vendor that handles the order.

Example: 

"vendorRecordCode": "y0829"

orderDate

string (optional)

The date the material was ordered, in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZZ).

Example: 

"orderDate": "2015-12-20T08:00:00Z"

chargedFunds

array (optional)

The chargedFunds property contains a list of ChargedFund objects, which identify the funds to be charged and related data.

"chargedFunds": [

  {
    "displayOrder": 1,

    "fund": "https://example-library.iii.com/iii/sierra-api/
v6/orders/funds/1/00065",

    "copies": 2,
    "location": {

    "code": "a",

    "name": "SJSU"

    }
  }

]

location

object

(Returned only if requested; provided when available.)

The location property contains a Location object that includes a location code and display name identifying the physical location for which the item was ordered.

Example: 

"location": {
  "code": "a",
  "name": "SJSU"
},

code

string

The location code.

Example: 

"code": "a"

name

string

The location display name.

Example: 

"name": "SJSU"

vendorTitles

array (optional)

The vendorTitles property contains a list of the vendor's identification numbers for the associated titles, also called the Vendor ID #.

Example: 

"vendorTitles": ["348572"]

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 order 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 chargedFunds or vendorTitles properties, or the the varFields array for order records. You must specify these properties using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/orders/1000032?fields=vendorTitles,varFields

Returns the id and vendorTitles properties, and the varFields array for a single order 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 varFields. For example:

https://example-library.edu/iii/sierra-api/v6/orders/1000032?fields=default,varFields

Returns the default properties plus the varFields array for a single order record.

Example response for:

https://example-library.edu:443/iii/sierra-api/v6/orders/1000010?fields=default,chargedFunds,vendorTitle,varFields
{
  "id": 1000010,
  "updatedDate": "2010-07-28T17:29:53Z",
  "createdDate": "1986-01-31T12:00:00Z",
  "deleted": false,
  "suppressed": false,
  "accountingUnit": 1,
  "estimatedPrice": 27.95,
  "vendorRecordCode": "b0126",
  "orderDate": "1982-08-26T07:00:00Z",
  "chargedFunds": [
    {
      "displayOrder": 0,
      "fund": "https://example-library.iii.com/iii/sierra-api/v6/orders/
               funds/1/00095",
      "copies": 1,
      "location": {
        "code": "ab",
        "name": "King stacks"
      }
    }
  ],
  "vendorTitles": ["43991"],
  "varFields": [
    {
      "fieldTag": "a",
      "content": "c011668"
    },
    {
      "fieldTag": "n",
      "content": "CANCELLED: SERIES COMPLETE WITH VOLUME 8"
    },
    {
      "fieldTag": "n",
      "content": "Irregular."
    },
    {
      "fieldTag": "z",
      "content": "Original order no. X-2512, 8/26/82, recommended by Winter, 
                  Psychology."
    }
  ]
}