Acquisitions API Mapping Table
The Sierra API uses the m2btab.oapi load table file by default. This file can be customized to match each library's specifications.
The following table describes the data mapping performed by the default m2btab.oapi file.
| API Parameter | Content Description* | Required | Repeatable | MARC Tag and Subfield | Order Record Field |
|---|---|---|---|---|---|
| login | alphanumeric; underscore and period allowed | Yes | No | ||
| copies | 1 - 1000 (maximum of 255 for EDIFACT orders) |
No for single fund/location orders. Yes for multiple funds and/or multiple locations. |
Yes | 960 o | copies |
| location | 1 to 5 alphanumeric characters | Yes | Yes | 960 t | location |
| fund | 1 to 15 alphanumeric characters | Yes | Yes | 960 u | fund |
| vendor | 1 to 5 alphanumeric characters | Yes | No | 960 v | vendor |
| price |
Do not include a currency symbol or punctuation marks other than a decimal to denote a fractional price (for example, 12.95). You cannot enter negative values . If the estimated price is not in your local currency, you must include the currency code in the currencyCode property. |
No | No | 960 s | eprice |
| acquisition type | a single alphanumeric character | No | No | 960 a | acq type |
| claim | a single alphanumeric character or hyphen ( - ) | No | No | 960 b | claim |
| code1 | a single alphanumeric character or hyphen ( - ) | No | No | 960 c | code1 |
| code2 | a single alphanumeric character or hyphen ( - ) | No | No | 960 d | code2 |
| code3 | a single alphanumeric character or hyphen ( - ) | No | No | 960 e | code3 |
| code4 | a single alphanumeric character or hyphen ( - ) | No | No | 960 f | code4 |
| format | a single alphanumeric character | No | No | 960 g | format |
| orderNote | a single alphanumeric character or hyphen ( - ) | No | No | 960 h | ord note |
| orderType | a single alphanumeric character | No | No | 960 i | ord type |
| raction | a single alphanumeric character or hyphen ( - ) | No | No | 960 j | raction |
| rloc | 3 alphanumeric characters | No | No | 960 k | rloc |
| bloc | 3 alphanumeric characters | No | No | 960 l | bloc |
| status | a single alphanumeric character | No | No | 960 m | status |
| tloc | a single alphanumeric character or hyphen ( - ) | No | No | 960 n | tloc |
| odate | mm-dd-yy | No | No | 960 q | odate |
| language | 3 alphabetical characters | No | No | 960 w | language |
| country | 3 alphabetical characters | No | No | 960 x | country |
| volume | an integer from 0 - 32767 | No | No | 960 y | volume |
| note | no restrictions | No | Yes | 961 Mc | note |
| staffNote | no restrictions | No | Yes | 961 Md | int note |
| vendorNote | no restrictions | No | Yes | 961 Mh | ven note |
| vendorIDNumber | no restrictions | No | Yes | 961 Mg | ven title |
| selector | no restrictions | No | Yes | 961 Mf | selector |
| vendorAccount | no restrictions | No | Yes | 961 Mm | blanket po |
| currencyCode | 3 characters comprising alphabetic characters, a currency symbol, and/or other punctuation mark. Numbers, hyphens ( - ) and periods ( . ) are not allowed. Must be a valid code from the Currency Table. Must be included if price (from 960 subfield s) is not in the local currency. | No | No | 960 z | for curr |
| identity | no restrictions | No | Yes | 961 Ma | identity |
| shipTo | The maximum length is 200 characters, divided into a maximum of 5 lines of 28 characters each. A "$" represents a line break. | No | Yes | 961 Mk | ship to |
| requestor | no restrictions | No | Yes | 961 Ml | requestor |
| oldOrderNumber | no restrictions | No | Yes | 961 Me | old order number |
| paidNote | no restrictions | No | Yes | 961 Mj | paid note |
| vendorAddress | The maximum length is 200 characters, divided into a maximum of 5 lines of 28 characters each. A "$" represents a line break. Must be included if the vendor code is "none". | No | Yes | 961 Mg | ven addr |
| customVarField1 | no restrictions | No | Yes | 961 Mq | custom field 1 |
| customVarField2 | no restrictions | No | Yes | 961 Mt | custom field 2 |
| customVarField3 | no restrictions | No | Yes | 961 Mu | custom field 3 |
| customVarField4 | no restrictions | No | Yes | 961 Mw | custom field 4 |
* Valid values for many fields are customizable by each library. See POST Data Describing a New Acquisition for parameter descriptions, as well as Fixed-length Fields in Order Records and Variable-length Fields in Order Records in the Sierra WebHelp for detailed information about the data fields.
See Also:
Load Tables in the Sierra WebHelp for more information about load tables.
Loading MARC Records from Book Vendors in the Innovative Vendor Docs for additional information.
Error Behavior
When the Sierra API encounters an error, it creates no order or bib record in Sierra. You should contact the vendor for initial troubleshooting.
When the Sierra API returns a warning, an order or bib record is created, but there may be issues with the records. In the event of a warning, view the log files with Sierra's Data Exchange function, and inspect the bib and order records for problems.