AcquisitionOrder Object
The AcquisitionOrder object includes the following properties:
login
string
The Sierra username to associate with created orders..
Example:
"login": "jdoe"
copies
integer (optional)
The total number of copies ordered.
With multiple funds and/or multiple locations, this property is required. The copies are allocated until depleted or the multiple funds/location quantities are satisfied. For more information, see Notes on Multiple Funds and Multiple Locations in the Innovative Vendor Documentation.
Example:
"copies": 10
allocation
array
The allocation property contains an AcquisitionOrderAllocation array that lists data describing how the order is allocated.
Example:
"allocation": [
{
"location": "01"
"fund": "acnfe"
"copies": "5"
}
{
"location": "00"
"fund": "acmer"
"copies": "5"
}
]
Child Properties
location
string
The shelving location or branch for which the order is placed.
Example:
"location": "01"
fund
string
The fund code against which the material is encumbered and paid.
Example:
"fund": "acnfe"
copies
integer (optional)
The number of copies ordered for this location and fund code.
The maximum number of copies is 1000.
Example:
"copies": 5
vendor
string
The library-defined code for the vendor who handles the order.
This code can be translated during loading by editing the m2btab.oapi load profile.
The maximum code length is 5 characters.
Example:
"vendor": "bna"
price
number (optional)
The estimated price per copy.
Do not include a currency symbol or punctuation marks, other than a decimal to denote a non-whole number price. Negative values are not permitted. If the estimated price is not in your local currency, you must include the currency code in the currencyCode property.
Example:
"price": "12.40"
acquisitionType
string (optional)
The library-defined acquisition type code or the method of paying for the material.
The maximum code length is 1 character.
Example:
"acquisitionType": "p"
claim
string (optional)
The claiming activity code.
The maximum code length is 1 character.
Example:
"claim": "e"
code 1
string (optional)
Library-defined order codes 1.
The maximum code length is 1 character.
Example:
"code1": "???"
code2
string (optional)
Library-defined order codes 2.
The maximum code length is 1 character.
Example:
"code2": "???"
code3
string (optional)
Library-defined order codes 3.
The maximum code length is 1 character.
Example:
"code3": "???"
code4
string (optional)
Library-defined order codes 4.
The maximum code length is 1 character.
Example:
"code4": "???"
format
string (optional)
A code representing the physical form of the material. Hash tags (#) must be URL encoded.
The maximum code length is 1 character.
Example:
"format": "???"
orderNote
string (optional)
A code representing an order note to print on the purchase order form.
The maximum code length is 1 character.
Example:
"orderNote": "a"
orderType
string (optional)
A code representing the type of order.
The maximum code length is 1 character.
Example:
"orderType": "a"
raction
string (optional)
A code that represents the receiving action.
The maximum code length is 1 character.
Example:
"raction": "-"
rloc
string (optional)
(Returned only if requested.)
A code representing the receive location.
The maximum code length is 1 character.
Example:
"rloc": "k"
bloc
string (optional)
A code representing the billing location.
The maximum code length is 1 character.
Example:
"bloc": "p"
status
string (optional)
A system-generated code representing the financial encumbering or disencumbering status of a record.
The maximum code length is 1 character.
Example:
"status": "1"
tloc
string (optional)
A code representing a temporary shelving location.
The maximum code length is 1 character.
Example:
"tloc": "b"
odate
string (optional)
The date the material was ordered, in the form of mm-dd-yy.
Example:
"odate": "04-15-2016"
language
string (optional)
The language of the material, based on the MARC21 Code List for Language. This is also used by UNIMARC systems.
The maximum code length is 3 characters.
Example:
"language": "eng"
country
string (optional)
The country of publication, based on the MARC21 Code List of Countries, or ISO 3166/MA standard for UNIMAR systems.
The maximum code length is 3 characters.
Example:
"country": "cau"
volume
integer (optional)
The number of volumes for this title.
The range of valid values is 0 - 32767.
Example:
"volume": 1
note
array (optional)
A free-text note. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"note": ["Phone call to Al Cline 2/25/16"]
staffNote
array (optional)
A free-text internal staff note. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"staffNote": ["report: order confirmed, 02-21-16,dm"]
vendorNote
array (optional)
A free-text note for vendor order information. This is a repeatable parameter.
staffNote": ["report: order confirmed, 02-21-16,dm
Example:
"vendorNote": ["Cancel at the end of subscription period 12/01/16"]
vendorIDNumber
array (optional)
The vendor's identification number for this title. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"vendorIDNumber": ["348572"]
selector
array (optional)
A free-text note identifying the selector of the item. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"selector": ["Doe, John","Smith, John"]
vendorAccount
array (optional)
The vendor account number. This is a repeatable character.
The maximum length is 10,000 characters.
Example:
"vendorAccount": ["123-456-789"]
currencyCode
string (optional)
The foreign currency code.
The maximum length is 3 characters. Valid characters include alphabetic characters, a currency symbol, and/or other punctuation mark. Numbers, hyphens ( - ) and periods ( . ) are not allowed. This must be a valid code from the Currency Table and must be included if the price (from 960 subfield s) is not in the local currency.
Example:
"currencyCode": "eur"
identity
array (optional)
The identity property contains a list of free-text notes used to distinguish between order records. It is used for complex records where the order does not represent the entire title, rather portions of a title, such as specific volumes, supplements, or special formats.
The maximum length is 10,000 characters.
Example:
"identity": ["Replacement copy">]
shipTo
array (optional)
The library address where the vendor should ship materials. This is a repeatable parameter.
The maximum length is 200 characters, divided into a maximum of 4 lines of 28 characters each. A "$" represents a line break.
Example:
"shipTo": ["Main Library$1000 N. State St.$Ann Arbor, MI 46036"]
requestor
array (optional)
The name of the requestor. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"requestor": ["Smith, John"]
oldOrderNumber
array (optional)
The old order number. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"oldOrderNumber": ["8800000219"]
paidNote
array (optional)
The paidNote property contains a list of payment notes. These notes are typically found in the PAID field of an order record. This is a repeatable parameter.
The maximum length is 35 characters.
Example:
"paidNote": "Replacement copy"]
vendorAddress
array (optional)
Lists one of more vendor address strings. This is a repeatable parameter.
The maximum length is 200 characters, divided into a maximum of 5 lines of 28 characters each. A "$" represents a line break.
Example:
"vendorAddress": ["Inst. of Public Policy$Stewart Building$1134 N. College Ave.$Mission, IN 46036"]
customVarField1
array (optional)
Consists of one or more strings that represent variable-length data fields. To use this property, the m2btab.oapi file must be customized to map a source field to the intended destination field. This is a repeatable parameter.
The maximum length is 10,000 characters.
Example:
"customVarField1": ["Custom variable-length content"]
customVarField2
array (optional)
Consists of one or more strings that represent variable-length data fields. To use this property, the m2btab.oapi file must be customized to map a source field to the intended destination field. This is a repeatable parameter.
Example:
>"customVarField2": ["Custom variable-length content"]
customVarField3
array (optional)
Consists of one or more strings that represent variable-length data fields. To use this property, the m2btab.oapi file must be customized to map a source field to the intended destination field. This is a repeatable parameter.
Example:
>"customVarField3": ["Custom variable-length content"]
customVarField4
array (optional)
Consists of one or more strings that represent variable-length data fields. To use this property, the m2btab.oapi file must be customized to map a source field to the intended destination field. This is a repeatable parameter.
Example:
>"customVarField4": ["Custom variable-length content"]