DATA SERVICES | WEB

Implementation Guide
Version 16, Release 7
September 17, 2015

Copyright© Ingram Data Services Inc. All rights reserved.

 Table of Contents
Overview ...................................................................................................................................................... 3
About this Guide ......................................................................................................................................................... 4
Implementation ............................................................................................................................................ 5
Development and Testing .......................................................................................................................................... 5
Production .................................................................................................................................................................. 5
Integration options ...................................................................................................................................................... 5
Security and Usage Monitoring .................................................................................................................................. 5
Storing Data ............................................................................................................................................................... 6
Ingram Web service URL's ......................................................................................................................................... 6
Query Requests ........................................................................................................................................... 7
Query Syntax ............................................................................................................................................................. 7
Query Types............................................................................................................................................................. 10
Data Filtering ............................................................................................................................................. 15
Popular Mnemonics .................................................................................................................................. 19
Popular Data Elements ............................................................................................................................. 23
Search Mnemonics ................................................................................................................................... 33
Mnemonic Handling .................................................................................................................................. 43
Troubleshooting ........................................................................................................................................ 50
Frequently Asked Questions ................................................................................................................... 53
Best Practices ........................................................................................................................................... 55
Document History ..................................................................................................................................... 56
Contacts ..................................................................................................................................................... 64
Overview
The Ingram Web service provides access to the millions of items in the Ingram database, including items that are
available from Ingram as well as items that are no longer available from Ingram.

Ingram Web service will allow you to incorporate data retrieval and or a search feature into a Web Site, library
collections system, in-store inventory reference system, inventory control system, or consumer kiosk.

Ingram Web service provides the data that you need, when you need it. Since the data is updated nightly, stored, and
maintained by Ingram so that you can focus on your customer's experience and core business processes.

Ingram Web service offers on-demand information for a large amount of items with numerous data elements, fast
response, real-time inventory availability, multiple image sizes with more than 98% coverage of active items, and
several integration options (API Java, API DLL, and full integration). The data elements included are; bibliographic
and classification information, descriptions, and book review text from various sources, and much, much more.

Here is a sample of the data elements and search options available.

Sample of search options:

• Item code search that includes EAN, UPC, and ISBN.
• Keyword inquiry using keyword, keyword title, keyword contributor, and keyword subject.
• Bibliographic data search on title, author, price, publication date, binding, edition, series, language, etc.
• Audience search to pull items with a specific rating, age, or grade level.
• Bible specific search criteria, e.g., version, type, red letter, concordance, etc.
• Gift specific search criteria, e.g., color, product format, media type, package dimensions.
• Music specific search criteria, e.g., primary instrument, format, release date, record label, song title, etc.

Sample of data elements:

• Physical attributes and product classification elements include; title, publisher, author, illustrator, accessory
(with Doll, with CD), dimensions and weight, etc.
• Full color cover images in three sizes that add instant visual appeal and interest to your Web site or in-store
inventory reference system.
• Product descriptions collected from one or more sources.
• Subject categories used to group books based on the content and topic, which can also determine where the
item is stored in a bookstore or compartmentalized on a Web [Link] provides an option to link items
with a common theme to create effective, targeted, or seasonal marketing lists.
• Family linking allows the option to display related items together, to show various editions or formats of a
item.
• Product specific data elements that are essential for selling, e.g., books, bibles, music, gift, and game.

Additional data elements:

• Review data for items that have been reviewed by various sources, including book review citations, quotes,
and full text reviews.
• Logistics data elements that are related to item management processes, e.g., Country of origin, Harmonized
codes.
• Reading Programs specific data elements used to identify books within a given students reading ability and
or interest level.

Please note: Ingram Web service was designed to dynamically populate Web sites; therefore downloading data into
a database is prohibited. Please contact Ingram to review other options that will better fit your content and business
needs.

Ingram Web Service ImplementationGuide 3

About this Guide
The Ingram Web service implementation guide provides detailed information for a developer who is working to
integrate the Ingram Web service data retrieval into a search feature on a Web site, library collections system, in-
store inventory reference system, inventory control system, or consumer kiosk. Although Web services are relatively
easy to work with, this integration will require a talented developer, preferably one with some Web service
experience. In addition, this implementation guide assumes that the developer is already familiar with Web services,
therefore only contains information that is relevant to Ingram Web service.

To assist with document navigation, there are several hyperlinks in this document that link to pages in this document
or to other documents that will provide additional information related to that topic.

Every effort has been made to ensure the accuracy of the information provided in this guide and supporting
documents to make it as helpful and user friendly as possible. If you should find errors or have suggestions for
improvement, please notify the Ingram integration team.

Please note: All times are central time (CT) and are subject to change without notice.

Document Version and Change Management

There are two levels of version control used in our documentation, version X, release X, where X represents the
number of the sequential version or release of the document. We use "version" to describe a milestones that we have
achieved in our effort to provide more services to our customers. A particular version either identifies a major
change in the file specification or new functionality. We use "release" to communicate the levels of revision to the
current file specification and or functionality.
• A major release will contain significant upgrades in functionality, which will require changes to our
existing file specifications, e.g., expanded record length. This release will be identified by a change in the
version numbering sequence, e.g., version 1 release 0 changing to version 2, release 0. In this case, the
previous version is no longer supported. Therefore, you are required to make changes to your system even
if you do not wish to take advantage of the new features.
• A revised release refers to a minimal change, e.g., additional fields that do not affect the overall record
length, or the addition of new files. A revised release will be identified in the release numbering sequence,
e.g., release version 2release 0 changing to version 2, release 1. Please evaluate each release to determine if
your business model requires implementation of the changes.
All changes are reported in the Document History section of this guide. We will notify your technical contact, via
email, when new functionality and versions are available. Please contact the Ingram integration team to review or
update your technical contact information.

Ingram Web Service ImplementationGuide 4

Implementation
Getting started with a new service can be challenging, no matter how easy or complex. In this section, you will find
information about the Ingram Web service integration options, testing and production access credentials, security
and usage monitoring, and storing data. The average integration time varies per customer and the data included in
the subscription. Speed of implementation is dependent on your resources.

Development and Testing

Please review the data elements available with your data subscription, the applicable Ingram Web service integration
options, and the applicable sections of this guide before beginning your development. We encourage you to test
carefully before moving into production.

You may begin interacting with Ingram Web service as soon as test access has been provided. Test access requires
receipt of a fully executed data subscription and signed developer's agreement. Test access credentials will be sent
via email to the developer's email address provided on the signed developer's agreement, unless otherwise
instructed.

Please note: sample code for experimentation purposes is available upon request (e.g., VB6, Classic ASP, [Link],
and PHP).

Production
Production credentials are required to begin retrieving data from the production server. A unique userName and
URL for the production server will be provided, when your development is complete and we have reviewed and
approve your test queries. Please contact the Ingram integration team with your request to move into production.

Integration options
There are several integration options available for Ingram Web service. Here is a brief description of each option
that will help determine which sections of the implementation guide will be useful for your development.
• Full integration – this integration provides all data elements included with your data subscription and will
allow you to develop complex queries using multiple search mnemonics, sorts and data filters. Please
review all sections of the Ingram Web service implementation guide.
• Ingram API integration – provides all the same data as the Full integration, but provides you with the tools
to build simple queries by passing variables in just a few easy steps using Java™ JAR or .net DLL. The
IDS API provides the same results as the Full integration but offers a subset of the of search mnemonics,
data filtering and sorting options. Please click on this link to download the Ingram Web API
implementation guide.
• Image only integration – provides cover images, in the size specified by your data subscription. This
implementation will require that you build a query to retrieve the image URL using an EAN. Please review
the Images and queryType 5 sections of the Ingram Web service guide or the API guide.
• Inventory only integration – provides real-time inventory availability information. This implementation
will require you to build a query to retrieve data using one or more EAN's. Please review the real-time
inventory and queryType 9 sections of this guide or the Ingram Web API implementation guide.
• A combination of any or all of the integration options described above using both the Ingram Web service
and API to retrieve data on demand. Please review this guide as well as the Ingram Web API
implementation guide.

Security and Usage Monitoring

Please protect your user credentials and secure your queries so that external entities are unable to use your access to
obtain data. In addition, automating a process to make search request repeatedly for the purposes of downloading
and storing an unreasonable number of item records and images is strictly prohibited. The number of items that you
can download into a database is restricted by the user data subscription; please see Storing Data for information on
caching data. If downloading a large number of records is required for your systems, please contact Ingram to
discuss other available services that will be a better fit your system requirements.

Ingram Web Service ImplementationGuide 5

We monitor Ingram Web service usage, frequently, and reserve the right to disable access if the activity is deemed
excessive.

Storing Data
Ingram Web service was designed to dynamically populate Web pages; therefore downloading data into a database
is prohibited. However, if your site has featured item or static marketing booklists or booklists that change
occasionally, such as bestseller or book club readings, you may want to cache some data, including images, so that
the data is more easily accessible for faster page loading and to reduce server "hits".

As an alternative to pulling data for every item retrieved in a query result, we suggest that you cache the data for a
limited period, refreshing at an interval that best fits your business requirements, e.g., 7 days, 30 days, 60 days, etc.

To retrieve data for a booklist, you would send a query with multiple data elements joined with the operator "or",
e.g., a list that your associates have compiled of the top 10 bestselling trade paperback books,
(BN="9781616386108" or "9780920668375" or "9780439023528" or "9780743273565" or "9780399501487" or
"9780385474542" or "9780425232200" or "9780547577098" or "9781416936473" or "9780590353427").

Please note: When retrieving lists of EAN's, the results will be returned in the Web service's default sort order,
publication date, not the order listed in the query. Therefore, in order for your Web page to display the results in the
order that you desire, we suggest adding a display position or sequence to the list of EAN's that is stored in your
system (e.g., 1-10 for the EAN's in the query example above - 9781616386108|01, 9780920668375|02, etc.)

Ingram Web service URL's

Ingram Web service was developed using Microsoft's Visual Studio®.NET environment and runs on an IIS Web
server and can be accessed using SOAP or Representational State Transfer (REST) over a secure HTTP connection.

Test URL
The test server functionality is the same as production, however, the test server contains outdated
data, blank data elements, and a small subset of image URL's, thus your results sets may not match
if compared with the production data from another source (i.e., iPage). In addition, the real-time
inventory requests may not mirror production information.

URL: [Link] (used for both SOAP and REST)

Production URL
When you are ready to go "live", please supply your test queries for review along with your request
for a production access. Upon approval, we will provide a userName (valid only on the production
server) and the URL for the production server. This server uses Secure Socket Layer (SSL)
technology. The SSL certificates expire periodically. To avoid service interruptions, we
recommend that you develop an SSL policy to trust new certificates for this Web service.

URL: we will supply upon approval to go "live".

Server Availability and Notification

The production servers are clustered for minimal interruption so the service is available 24 hours,
seven days a week, with a weekly scheduled maintenance window. Notification will be sent via
email, if the service will be unavailable for any reason other than the scheduled maintenance
window listed below.

Server Maintenance schedule: All times are Central Standard Time (CST).
Day Duration
Sunday 12:00am - 05:00am You will receive data; however, it will be from the
previous days update.

Ingram Web Service ImplementationGuide 6

Query Requests
Query requests can be made in SOAP or REST and the results are returned in an XML format – which you must
treat as an object, and transform via a style sheet, and/or translate the XML into a temporary table for your shopping
cart.

• Each transaction stands alone, so the service is stateless and no session is started.
• Every request must include user credentials and a queryType.

Request and Response Protocols

Ingram supports the SOAP message protocol over a secure HTTP connection. SOAP naturally follows the HTTP
request/response message model providing SOAP request parameters in a HTTPs request and SOAP response
parameters in a HTTPs response.

Ingram also supports REST POST using basic HTTP header formatted to follow the basic access authentication,
with the username and password combined into a string "username:password". This string is then Base64 encoded
using the iso-8859-1 character set. The basic authentication is then added before the encoded string. A REST request
uses an encoded URL string to send the query request, which is a lightweight alternative to sending a SOAP
envelope. For more information on basic access authentication, see
[Link]

Ingram provides a Web Services Definition Language (WSDL), which describes the operations, the data format, and
data types for the query requests and responses. Your application will interpret the WSDL to provide your
application access to these operations. A machine-readable description file (Web Application Description Language,
WADL) for the REST request is also available upon request.

Schema definition tool, [Link] generates a class based on the

schema…"The generated classes can be used in conjunction with [Link] to read
and write XML code that follows the schema."

Query Syntax
The query syntax uses a proprietary query language to retrieve data from the Ingram Web service. You can create
complex queries by using Boolean operators, wildcards, mnemonics and data elements, and ranges. In this section,
you will find information about query format, including, required elements, query operators, pagination, and
wildcards.
o Search phrases should be surrounded by parentheses.
o Double quotes are required around the search words, except for numeric values.
o Use parentheses to define precedence.
o Multiple search values for a single mnemonic can be combined into a single search phrase, as long as each
value is delineated with double quotes, e.g., (KW="uncle" and "tom" and "dover")
o Keyword indices in the search database include single words only, therefore they must be joined with
operators, e.g., (KWTI="harry" and "potter") or (KWTI="harry") and (KWTI="potter").
Please note: (KWTI ="harry potter") will yield zero (0) results.
o A search string using the proprietary mnemonics is required for query types 1, 2, 3, 4 and 9, e.g.,
(mnemonic="search data"). Please see the Query Types and Mnemonics sections for more information.

Case Sensitivity
The username, password, and query request elements are case sensitive. Mnemonics are not case sensitive; however,
search values designated with a "Y" in the case sensitive column of the Mnemonics Handling table are case
sensitive, you must use the exact value, including the case, to retrieve data. In addition, some values in the search
results may contain uppercase values.

Ingram Web Service ImplementationGuide 7

Query Parameters
The query request contains several parameters and the required parameters are different for each queryType. Here is
a quick overview of the parameters.

• queryType – contains the number that corresponds to the product type query. Please see the queryType
section of this document for more information.

• query – contains the query string.

• startRecord and endRecord – use these parameters to set the number of records to be returned in the
result set, maximum is 25 records. See the pagination section of this guide for more information.

• liveUpdate – send a "Y" in this parameter to include real-time inventory availability in the query response.
See the inventory section of this guide for more information.

• dataRequest – use this parameter to retrieve enhanced data elements from the database, e.g., contributor
biographies, cover images, item descriptions, review citations, book review text, etc.

Here is a list if the dataRequest element codes.

dataRequest Element Description Code
Awards Awards data for awarding winning items. AWD
Bibliographic data This will return the full <book> or <music> XML to save you from doing BIB
two searches to put together BIB data with the enhanced data for a specific
item identifier.
Contributor biography Contains a short biographical narrative for a specific contributor (author, BIO
editor, illustrator, etc.) for an item.
Image URL This will provide an encrypted URL to display the front cover image for the 60 = IM60
item. Images are available in three sizes: 60, 94, and 187 pixels. The cover 94 = IM90
image URL can also be retrieved using queryType 1, 2, 3, and 4. 187 = IMG

Jacket back Description provided by the publisher that matches the text printed on the JB
back of the book cover.
Jacket flap Description provided by the publisher that matches the text printed on the JF
front flap of the book cover.
Publisher marketing description The publisher marketing description consists of descriptive text that appears PM
in publisher catalogs and flyers.
Review text ($) These are reviews from industry leaders, which are provided by review various
sources that aggregate the content. The review sources charge an additional
fee for accessing this data. Please ask an Ingram associate for more
information.
Review quotes These quotes can appear in any print or online article and are captured and RQ
provided by the publisher.
($ - requires additional subscription access)

• sortField
The Ingram Web service default sort is descending by publication date (which is the industry standard) and
results include items that have not yet been released or published. However, the sort parameter provides an
override for this default.
• Send in a sort field, mnemonic, and sort order code to specify how the results are to be sorted,
e.g., mnemonic|sortOrder
• Sort order values:
o "0" = sortOrder ascending, e.g., PR|0 = results are sorted by price low to high
o "1" = sortOrder descending, e.g., PR|1 = results are sorted by price high to low
• Please separate multiple sort parameters with a comma to specify one or more sort parameters
per query request, e.g., CO|0, PR|1.
• Please see the Mnemonic Handling table for a list of mnemonics that can be used to sort the
results. Denoted with a "Y" in the sort column.

Ingram Web Service ImplementationGuide 8

Query Operators
Search phrases can be combined with operators to join mnemonics and search data in the query string. The "AND"
operator takes precedence over "OR", e.g., ((KW="dog") or (KW="cat")) and (BSC="PSY*")

Here are the available operators: (alphabetical by description)

Description Operator Example
And and (KW="uncle" and "tom")
And not andnot (BND="DVD" andnot BND="audio")
Equals = (KW="dog")
Greater than > (PD>"20090401")
Less than < (PD<"19720401")
Not equal <> (BND<> "audio")
Or or ((KW="dog" or "cat"))
Range :::: (LRL="0200::::0300")
(PD="200501::::200506")

Pagination
Search query types that return multiple records (1, 2, 3, 4, 6, 8, and 9) have a limit of 25 records per query request.
With the large number of items available in the Ingram Web service database, it is likely that you will have more
than 25 records to display, so we recommend that you offer a link to the next page or a numbered page sequence,
e.g., << 1 2 3 4 >>, which will invoke another request for the next set of records.

• Use the matching records value to calculate the number of page requests required.
<MatchingRecs>150</MatchingRecs>. This would yield three requests for 25 records each.

• Use the total records value to determine how many items are in the database.
<TotalRecs>16247696</TotalRecs>

• The start and end record parameters are required for query requests that return multiple records (query
types 1, 2, 3, 4, 6, 8, and 9). If you request records 1 - 25 (startRecord=1 and endRecord=25) and there are
eight records matching your request, all eight records will be returned and the number of matching records
will be provided in the response header.
<MatchingRecs>8</MatchingRecs>
<StartRecord>1</StartRecord>
<RecordsReturned>8</RecordsReturned>

• If there are more than 25 matching records, you will need to send another query request for the next set of
25 records (startRecord 26 - endRecord 51) and so on.
<MatchingRecs>242</MatchingRecs>
<StartRecord>1</StartRecord>
<RecordsReturned>25</RecordsReturned>

Wildcards
Wildcards are substitutions for one or more characters and are useful when searching for "like" terms. In the Ingram
Web service, an asterisk (*) is used as a wildcard and is not valid as the first character in a search string. Many of
the search mnemonics support wildcards, e.g., TI ="foo*", results are titles beginning with "foo….", e.g., Fool and
his money, Football Crazy, etc.

Ingram Web Service ImplementationGuide 9

Query Types
There are several different query types available with the Ingram Web service. This section provides a description of
these query types. Each query type has a corresponding numeric code that is required in the query request and each
query type has unique bibliographic data elements corresponding to the product classification (books, music, gift &
game, and bibles); therefore, the results will have different XML response formats.

There are query types that are specific to the classification of the product, e.g., books, music, gift & game, and bibles
(query types 1, 2, 3, and 4). A query type that retrieves enhanced data elements, e.g., descriptions, review quotes,
review text (queryType 5). One that retrieves "other format" items (queryType 6), and another that provides real-
time inventory availability and other supplier related data, e.g., on hand quantity, backorder only indicator,
harmonized code, country of origin (queryType 9).

Here is a brief overview of the available query types. More detailed query type formats can be found on the
following pages:

• queryType 1 – Book
The most used queryType for bibliographic data elements for books, video, video games, gift & game,
songbooks, and Bibles. Please note: there are unique bibliographic data elements for music (queryType 2),
gift & game (queryType 3) and Bibles (queryType 4), please see more information on these query types
below.

• queryType 2 – Music
The music query, queryType 2, searches music products and returns unique bibliographic data elements
related to music products, e.g., format="Album", media="Compact Disc".

• queryType 3 – Gift & Game

The gift & game query, queryType 3, can be used to retrieve gift & game items (e.g., book lights) and
returns unique bibliographic data elements related to gift & game product, e.g., product format="Puppet",
media="Fabric", product color="Green".

• queryType 4 – Bible
Bible specific data only and returns unique bibliographic data elements related to Bibles, e.g., Bible
version="New International", binding color="Navy", edge color="Silver".

• queryType 5 – Enhanced Data

The enhanced data query, queryType 5, can be used for all product classifications (book, music, gifts &
games, video, and bibles) and provides enhanced data elements, e.g., awards, contributor biographies, cover
images, publisher address information, publisher marketing descriptions, review citations, and book review
text, etc. for a specific item.

• queryType 6 – Family
The family data, queryType 6, is proprietary to Ingram and represents the same intellectual property of
work, but in different formats, e.g., paperback, hardcover, audio book, album, songbook, etc. It works like
the "other formats" option on iPage. The family search returns bibliographic records and image URLs for
items within the same family.

• queryType 9 – Stock Check

The stock check, queryType 9, provides real-time inventory availability and other supplier related data,
e.g., on hand quantity, backorder only indicator, harmonized code, country of origin, etc. This data can be
incorporated into your shopping process to show the availability of the items when they are placed into the
shopping cart.

Ingram Web Service ImplementationGuide 10

queryType 1 – 4 - Book, Music, Gift & Game, and Bible
The most used queryTypes for bibliographic data elements for books, music, video, video games, gift & game,
songbooks, and Bibles. Each query has unique bibliographic data elements corresponding to the product
classification (books, music, gift & game, and bibles); therefore, the results will have different XML response
formats.

Query request schema:

[Link]

Response schemas:
Book - [Link]
Music - [Link]
Gift - [Link]
Bible - [Link]

queryType 1 – 4 query request Structure

The following elements should be included when sending query types 1 – 4.
Parameter Req'd Description
queryType Y 1, 2, 3, or 4
query Y Must contain a query string, e.g., (KW="uncle" and "tom") and SRC<>"X"
startRecord Y The record at which the response should start.
endRecord Y The record at which the response should end – maximum is 25 records.
sortField N The mnemonic and sort order representing how you would like the resulting records sorted.
liveUpdate N "Y" = will return real-time inventory information.
dataRequest N Send this parameter when requesting cover images to be returned in the initial query. Valid
dataRequest elements are "IMG", "IM60", and "IM90".

Request examples:

REST request:
queryType=1&query=(KW="uncle" and "tom") and
SRC<>"X"&startRecord=1&endRecord=25&sortField=DE|0&liveUpdate=Y&dataRequest=IMG,IM60,IM
90

SOAP request
<soap:Body>
<SearchRequestTypes12349Enhanced
xmlns="[Link]
<queryType>1</queryType>
<query>(KW="dog" and SRC<>"X")</query>
<startRecord>1</startRecord>
<endRecord>25</endRecord>
<sortfield>DE|0</sortfield>
<liveUpdate>Y</liveUpdate>
<dataRequest>IMG,IM60,IM90</dataRequest>
</SearchRequestTypes12349Enhanced>
</soap:Body>

Ingram Web Service ImplementationGuide 11

queryType 5 – Enhanced Data
The enhanced data query, queryType 5, can be used for all product classifications (book, music, gifts & games,
video, and bibles) and provides enhanced data elements, e.g., awards, contributor biographies, cover images,
publisher address information, publisher marketing descriptions, review citations, and book review text, etc. for a
specific item.

The query request must include a single item identifier and specific data request elements. Use commas to separate
multiple data request parameters, e.g., for a 187 pixel image, bibliographic, and publisher marketing data the request
would include, dataRequest=IMG, BIB, PM. Results are returned in the XML format corresponding to the product
classification being searched, except for gift & game, which will have a book XML format.

Query request schema: [Link]

Response schema: [Link]

queryType 5 Request Structure

The following elements should be included when sending query type 5.
Parameter Req'd Description
queryType Y 5

isbn Y Send an item identifier, e.g., EAN, ISBN, or UPC.

dataRequest Y Use commas to separate multiple data request parameters, e.g., for a 187 pixel image,
bibliographic, and publisher marketing data the request would include, dataRequest=IMG, BIB,
PM.

Request examples:

REST request
queryType=5&isbn="9780385503952"&dataRequest=string

SOAP request
<soap:Body>
<SearchRequestType5 xmlns="[Link]
<queryType>5</queryType>
<isbn>9780385503952</isbn>
<dataRequest>IMG,BIB,PM</dataRequest>
</SearchRequestType5>
</soap:Body>

Ingram Web Service ImplementationGuide 12

queryType 6 – Family
The family data is proprietary to Ingram and represents the same intellectual property of work, but in different
formats, e.g., paperback, hardcover, audio book, album, songbook, etc. It works like the "other formats" option on
iPage. The family search returns bibliographic records and image URLs for items within the same family.

• You can only do a family search with an item identifier - consequently losing the ability to control your
search based on on-hand or on-order quantities. Therefore, results may contain items that are not available
to purchase from Ingram.
• There are items in the database that have been assigned to a family, but the matching recorders are
available in the extended database. Therefore, if you are only displaying items in the Ingram or Spring
Arbor active item databases, you will have to filter the results based on the <Source> tag value.
• The results will be returned in the book XML format regardless of the product classification being
searched. "Other formats" is typically associated with book and recorded audio books. However, if a family
exists for an item that is classified as music, gift & game, or a Bible, it is possible to receive results, but the
results will be in the book XML format, thus the corresponding unique bibliographic data elements will not
be returned.
• Query request schema:
[Link]
• Response schema: [Link]

queryType 6 Request Structure

The following elements should be included when sending queryType 6 requests.
Parameter Req'd Description
queryType Y 6
isbn Y Send an item identifier, e.g., EAN, ISBN, or UPC.
startRecord Y The record at which the response should start.
endRecord Y The record at which the response should end – maximum is 25 records.
liveUpdate N "Y" = will return real-time inventory information.

Request examples:

REST request:
queryType=6&isbn="9780385503952"&startRecord=1&endRecord=25& liveUpdate=Y&

SOAP request
<soap:Body>
<SearchRequest6 xmlns="[Link]
<queryType>6</queryType>
<isbn>9780964729230</isbn>
<startRecord>1</startRecord>
<endRecord>25</endRecord>
<liveUpdate>Y</liveUpdate>
</SearchRequest6>
</soap:Body>

Ingram Web Service ImplementationGuide 13

queryType 9 – Stock Check
The stock check provides real-time inventory availability and other supplier related data, e.g., on hand quantity,
backorder only indicator, harmonized code, country of origin, etc. This data can be incorporated into your shopping
process to show the availability of the items when they are placed into the shopping cart.

With the stock check query, you can request real-time inventory information for up to 25 items at a time for an EAN
or UPC, using the BN mnemonic and the "OR" operator. This search will use the same request format as queryType
1-4, the results are returned in the stock XML format.

• Query request schema:

[Link]
• Response schema: [Link]
• Sample query string for multiple items. BN="9780375838415" or "9781416906162" or "9780375828072"
or "9780064437271" or "9780142401934" or "9780375822230" or "9780142500613" or "9780375802942"
or "9780698119826" or "9780142302026" or "9780618065677"
• When retrieving lists of EAN's, the results will be returned in the Web service's default sort order,
publication date, not the order listed in the query. Therefore, to display the results in the sequence that you
prefer, we suggest that you develop a way to create a temporary table with a list of the EAN's and a
sequence number, e.g., 9781616386108|01, 9780920668375|02, you would combine the quest results with
the temporary table to display the results in the preferred sequence.

queryType 9 Request Structure

This is the format for the real-time stock check request, queryType 9.
Parameter Req'd Description
queryType Y 9
query Y The query parameter should contain a string using the BN mnemonic, e.g.,
(BN="9780375838415"), (BN="9780698119826" or "9780142302026" or "9780618065677").
startRecord Y The record at which the response should start.
endRecord Y The record at which the response should end – maximum is 25 records.
liveUpdate Y "Y" – real-time inventory information.
dataRequest Y Must contain "STK".

Request examples:

REST request:
queryType=9&query=BN="9780385503952"&startRecord=1&endRecord=25&liveUpdate=Y&dataRequ
est=STK

SOAP request
<soap:Body>
<SearchRequestTypes12349Enhanced
xmlns="[Link]
<queryType>9</queryType>
<query>BN="9780385503952" or "9780964729230"</query>
<startRecord>1</startRecord>
<endRecord>25</endRecord>
<liveUpdate>Y</liveUpdate>
<dataRequest>STK</dataRequest>
</SearchRequestTypes12349Enhanced>
</soap:Body>

Ingram Web Service ImplementationGuide 14

Data Filtering
Ingram Web service database is very comprehensive and includes items that have not yet been released, are no
longer stocked, and even items that are out-of-print. In this section, you will find information about filtering and
sorting result sets with specific mnemonics and sort criteria. Themes, subject category, and other codes can be used
to filter searches to return a specific list of items.

Suggestion:
• Narrow search results – offer search options such as keyword, title, author, subject categories, or
product type
• Offer a browse option – by author, subject category, subcategory, product type (book, audio book,
video, etc)
• Sort options – by title, contributor (e.g., author), popularity (demand ranking), price, or allow the
customer to choose from a drop down of options. Please see Mnemonic Handling table for more
information.
• Add a status message to the item during the checkout or cart process, e.g., "predicted to ship",
"backordered", and designate not yet released items as "pre-orders"

Backorder Only Indicator

Search or filter items where Ingram will place an order with the supplier only when a backorder is specified for the
item.
• Composite / tag: <Backorder>
• dataRequest parameter: not applicable
• Search mnemonics: BOI
Query sample
BOI<>"Y" and SRC<>"X" – return all active items that are not do not require a backorder.

Composite / tag
<Backorder>N</Backorder>

Database Source
Ingram Web service contains three sources of data, which are updated nightly; Ingram, Spring Arbor, and extended,
each are described in more detail below. The data source can be filtered using the source mnemonic (SRC). In
addition, the <Source> tag is returned in all queryType response formats.

Ingram (<Source>S</Source>), The Ingram data source contains items that are currently available or active in
the Ingram Distribution Centers. To search all active Ingram and Spring Arbor items, add the source mnemonic,
(SRC="S" and SRC="A") or (SRC<>"X") to all of your queries.

Spring Arbor (<Source>A</Source>), Spring Arbor (SA) is a division of Ingram that distributes to the
Christian market. To search all Christian market approved items – add the source mnemonic (SRC="A") to your
queries. As an alternative, all SA items have a <SpringArbor> tag, which can be searched using the Spring
Arbor division flag (SADF) mnemonic – to include all SA items, add (SADF="Y") or to exclude items, add
(SADF<>"Y").

Extended (<Source>X</Source>), Items in the extended data source are still available in the industry, however
they are no longer carried by Ingram. To search all items in the extended database, add (SRC="X") to your
queries.

• The <Ingram> composite and elements under this composite will not be present for items in the
extended data source.
• Composite / tag: <Source>
• dataRequest parameter: not applicable
• Search mnemonic: SRC

Ingram Web Service ImplementationGuide 15

 Query sample
SRC<>"X" – return all active items.

Composite / tag
<Source>S</Source>

Display Flag
The Display flag indicates that the item is a display and contains multiple items that are purchased together but are
meant to be sold separately. Consumer oriented databases or Web sites may choose not to show these items. You
can use the DF mnemonic to filter these items from your item offering, e.g., DF<>"Y". In addition, you can use the
<DisplayType> tag in the <Logistics> composite to identify the type of display, e.g., "Dump (Floor)". The
<Logistics> data requires additional subscription access.

• Composite / tag: <Display>

• dataRequest parameter: not applicable
• Search mnemonic: DF
Query sample
DF<>"Y" and SRC<>"X" – return all active items that are not a display.

Composite / tag
<Display>N</Display>

Language
The Ingram database contains items in English and an extensive list of other languages. You may wish to limit the
query results to a specific primary language, in this case, please use the content language (CL) mnemonic. The
search value is case sensitive and the wildcard is acceptable, e.g., search for English items, (CL="English"), English
items using a wildcard (CL="Eng*"), Spanish items, (CL="Spanish").

• dataRequest parameter: not applicable

• Search mnemonic: CL
Query sample
CL="Eng*" and SRC<>"X" – return all active items that have English as the primary
language

Composite / tag
L E li h /L

Price and Discount

The price and discount will be returned on all Ingram and Spring Arbor database items (<Source>S</Source> or
<Source>A</Source>). The discount tag <Discount> may contain alpha values, "REG", "NET" or "LOW". "REG"
is a standard trade discount, which is defined by your supplier terms of sale.

You may wish to filter or display items with specific prices or discounts.
o Price equal to $20 – (PR="20.00")
o items with discount of "REG" or higher – ((DP="REG") OR (DP="40") OR (DP="50") OR ….))

Please note: "REG" is a standard trade discount, which is defined by your supplier terms of sale. Please contact
customer care or your Ingram sales representative for more information on your specific terms.

• Composite / tag:
• dataRequest parameter: not applicable
• Search mnemonic: PR, DP

Ingram Web Service ImplementationGuide 16

 Query sample
PR<"20.00" and SRC<>"X" – return all active items with a price less than $20.00

Composite / tag
<IngramPrice>13.95</IngramPrice>
<Discount>REG</Discount>

Publication Date / Release Date and On Sale Date

• The publication date or release date is that data in which the item was or is due to be published. If the
publisher only supplies a month and year as the publication date, Ingram will populate the day value
with the first day of the month or, if present, Ingram will mirror the date specified in the on sale date
tag. Use to the publication date to sort new items to the top of a selection list, search for items that
have not yet been published, or have a future publication date, e.g., PD>"20130401", or PD="201304",
or PD="20130401::::20131231"
• Use the on sale date when determining availabiltiy, e.g., RDT="
• Valid search string format: YYYYMMDD
• Composite / tag:
o Publication date <PubDate>092021</PubDate> (please note: the response format is
MMYYYY)
o On sale date <OnSaleDate>12312013</OnSaleDate> (please note: the response format is
MMDDYYYY)
• dataRequest parameter: not applicable
• Search mnemonics: PD, RSD
Query sample
Publication date: RD="201304", or RD="20130431", or RD="201304::::201305"
On sale date: RDT="20101231", RDT>="20101231", RDT = "201101::::201106"

Composite / tag
<PubDate>011993</PubDate>
<OnSaleDate>11052013</OnSaleDate>

Restricted Items
The restricted flag indicates if an item has imposed restrictions limiting the sale to certain geographical areas or
market types. If more than one restriction applies to any one item, the higher priority code is supplied. The tag is
only supplied when a restriction exists.

• Composite / tag: <RestrictedFlag>

• dataRequest parameter: not applicable
• Search mnemonics: RF
Query sample
(RF<>"P" or RF<>"E" or RF<>"D" or RF<>"L" or RF<>"V") and SRC<>"X" – return all
active items that are not restricted for sale.

Composite / tag
<RestrictedFlag>Not avail to all cust</RestrictedFlag>

Return Date and Return Indicator

The Ingram Web service provides a returnability indicator and a return by date.
• Valid search string format: YYYYMMDD
• Composite / tag: <Source>
o Return Indicator <ReturnCode>Y</ReturnCode>
o Return by <ReturnBy>20130228</ReturnBy>(please note: the response format is
YYYYMMDD)

Ingram Web Service ImplementationGuide 17

 • dataRequest parameter: not applicable
• Search mnemonic: RD
Query sample
RD="201304", or RD="20130431", or RD="201304::::201305"

Composite / tag
<ReturnCode>Y</ReturnCode>
<ReturnBy>20130228</ReturnBy>

Ingram Web Service ImplementationGuide 18

Popular Mnemonics
Binding Type
• Composite / tag: <Binding>
• dataRequest parameter: not applicable
• See mnemonics: BND
Query sample
BND="hardcover" and SRC<>"X" – returns all active items with a binding = hardcover.

Composite / tag
<Binding>Hardcover</Binding>

Contributor
Search for items for a specific contributor (author, editor, actor, etc.).
• When using the CO and CORCO mnemonics, use "Last name, First name, middle initial format.
• KWCO searches for keywords in the contributor name field.
• Pull the Contributor ID from the <Book> composite and build a query using the CID mnemonic to
retrieve other items for the same contributor.
• Composite / tag: <Contributor>
• dataRequest parameter: not applicable
• See mnemonics: CO, KWCO, CORCO, CID
Query sample
(KWCO="Ian" and "McEwan") and SRC<>"X" – returns all active items where "Ian" and
"McEwan" are found anywhere in the contributor name field.

Composite / tag
<Contributor>
<Name>McEwan, Ian</Name>
<Role>Author</Role>
<ContribID>226180</ContribID>
</Contributor>

Features
Features are descriptive attributes of a product, e.g., "Illustrated", "Bilingual", "Textbook", "Decked Edges", etc.
• Items can have up to ten features assigned.
• Composite / tag: <Features>
• dataRequest parameter: not applicable
• See mnemonics: FE
Query sample
FE="Red Letter" and SRC<>"X" – returns all active items that have a feature = "red letter"

Composite / tag
<Features>
<Feature>Red Letter</Feature>
<Feature>Bookmark</Feature>
</Features>

Ingram Web Service ImplementationGuide 19

Inventory
The Ingram Web service includes inventory on hand and on order quantities that are updated nightly as well as real-
time inventory availability. The inventory data can be incorporated into your shopping process to show the
availability of the items when they are placed into the shopping cart.

Suggestions:
• Use the Web service to check the price, discount, and inventory availability when your customer
places an item in the shopping cart.
• We recommend that you use the Ingram FTP service to update inventory on a large number of items
and to use the Ingram Web service to update price, discount, and inventory availability on popular
items.
Inventory
• Each active Ingram distribution center has separate on hand and on order quantity mnemonics.
• All inventory mnemonics are configured as record filters.
• Zero (0) is the only valid search term for inventory mnemonics. Valid syntax for inventory query,
(OHC>0).
• The inventory mnemonics can be included in a "or" statement, e.g., (OHN>"0" or OHC>"0" or
OHE>"0" or OHD>"0"
• Filtering for items that have an on hand quantity greater than "0", may lead to an unsatisfactory
customer experience – as your offering will change frequently. It is recommended that you show all
items carried regardless of the inventory level (use the source mnemonic to pull your item offering)
and add a message to your customer regarding availability (e.g., "Available to ship", "Item is
temporarily out of stock", "Pre-Orders are now being taken", or "Reserve your copy today").
• You can use the on hand mnemonics, the real-time inventory option and the <OnSaleDate> tag to
determine if the item is available for shipment. However, this is not a guarantee that the item will ship.
• dataRequest parameter: not applicable
• Search mnemonics include: OHB, OHC, OHD, OHE, OHN, OOB, OOC, OOD, OOE, OON...
Query sample
(OHC>0) and ARC<>"X" – all active items that have an on hand quantity in the
Chamberbyrg, PA DC.

Composite / tag
<Stock>
<LaVergne>
<OnHand>0000000</OnHand>
<OnOrder>0006240</OnOrder>
</LaVergne>
<Chambersburg>
<OnHand>0000080</OnHand>
<OnOrder>0008000</OnOrder>
</Chambersburg>
<FtWayne>
<OnHand>0000000</OnHand>
<OnOrder>0008880</OnOrder>
</FtWayne>
<Roseburg>
<OnHand>0000000</OnHand>
<OnOrder>0008880</OnOrder>
</Roseburg>
<Allentown>
<OnHand>0000090</OnHand>
<OnOrder>0000000</OnOrder>
</Allentown>
<Fresno>
<OnHand>0000080</OnHand>
<OnOrder>0000000</OnOrder>
</Fresno>
<Fairfield>
<OnHand>0000080</OnHand>
<OnOrder>0000000</OnOrder>
</Fairfield>
</Stock>

Ingram Web Service ImplementationGuide 20

 Real-time inventory
• For queryTypes1-4, 6, and 9, please add liveUpdate="Y" to the query request to retrieve the real-time
inventory availability information. Please see the queryTypes section of this guide for more
information.
• The real-time inventory feature does have scheduled maintenance window. During these times, you
may experience a delayed response and will receive inventory numbers from the previous web service
update. Please program appropriately for these maintenance windows.
Day Duration
Monday–Friday 02:30am - 04:00am
Saturday 09:15pm - 11:59pm
Sunday 12:00am - 05:00am

Keyword
Search for query results matching specific keywords.
• The keyword indices in the Ingram database include single words, therefore the multiple words must
be joined with operators, e.g., (KWTI="harry" and "potter") or (KWTI="harry") and (KWTI="potter").
Please note: (KWTI ="harry potter") will yield zero (0) results.
• Composite / tag: various
• dataRequest parameter: not applicable
• See mnemonics: KW, KWTI, KWSU, KWSE
Query sample
(KW="harry" and "potter") and SRC<>"X"

KWSU=mystery

(KWTI="harry" and "potter") and SRC<>"X" – returns all active items where the title field
contains the keywords "harry" and "potter"

KWSE="harry potter"

Product Media and Format

Search or filter items based on the product classification or format.
• Media type, e.g., MT="Video", MT="Book", MT="Audio"
• Ingram product format, e.g., IFMT="Advent" and music product format, e.g., MUMT.
• Composite / tags: <ProductFormat>, <Format>, <Media>, and <ProductType>
• dataRequest parameter: not applicable
• See mnemonics: MT, IFMT, MUMT
Query sample
MT="Book" and SRC<>"X" – returns all active items with a media type = "Books"

Composite / tag
Books and Bibles:
<ProductFormat>Regular Hardback</ProductFormat>
<Media>Book</Media>

Music:
<Format>Album</Format>
<Media>Compact Disc</Media>

Gifts:
<ProductType>Accessories (Book & Bible)</ProductType>
<ProductFormat>Cards</ProductFormat>
<Media>Paper</Media>

Ingram Web Service ImplementationGuide 21

Title
Use these mnemonics to search for a word or multiple words that appear in the items title field.
• The KWTI and the TI mnemonics act the same and will search the <Title>, <edition>, and the
<series>.
• Use TTL to search just the title field.
• Composite / tag: <Title>
• dataRequest parameter: not applicable
• See mnemonics: TI, TTL, KWTI, TIW

Query sample
TTL="harry potter" and SRC<>"X" – return all active items that contain the search term in
the title field.

(KWTI="harry" and "potter") and SRC<>"X" – return all active items where the search
terms are found in the title, edition, and series name.

Composite / tag
<Title>Harry Potter and the Sorcerer's Stone</Title>

Ingram Web Service ImplementationGuide 22

Popular Data Elements
Audience
The audience data includes minimum and maximum age and grade, and audience rating.
Age Min / Max
• Composite / tag: <Age>
• dataRequest parameter: not applicable
• Search mnemonics: AAMI, AAMA

Grade Min / Max

• Composite / tag: <Grade>
• dataRequest parameter: not applicable
• Search mnemonics: AGMI, AGMA, GR

Audience Rating
This is the media Rating representing the intended audience for an item. The Motion Picture Association of
America (MPAA) or the Entertainment Software Rating Board (ESRB) typically assigns this data to movies or
video game items, e.g., "E" – Everyone, "PG" - Parental Guidance suggested.
• Composite / tag: <AudienceRating>
• dataRequest parameter: not applicable
• Search mnemonics: AR
Composite / tag
<Audience>
<Age>
<Min>NA</Min>
<Max>NA</Max>
</Age>
<Grade>
<Min>NA</Min>
<Max>NA</Max>
</Grade>
<AudienceRating>PG</AudienceRating>
</Audience>

Awards
The Ingram Web service offers award data on awarding winning item for various genres in the book, music, and
video industries from around the world, including major awards like the National Book Award, Pulitzer Prize,
American Music Awards, Parents Choice, and many others. This data includes the winners, nominees and honorees
along with the award name, type, category, and year the award was presented.

Generally, awards are not included until they have been in existence for three or more years. When an award is
established and deemed valuable, the historical awards information is added to the database.

Most awards are for bound or recorded audio books. However, a few of the major awards for movies and music are
also captured.

There are two unique factors for movie and music awards:
1. The awards that go to a movie are frequently not available at the time the award is awarded because the
DVD has not yet been released. Ingram reviews such awards and categories every six months in order to
link award data to these late-releasing items.
2. Many are awarded to individuals (actor, director, performer), not to the creative content, e.g., most Oscars
go to individuals not the movie. At this time, this award data is not included.

Award data is searchable by a code that represents the award name for query types 1-4, using the AWD mnemonic,
e.g., AWD="1" for Caldecott Medal. In addition, to the ability to retrieve award data in the queryType 5 results,
please add "AWD" to the dataRequest element.
• Composite / tag: <Award>

Ingram Web Service ImplementationGuide 23

 • dataRequest parameter: AWD
• Search mnemonics: AWD
Query sample
AWD="19" and SRC<>"X"

Composite / tag
<Award>
<Name>National Book Critics Circle Award</Name>
<Type>Winner</Type>
<Category>Fiction</Category>
<BeginningYear>2002</BeginningYear>
<EndingYear>2002</EndingYear>
</Award>

Descriptions
The description text consists of contributor biographies, jacket descriptions, and item descriptions that are available
in the database. This data may contain HTML tags, e.g., <BR>, <P>, <I>, etc. Each description is described below.
The annotation descriptions are returned in query types 1-6 responses for all users. All other descriptions can be
retrieved using enhanced data query, queryType 5, for all users. We recommend that you use the Publisher
Marketing as your primary description and fill in with the others descriptions.

Annotations
Annotations are gathered from several sources, primarily within Ingram. The publicity and other time-
sensitive information are removed, leaving a brief description of the item. The <Annotation> is returned in
all queryType 1-6 responses for all users.

• Composite / tag: <Annotation>

• dataRequest parameter: not applicable
• Search mnemonics: not applicable
Composite / tag
<Annotation>This bestseller, from the author of "The Notebook" and "Message in a Bottle,"
is now a major motion picture by Warner Brothers…</Annotation>

Contributor Biographies
This field contains a short biographical narrative about the contributor (author, editor, illustrator, etc.). This
data is only returned in the enhanced data query, queryType 5, dataRequest = "BIO"

• Composite / tag: <Contributor><Bio>

• dataRequest parameter: BIO
• Search mnemonics: not applicable
Composite / tag
<Contributor>
<Name>Sparks, Nicholas</Name>
<Role>Author</Role>
<Bio>NICHOLAS SPARKS is the author of the #1 New York Times bestsellers The Rescue
and Nights in Rodanthe, as well as The Notebook,… </Bio>
</Contributor>

Jackets
The jacket flap and back descriptions are supplied by the publisher and represent the text found on the front
flap or back of a book. <JacketDescriptionFlap> and <JacketDescriptionBack> are returned in the enhanced
data query, queryType 5.

• Composite / tag: <JacketDescriptionFlap> and <JacketDescriptionBack>

• dataRequest parameter: JF, JB

Ingram Web Service ImplementationGuide 24

 • Search mnemonics: not applicable
Composite / tag
<JacketDescriptionFlap>Though he may not speak of them, the memories still dwell inside
Jacob Jankowski's ninety-something-year-old mind...</JacketDescriptionFlap>

<JacketDescriptionBack>There was a time when the world was sweeter...when the women
in Beaufort, North Carolina, wore dresses, and the men donned
hats...</JacketDescriptionBack>

Publisher Marketing
The Publisher Marketing description consists of descriptive copy that appears in publisher catalogs and
flyers. <PublisherMarketing> is returned in the enhanced data query, queryType 5, dataRequest = "PM"

• Composite / tag: <PublisherMarketing>

• dataRequest parameter: PM
• Search mnemonics: not applicable
Composite / tag
<PublisherMarketing><P>Following up on the enormous success of the "Journeys of a
Lifetime "series of travel gift books, National Geographic bring you "100 Countries, 5000
Ideas," a large-format, lavishly illustrated, softcover travel planner…PublisherMarketing>

Item Identifiers
Item Indentifies are unique alphanumeric codes that are assigned to each item. Ingram uses the EAN as the primary
key, so it will be available on all items in the database.

There are three Item Identifier mnemonics available:

• BN – International Standard Book Number (ISBN), use the BN with query types 1- 4, 8 and 9 to
search all three Item Identifier fields, ISBN, EAN, UPC.
• IC – Item Code, use the IC mnemonic with query types 1- 4, and 8 to search all three Item Identifier
fields, ISBN, EAN, and UPC.
• UPC – Universal Product Code, use UPC with query types 1- 4, and 8 to search only the UPC field.
• Search mnemonics: BN, IC, UPC
Composite / tag
<ISBN>059035342X</ISBN>
<EAN>9780590353427</EAN>

Images
The Ingram Web service provides images in three sizes, measured in pixels, 60, 94, and 187, which are accessed
using a URL. The URL's are encrypted and will expire. Caching the URL's is permitted within your license
agreement. All items will have at least one image URL, however, not all items have an image. For items that do not
have an image, Ingram will send a URL that will display "Image Currently Not Available" and the image indicator
tag value will be "N".

Caching images
Though it is possible to make several query requests in succession to get the images for a selection list or
large number of items, it could put a strain on the server and provide unsatisfactory results (e.g., page load
is very slow). This will also increase your usage, which will result in a higher subscription charge. As an
alternative to pulling images for every item and every query request, we suggest that you cache the images
for a limited period, refreshing at an interval that best fits your business requirements, e.g., seven days, 30
days, 60 days, etc. Image size varies, e.g., 187 pixel image = 15KB.

Another option is to purchase image files, store and maintain them on your server, please contact Ingram
for more information about either of these options.

Ingram Web Service ImplementationGuide 25

 Image Indicator
To determine if a cover image is available for an item or to replace our default image with one of your own,
Ingram has included an image indicator tag. This element is populated for all active items that contain an
Ingram composite. <Ingram><ImageIndicator>Y</ImageIndicator></Ingram>

If an image is not available, you will receive a URL to our default image, "Image Currently
Not Available". The length and width dimensions of the default image are 60 x 94 pixels.

Image URL
• An encrypted URL is provided for the images that are available for an item in the Default Image
results for query types 1-6.
• The URL will expire, therefore, we recommend a periodic refresh of any cached image URL's.
• Image URL composite / tag:
o 60 pixel = <Image><IMG60>
o 94 pixel = <Image><IMG94>
o 187 pixel = <Image><IMG187>
• Image indicator composite / tag: <ImageIndicator>
• dataRequest parameters: IM60, IM94, IMG
• Search mnemonics: not applicable
Composite / tag
<Image>
<ImageIndicator187>Y</ImageIndicator187>
<IMG60>[Link]
GlJmySpXqJ5nKdprqnFCWvTXjx7CCzRQXWXzRlePZHSMwsaAInDUC2ot
W3FLsLhuld7bPG7wFCmoB98CLL2IJK7jIxajUjPVFYZgtExtVo4O9BNYhF
sXqDvQ21SwhAay4Z69fx90yA059oumJy99qzxz/2NwFbo/OpaKwLQLk
Ro=&size=60</IMG60>
<IMG187>[Link]
GlJmySpXqJ5nKdprqnFCWvTXjx7CCzRQXWXzRlePZHSMwsaAInDUC2ot
W3FLsLhuld7bPG7wFCmoB98CLL2IJK7jIxajUjPVFYZgtExtVo4O9BNYhF
sXqDvQ21SwhAay4Z69fx90yA059oumJy99qzxz/2NwFbo/OpaKwLQLk
Ro=</IMG187>
</Image>

<Ingram>
<ImageIndicator>Y</ImageIndicator>
</Ingram>

Leading Articles
Titles with a Leading Article begin with "The", "A", "And", etc (e.g., The Great Gatsby, The Guide to, A Guide
To…). If the title contains a leading article, the tag, <TitleLeadingArticle>, will be returned in the result set. You can
concatenate the values in the <Title> and <TitleLeadingArticle> tags together to form the complete title,
e.g., <TitleLeadingArticle>The</TitleLeadingArticle> <Title>Great Gatsby</Title> = "The Great Gatsby". When
searching by title (TTL, TI, or KWTI mnemonics), your query does not need to include the leading article, e.g.,
TTL="Great Gatsby".

• Composite / tag: <TitleLeadingArticle>

• dataRequest parameter: not applicable
• Search mnemonics: not applicable
Composite / tag
<TitleLeadingArticle>The</TitleLeadingArticle>
<Title>Great Gatsby</Title>

Ingram Web Service ImplementationGuide 26

Logistics
The logistics composite contains data elements that are related to an inventory management processes, e.g., country
of origin, harmonized codes, carton quantity, barcode on product indicator, and item dimensions (weight). In
addition, the logistics composite will only be available for items that are in the Ingram and Spring Arbor active
databases. Please contact Ingram for more information about adding this data selection to your subscription.

• Composite / tag: <Logistics>

• dataRequest parameter: LOGI
• Search mnemonics: COO, HSCD, BCI
Query sample
COO="HK" and SRC<>"X" – returns all active items that list Hong Kong as the country of
origin.

Composite / tag
<Logistics>
<CountryOfOrigin>HK</CountryOfOrigin>
<HarmonizedCode>4817.20.0000</HarmonizedCode>
<Barcode>N</Barcode>
<MediaMail>N</MediaMail>
<CartonQuantity>48</CartonQuantity>
<Units>48</Units>
<Dimensions>
<Weight>0.35</Weight>
<Length>4.16</Length>
<Width>3.49</Width>
<Height>0.78</Height>
</Dimensions>
<Display>Y</Display>
<DisplayType>Dump (Floor)</DisplayType>
</Logistics>

Reading Programs
Reading Programs were originally developed to facilitate the teaching of reading to children. The reading program
data can be used to identify books within a given students reading ability and interest level. We have added four
Reading Programs to the Ingram Web service, they are; Renaissance Learning Accelerated Reader, Scholastic
Reading levels, Guided Reading levels, and Lexile.

Reading program data included:

• Accelerated Reader Interest Level (e.g., LG)
• Accelerated Reader Reading Level (e.g., 3.50)
• Accelerated Reader Point Value (e.g., 0.5)
• Accelerated Reader Quiz Number (e.g., 0000005488)
• Accelerated Reader Quiz Name (e.g., "Amelia Bedelia's First Day of School")
• Lexile Code (e.g., AD)
• Lexile Reading Level (e.g., 0680)
• Guided Reading Level (e.g., B)

The reading program data is searchable in query types 1-4 and is returned in queryType 5. The search
mnemonics allow you to retrieve data for a specific reading program, point value, quiz number, interest,
reading, or audience level. The reading program data is only available for users subscribing to this data.
Please contact Ingram to subscribe to the reading program data.

• Composite / tag: <ReadingPrograms>

• dataRequest parameters: RP
• Search mnemonics: ARIL, ATOS, ARPV, ARQZ, LXCD, LRL, GRL

Ingram Web Service ImplementationGuide 27

 Composite / tag
<ReadingPrograms>
<AcceleratedReaders>
<AcceleratedReader>
<InterestLevel>LG</InterestLevel>
<ReadingLevel>3.50</ReadingLevel>
<PointValue>0.5</PointValue>
<QuizNumber>0000005488</QuizNumber>
</AcceleratedReader>
</AcceleratedReaders>
<ScholasticReadingCounts>
<ScholasticReadingCount>
<InterestLevel>K-2</InterestLevel>
<ReadingLevel>3.39</ReadingLevel>
</ScholasticReadingCount>
</ScholasticReadingCounts>
<Lexile>
<LexileLevel>0680</LexileLevel>
<LexileCode>AD</LexileCode>
</Lexile>
<GuidedReadingLevel>B</GuidedReadingLevel>
</ReadingPrograms>

Review Data
Ingram Web service provides data on items that have been reviewed by various sources, including book review
citations, quotes, and full text reviews. The reviews are typically written around the time the item was released or
published are the review data can be used for evaluating items for purchase or to create marketing around a specific
item or review source.
Review Text
The book review texts are returned in the enhanced data query (queryType 5) results and are available for
users subscribing to this data. Please contact Ingram to subscribe to the book review text.

• dataRequest parameters: ReviewSources_Text.csv

• Search mnemonics: not applicable
Composite / tag
<Review>
<ISBN>9780439023511</ISBN>
<EAN>9780439023511</EAN>
<ReviewSource>Horn Book Magazine</ReviewSource> (Review Text Source)
<ReviewDate>20101101</ReviewDate> (Date Review was published)
<ReviewText>Katniss has been spirited away from the carnage of the recent Quarter
Quell (see Catching Fire, rev. 9/09) to District 13, thought to have been destroyed
years ago, but very much alive and kicking…</ReviewText>
<\Review>

Review Citations
The review citations composite contains citations for book review text that have appeared in a variety of
print and online sources, e.g., newspaper, magazine, or journal. The review citations composite includes the
review source, e.g., Time Magazine, issue date, e.g., 20011119, and any attributes related to the review,
e.g., "starred" (highly recommended).

Review citations are returned in the results for query types 1-6 and are searchable using a few mnemonics.
The search mnemonics allow you to retrieve data for a specific source, for a period of time, and limit
results to items that are highly recommended by the review source, e.g., Publisher Weekly, 2001, starred
review.

Here are two examples;

1. (RSDT="PW|2001" and RA="Starred"),
2. (RSS="PW|starred" and RVDT="2001*"). The RVDT mnemonic allows range filters so you can
Comment [jaf1]: 9/6/2012: jf - range filter not
search several years, e.g., RVDT="20000912::::20050912". working. Sent an email to Terry Gregson to review.

Ingram Web Service ImplementationGuide 28

 • Composite / tag: <ReviewCitations>
• Search mnemonics : RSDT, RSS, RVDT, RA
• Code translation file: [Link]
Composite / tag
<ReviewCitation>
<Source>Publishers Weekly</Source> (Review Source)
<IssueDate>20011119</IssueDate> (Review Issue Date)
<Attribute>STARRED</Attribute> (Assigned Attribute, e.g., Starred – highly
recommened)
</ReviewCitation>

Review Quotes
The review quotes are returned in the enhanced data query (queryType 5) results.

• Composite / tag: <ReviewQuotes>

• dataRequest parameter: RQ
• Search mnemonics: not applicable
Composite / tag
<ReviewQuotes>"BITTERSWEET... A TRAGIC YET SPIRITUAL LOVE STORY". <P>--
Variety</ReviewQuotes>

Series
A series is defined as a sequence of books having certain characteristics in common that are formally identified
together as a group. A series can be organized in different ways, such as written by the same author, or marketed as
a group by the publisher.

Here some examples;

• Fiction genre: items with a common setting, story, set of characters or timeline, e.g., Summerside Press,
"Love Finds You", Beverly Lewis, "Seasons of Grace" or the "Star Wars" series.
• Non-fiction genre: items that have a common discipline, focus, approach, type of work, or geographic
location, e.g., Fodor's, "Full-Color Gold Guides", John Wiley & Sons, "Blackwell Philosophy & Pop
Culture" or Zondervan's, "Letters to God"

The Ingram Web service provides the ability to limit search by the series name and or number, e.g., Harry Potter,
book #7 (SE="Harry Potter" and SENB="7").

• Composite / tag: <Series>

• Search mnemonics: SE, SENB, KWSE
Composite / tag
<SeriesID>Harry Potter</SeriesID> (Series Name)
<SeriesNum>7</SeriesNum> (Series Number)

Subject Categories
Ingram offers a few subject category classification options; Book Industry Study and Communication (BISAC)
Subject Codes and Headings, Dewey Decimal, Library of Congress Subject Headings, and Ingram and Spring Arbor
proprietary subject category descriptions.

Suggestions:
• Show a list of major categories and allow the user to click (or use drop-down list) to select
subcategories
o major category = Fiction
 subcategory = Mystery

Ingram Web Service ImplementationGuide 29

 • Offer a feature to search or browse by Category, e.g., Fiction – (BSC="FIC*") / (BSU="Fiction*").
Please note: a search by major category may retrieve a very large result set which will affect the
ability to apply a sort to your query request. To narrow these results you may also offer browse by
subcategory, e.g., Fiction Mystery – (BSC="FIC022*") / (BSU="*Mystery*")

• Display the <MatchingRecs>745937</MatchingRecs> for each category and/or subcategory, e.g.,

o Fiction (745,937)
 Mystery (91,572)

Subject category quick reference.

Category name Example Search mnemonics
BISAC Subject Code FIC022040 BSC
BISAC Subject Heading Description Mystery & Detective - Women Sleuths BSU, BSD1, BSD2, BSD3
Dewey Decimal Classification (DDC) FIC DDC
Library of Congress Control Number (LCCN) PZ7.C6837
Library of Congress Subject Headings (LCSH) Interpersonal relations LSU
Ingram subject category Children's Books/Ages 4-8 Fiction IS
Spring Arbor product type Adult Book SAP
Spring Arbor subject category - Major Devotional SAP
Spring Arbor subject category - Minor Children's SAP
Theme Group Cultural Region THG
Theme Description Germany TH

Subject category types

Book Industry Study and Communication (BISAC) Subject Headings

Book Industry Study and Communication (BISAC) subject headings are a standard used throughout the
book industry to categorize books based on topical content, which can also determine where the item is
stored in a bookstore or categorized on a Web Site. For more information, please visit [Link].

In Ingram Web service, the BISAC subject code and heading groups are made up of a nine-character
alphanumeric code and a description. Each item can have up to six BISAC subject groups assigned. The
first group is the primary subject for the item. The BISAC subject code field, <BisacSubject><Code>, is
comprised of a three-digit alpha, BISAC major, and a six-digit numeric, BISAC minor, e.g., "FIC022040".

FIC022040
BISAC major BISAC minor
heading subheading

The BISAC major is the highest categorization value and the BISAC minor is a subheading which may
contain additional topic classification separated by a " | " (space Pipe space). e.g., "FIC022040" = "Fiction |
Mystery & Detective | Women Sleuths".

BISAC major BISAC minor – BISAC minor –

heading subheading #1 subheading #2

Fiction Mystery & Detective Women Sleuths

Ingram Web service offers a few mnemonics for searching the BISAC Subject Headings:

Ingram Web Service ImplementationGuide 30

 • Composite / tag: <BisacSubject>
• BISAC subject code = BSC, e.g., BSC="FIC022040" or BSC="FIC*"
• BISAC heading keyword = BSU, e.g., BSU="Mystery"
• Search mnemonics: BSC, BSU, BSD1, BSD2, BSD3
Query sample
BSC="FIC* and SRC<>"X" – returns all active items with the major BISAC major= Fiction.

Composite / tag
<BisacSubject>
<Code>FIC022040</Code>
<Description>Fiction | Mystery & Detective | Women Sleuths</Description>
</BisacSubject>

Library of Congress Control Number and Subject Headings

Library of Congress Control Number (LCCN) and subject headings (LCSH) LSU,. Each item can have up
to 10 LC Subject Headings.

• Composite / tag: <LCCN> and <LCHeading>

• dataRequest parameter: not applicable
• Search mnemonics: LSU
Query sample
(LSU="Country Life" and LSU="England")

Composite / tag
<LCSubjects>
<LCCN>2001044291</LCCN>
<LCHeading>
<Description>Country life</Description>
<Description>Domestic fiction</Description>
<Description>England</Description>
<Description>Ex-convicts</Description>
<Description>Guilt</Description>
<Description>Psychological fiction</Description>
<Description>Sisters</Description>
<Description>Teenage girls</Description>
</LCHeading>
</LCSubjects>

Proprietary Subject Categories

We offer proprietary subject categories for both the Ingram and Spring Arbor (Christian) markets. Each
iteam can have one Ingram subject and Spring Arbor product type and multiple Spring Arbor subject
categories assigned.

• Composite / tag: <IngramSubject> and <SASubjects>

• dataRequest parameter: not applicable
• Search mnemonics: IS, SAP

Ingram Web Service ImplementationGuide 31

 Query sample
IS="mystery" and SRC<>"X"
SAP="Spirituality" and SRC<>"X"

Composite / tag
<IngramSubject>Fiction - Historical</IngramSubject>

<SASubjects>
<SASubject>FICTION, CHRISTIAN</SASubject>
<SASubject>ROMANCE FICTION - FICTION SECONDARY CATEGORY
ONLY</SASubject>
</SASubjects>
<SAProductType>Adult Books</SAProductType>

Themes
Themes contain subject-like terms that can be used to limit searches or to create valuable, targeted, or
seasonal merchandising programs. With this data, you can group items with similar themes.

• Theme composite / tag: <Theme>

• Theme dataRequest parameter: not applicable
• See mnemonic: TH, THG
Query sample
THG="Chronological Period" and TH="1950" and SRC<>"X"

Composite / tag
<Theme>
<Group>Chronological Period</Group>
<Description>1950-1999</Description>
</Theme>
<Theme>
<Group>Demographic Orientation</Group>
<Description>Small Town</Description>
</Theme>

Theme examples:
Theme Group (THG) Theme (TH)
Cultural Region Germany, Ireland, Latin America
Demographic New York, Western Europe, New England
Event Graduation, Holiday, Back to School, Wedding
Holidays Mother's Day, Easter, Christmas, Cinco de Mayo
Religious Orientation Jewish, Christian, Taoism, Catholic, Buddhist
Topical Family, Friendship, Holocaust, Civil War, Ecology

Ingram Web Service ImplementationGuide 32

Search Mnemonics
The following list of mnemonics and descriptions are in alphabetical order by mnemonic. The Reference files are available via a text file or you can automate the
process using the DocumentMnemonic procedure. (alphabetical by Mnemonic)
Mnemonic Mnemonic Name Description Reference File XML Tag Query Examples
AAMA Audience Age - Maximum This is the maximum age of the intended <Audience> <Age> <Min> AAMA="12";
audience, e.g., 01 to 22 and NA. AAMA>"05"
AAMI Audience Age - Minimum This is the minimum age of the intended <Audience> <Age> <Max> AAMI="12";
audience, e.g., 00 to 22, NA and UP. AAMI>"05"
AC Accessory Code The accessory code refers to the accompanying [Link] <Accessory> AC="Map";
product for items that consist of more than one AC="CDROM"
object, e.g., Book with CDROM, Book with
Plush.
ACI Accessory Indicator This indicates if an accessory, e.g., Book with N/A ACI<>"Y"
CDROM, accompanies an item. Use to find or
filter out items that have an accessory. Use "AC"
mnemonic to specify an accessory type.

"Y" = accessory accompanies primary item.

AE Abridged Edition Flag Used primarily for audio items to indicate <Abridged> AE="Y";
whether it is an abridged (condensed) version of AE<>"Y"
the original work.

"Y" – item is abridged.

AGMA Audience Grade - Maximum This is the maximum grade of the intended grlvl_CWSe.txt <Audience> <Grade> <Min> AMGA="06";
audience, e.g., "03 Preschool", "06 2nd Grade", AGMA= "06 2nd Grade"
etc
AGMI Audience Grade - Minimum This is the minimum grade of the intended grlvl_CWSe.txt <Audience> <Grade> <Max> AGMI="22";
audience, e.g., "03 Preschool", "06 2nd Grade", AGMI="22 Up"
etc.
AR Audience Rating <Audience><Rating> AR="PG"
ARIL Accelerated Reader Interest Level Renaissance Learning Accelerated Reader <AcceleratedReaders> ARIL="LG"
Interest level provides the grade level of interest <AcceleratedReader>
for a book. Please click on the link to learn more, <InterestLevel>
[Link]

Ingram Web Service ImplementationGuide 33

 ARPV Accelerated Reader Point Value The Accelerated Reader point value is used for <AcceleratedReaders> ARPV>"8"
rewarding the student. Searchable in query types <AcceleratedReader> ARPV="7.5::::9.0"
1 – 4 and the data is returned in query types 1 – 6. <PointValue>
This is a range filter which means that the greater
than (>) and less than (<) operators are valid with
whole number (no decimal), use the range (::::)
operator to search for a range with a decimal
value.

e.g.,
ARPV>"8" (searches for all greater than 8)
ARPV="7.5::::9.0" (searches for a range between
7.5 and 9.0, inclusive)

ARQZ Accelerated Reader Quiz Number Accelerated Reader quizzes are used to test the <AcceleratedReaders> ARQZ="86513"
students reading comprehension before awarding <AcceleratedReader> ARQZ<>"86513"
the AR points. Use with equals (=) or no equal <QuizNumber>
(<>) operators. Searchable in query types 1 – 4
and the data is returned in query types 1 – 6.
AT AuthorTitle Combines first four characters of author and first various AT="ROWLHARR"
four characters of item.
ATOS Accelerated Reader Reading Level The Accelerated Reader reading level is the <AcceleratedReaders> ATOS >"7"
equivalent grade level of text for a book. The first <AcceleratedReader> ATOS ="7.8::::8.5"
number is the grade and the number after the <ReadingLevel>
decimal is the month of the school year.
Searchable in query types 1 – 4 and the data is
returned in query types 1 – 6. This is a range filter
which means that the greater than (>) and less
than (<) operators are valid with whole number
(no decimal), use the range (::::) operator to
search decimal values.

e.g.,
ATOS >"7" (searches for all greater than 7)
ATOS <"10" (searches for all less than 10)
ATOS >"7.8" invalid - must use the range (::::)
operator
ATOS ="7.8::::8.5" (searches for a range
between 7.8 and 8.5, inclusive)

AWD Award Description Award name given to the specific award by the <Award> AWD="Pulitzer"
awarding organization.
BM Bible Binding Material Binding materials used for Bibles. Search values [Link] <BibleDetail> BM="Leather";
must match case in code table. <BindingMaterial> BM="Bonded Leather"
BN ISBN or EAN European Article Number (EAN) or International <EAN>; BN="1561582921";
Standard Book Number (ISBN/ISBN-10). <ISBN> BN="9781561582921"
Searches EAN, ISBN, UPC, and SKU fields.

Ingram Web Service ImplementationGuide 34

 BND BISAC Binding Type BISAC (Book Industry Standards And [Link] <Binding> BND="Paperback"
Communications) is a committee of the Book (BND="Paperback" or
Industry Study Group binding type. "Hardcover")
BO Bible Organization Search values must match case in code table. [Link] <BibleDetail> BO="Chronological";
<BibleOrg> BO="Parallel Bible"
BOI Backorder Only Indicator This indicator is used to indicate those items, <Backorder> BOI="Y"
which require a backorder to be placed which will
initiate an order to the publisher or supplier.

"Y" – backorder is required for ordering if on

hand quantity = '0'.
BP Bible Portion Portion of the Bible included in the item. Search [Link] <BibleDetail> BP="Old Testament*";
values must match case in code table. <BiblePortions> BP= "Luke & Acts"
<Portion>
PS Bible Print Size Actual size of the print of the item. <BibleDetail> BPS="Large"
<PrintSize> BPS="SuperGiant"
Valid Search = Returned in results
"Normal" = up to 10.9 point
"Large" = 11 - 13.5 points
"Giant" = 13.5 - 15 points
"SuperGiant" = over 15 points
BSC BISAC Subject Category Code Subject category code, as defined by BISAC. <BisacSubject> <Code> BSC="BUS001510";
This mnemonic searches all subject category code BSC="BUS*"
fields. Each record can have up to eight subjects
assigned.
BSU BISAC Subject Category Description, Description of BISAC subject category code. <BisacSubject> BSU="Juvenile Fiction*"
Keyword This mnemonic searches all eight subject <Description>
category description fields assigned.
BSD1 BSD1 - Searches the first level of the BISAC <BisacSubject> BSD1="Fiction"
subject category. <Description>
BSD2 BSD2 - Searches the first and second level of the <BisacSubject> BSD2="Fiction | Mystery
BISAC subject category. <Description> & Detective"
BSD3 BSD3 – Search all three levels of the BISAC <BisacSubject> BSD3="Fiction | Mystery
subject category. <Description> & Detective | Women
Sleuths"
BT Bible Type Type of Bible, e.g., "application", "compact", [Link] <BibleDetail> BibleTypes> BT="Family"
"gift", "study". Search values must match case in <BibleType>
code table.
BV Bible Version Bible Translation. Search values must match case [Link] <Bible Detail> BV="New King James"
in code table. <Versions> <Version>
CBT BISAC Children's Book Type Specifies the specific book type for children's [Link] <ChildrenBT> CBT="Lift*";
books and some adult books, e.g., "lift the flap", CBT="Pop Up"
"picture/wordless", "pop up". Search values must
match case in code table.

Ingram Web Service ImplementationGuide 35

 CCD Concordance A Bible concordance is an index to the Bible - an <Bible Detail> CCD="Y";
alphabetical list of words that link the reader to a <Concordance> CCD<>"Y"
passage in the Bible where the word occurs.

"Y" – Concordance is listed as included.

CID Contributor ID Code Use to find all items by same author (not just <Contributor> <ContribID> CID="447501"
authors with the same name). For example, you
could have a link to "other items by this author"
which will generate a search with this ID number.

Use the contributor ID in the <Book> composite

to query other items for the same contributor
using the contributor ID / CID mnemonic.
CL Content Language The content language in which a item was [Link] <Language> CL="Spanish"
created. Search values must match case in code
table.
CLR Bible Binding Color External color(s) of item. Search values must [Link] <BibleDetail> CLR="Blue"
match case in code table. <Color>
CMTA CMTA Subject Category Subject as defined by, the Christian Music Trade [Link] <CMTASubjects> CMTA="Classical"
Association (CMTA). Search values must match
case in code table.
CMA1 CMTA Subject Category, Level 1 CMA1 – Search the first level of CMTA [Link] <CMTASubjects> CMA1="Urban/R&B"
Subjects.
CMA2 CMTA Subject Category, Level 2 CMA2 – Search the 1st and 2nd levels of CMTA [Link] <CMTASubjects> CMA2="Urban/R&B |
Subjects. Gospel"
CO Contributor Name The contributor is the editor, author, illustrator, <Contributor> <Name> CO="LaHaye";
for the item. Format: last name, first; searches all CO="LaHaye, Tim";
contributor fields. There can be up to ten CO="LaHaye, T*"
contributors per item.
CORCO Contributor and Role A way to combine a contributor role, e.g., editor, CORCO_codes.txt <Contributor> <Role> CORCO="A|O'Conner"
author or illustrator, and a contributor name. will search for Author with
Format: contributor role followed by a pipe "|", last name O'Conner
then contributors last name; searches all
contributor fields; there can be up to ten
contributors per item.
CT Closure Type The type of closure specified for the item. Search [Link] <Bible Detail> CT="Zip"
values must match case in code table. <Closure>
DDC Dewey Decimal Classification Number The Dewey Decimal Classification (DDC) system <Dewey> DDC="891";
is the world's most widely used library DDC="891.7342"
classification system.

Ingram Web Service ImplementationGuide 36

 DE Desire Ranking The popularity of the item, based on Ingram N/A DE="Y"
demand. (there are no corresponding tag in the
response). You may also sort on desire ranking.

"Y" – Desired item.

DF Display Flag Indicates the item is a display and contains <Display> DF="Y" or DF<>"Y"
multiple items that are purchased together but are
meant to be sold separately. Online databases
may choose not to show these items.
DP Discount Percentage Discount percent (e.g., "35%") or standard [Link] <Discount> DP="REG";
discount represented by the codes "REG", "NET", DP="0";
or "LOW" (please contact Ingram customer care DP="35%"
to obtain your discounts for these values).
ED Edition Description Description of the edition, e.g., Revised, <EdDescription> ED="Revised";
Expanded; Four digit year supplied if item is an ED="*Anniv*";
annual or calendar, YYYY format. ED=" 2009"
FE Feature Additional characteristics of items. Searches [Link] <Feature> FE="Rehearsal Track"
across all ten feature fields.
GCL Gift Product Colors Searches across all three color fields. Search [Link] <ProductColor> GCL="Black"
values must match case in code table.
GPT Product Type -Ingram Proprietary product type. Search values must [Link] <ProducerType> GPT="Toys & Games"
match case in code table.
GR Grade Level Grade level for which a juvenile book is intended. gradelvl_CWS.txt <Grade> GR="02 Baby"
The data contains minimum and maximum <Min></Min>
grades, so this index allows you to search more <Max></Max>
easily by a single grade value. The grade value </Grade>
you search for will be included in the range
between the minimum and maximum grades
assigned to the item.

"NA Not Applicable" is returned if a grade is

unassigned.
GRL Guided Reading Level The Guided reading level provides an equivalent <GuidedReadingLevel> GRL="F"
reading level based on grade. </GuidedReadingLevel> (GRL="A" or GRL="B")
(searches for A or B)
HC Hymnal color Search values must match case in code table. [Link] <HymnalColor> HC="Black";
HC="White"
HT Height Thickness of the item in inches. Two decimals <Dimensions> HT="44"; HT<"20";
implied in search, decimal provided in response. <Height> HT="1000::::2000"
IC Item Code Searches EAN, ISBN, UPC, and SKU fields. <EAN>, <UPC> or <ISBN> IC="9780316769488"
IFMT Product Format - Ingram Proprietary product format. Search values must [Link] <Format> IFMT="Album";
match case exactly. IFMT="Cards"

Ingram Web Service ImplementationGuide 37

 IL Illustration Flag "Y" – item contains illustrations. <Illustrated> IL="Y"
"N" – no illustrations.
IMP Imprintable Flag This flag is only applicable for bibles. <Bible Detail> IMP="Y"
<Imprintable>
"Y" – item is eligible to for a personal imprinting
preformed by Ingram.
"N" – item is NOT eligible for imprinting.
IND Indexable Flag This flag is only applicable for bibles. <Bible Detail> IND="Y"
<Indexable>
"Y" – item is eligible to for indexing preformed
by Ingram.
"N" – item is NOT eligible for indexing.
IS Subject - Ingram Proprietary subject category. [Link] <IngramSubject> IS="Children's";
IS="Animals*"
IST Index Style This is the style of index. <IndexStyle> IST="TH"

Valid Code(s):
"TH" – Thumb index.
KW Keywords This searches an index of words from various KW="cat"
bibliographic fields for query types 1-4. Fields
include: title, publisher name, features, edition,
contributor, themes, BISAC categories, CPC
categories, Spring Arbor categories, series, LC
subject headings, binding, and format.
KWCO Contributor Keywords This searches keywords within the contributor <Contributor> KWCO="LaHaye"
fields. There can be up to ten contributors
assigned per item.
KWPU Publisher Keywords Keywords within publisher name only. <Publisher> KWPU="Random"
KWRL Label Keywords Keywords within label name only. <Label> KWRL="Daywind"
KWSE Keyword Series Keywords within the series name. <Series> KWSE="American Girl"
KWSU Keyword Subject Searches the following fields; proprietary product various KWSU="graduation"
type & categories, Library of Congress subject
heading, BISAC subject category description,
theme, and theme group.
KWTI Keyword Title Searches the title, edition, and series fields. various KWTI="blue" and "dog"
LN Length Length of item in inches. Two decimals implied <Dimensions> <Length> LN="932"; LN<"20";
in search, decimal provided in response. LN="800::::900"
LPF Large Print Flag "Y" – item is large print edition. <LargePrint> LPF="Y"
"N" – item is not large print.
LRL Lexile Reading Level The Lexile Framework® for Reading provides a <LexileLevel> LRL="0400";
common, developmental scale for matching LRL>"1600";
reader ability and text difficulty, [Link]. LRL="0200::::0300"

Ingram Web Service ImplementationGuide 38

 LSU Library of Congress Subject Heading Library of Congress subject heading. A single <LCHeading> LSU="Women detectives"
item can contain up to seven LC Subjects.
MMI Media Mail Indicator "Y" – item is eligible to ship via USPS Media <MediaMail> MMI="Y"
Mail.
"N" – item is NOT eligible.
Please note: The USPS defines the rules for the
use of Media Mail – please visit their Web Site
for more information, [Link].
MT BISAC Media Type Product media type, as defined by [Link]. [Link] <Media> MT="book"; MT="video
Field will display full text. Search values must product"
match case in code table.
MUMT Product Media Media format of the item, e.g., "audio", "compact [Link] <Media> MUMT="Compact Disc"
disc". Search values must match case in code [Link]
table.
OHB Allentown, PA On-Hand Quantity Quantity on hand in the specified distribution <Stock><Allentown> OHB>"0";
center. Quantity "0" is not indexed. <OnHand> OHB>="0"
* Please note that it is a Business
decision to shop from this alternate Use real-time inventory feature for available to
Distribution Center. sell quantity.
OHC Chambersburg, PA On-Hand Quantity See description above. <Stock><Chambersburg> OHC>"0";
<OnHand> OHC>="0"
OHD Ft. Wayne, IN On-Hand Quantity See description above. <Stock><FtWayne> OHD>0
<OnHand>
OHE Roseburg, OR On-Hand Quantity See description above. <Stock><Roseburg> OHE>0
<OnHand>
OHF Fairfield, OH On-Hand Quantity See description above. <Stock><Fairfield> OHF>"0";
<OnHand> OHF>="0"
* Please note that it is a Business
decision to shop from this alternate
Distribution Center.
OHJ Fresno, CA On-Hand Quantity See description above. <Stock><Fresno> OHJ>"0";
<OnHand> OHJ>="0"
* Please note that it is a Business
decision to shop from this alternate
Distribution Center.
OHN La Vergne, TN On-Hand Quantity See description above. <Stock><LaVergne> OHN>0
<OnHand>
OOB Allentown, PA On-Order Quantity Quantity on order in the specified distribution <Stock><Allentown> OOB>0
center. Quantity 0 is not indexed. <OnOrder>
* Please note that it is a Business
decision to shop from this alternate
Distribution Center..

Ingram Web Service ImplementationGuide 39

 OOC Chambersburg, PA On-Order Quantity See description above. <Stock><Chambersburg> OOC>0
<OnOrder>
OOD Ft. Wayne, IN On-Order Quantity See description above. <Stock><FtWayne> OOD>0
<OnOrder>
OOE Roseburg, OR On-Order Quantity See description above. <Stock><Roseburg> OOE>0
<OnOrder>
OOF Fairfield, OH On-Order Quantity See description above. <Stock><Fairfield> OOF>0
<OnOrder>
* Please note that it is a Business
decision to shop from this alternate
Distribution Center..
OOJ Fresno, CA On-Order Quantity See description above. <Stock><Fresno> OOJ>0
<OnOrder>
* Please note that it is a Business
decision to shop from this alternate
Distribution Center..
OON La Vergne, TN On-Order Quantity See description above. <Stock><LaVergne> OON>0
<OnOrder>
PD Publication Date Date in which the item was or is due to be <PubDate> PD="201104";
published or released. PD="201104::::201106"

PLP Publisher Price Publisher supplied price – may not match the <PubListPrice> PLP="17.95"
Ingram Price.
PR Price - Ingram Ingram suggested list price - the highest list price <IngramPrice> PR="17.95";
in any active DC. PR="10.50::::10.95"
PT Playing time Playing time in minutes. <PlayingTime> PT="45";
PT="45::::60"
PU Publisher Imprint Publisher name as shown on item. <Publisher> PU="Random*"
RA Review Attribute Refers to attributes assigned to a review. <ReviewCitation> RA="starred"
<Attribute>
"starred" = Starred or highly recommended.
RD Return Date This represents the last date an item can be <ReturnBy> RD="20110228";
returned to Ingram. This will return all items in RD="YYYYMMDD::::YY
the database with a return date that may not be YYMMDD
applicable to your item offering – use with the
source mnemonic to specify or filter for a specific
data source.

Ingram Web Service ImplementationGuide 40

 RDT On Sale Date This is the date that the publisher will allow the <OnSaleDate> RDT="20101231"
item to be sold to the public. Also known as RDT>="20101231"
"Street Date". Only a small percentage of items RDT = "201101::::201106"
are assigned an on sale date. To search by
publication date, use the PD mnemonic.

Search format = YYYYMMDD

Result format = MMDDYYYY
REF Reference Location This field indicates where any references are [Link] <RefLocation> REF="Side",
located on the page. Search values must match REF="Location Unknown"
case in code table.
RL Release Label The distributor of this item. [Link] <RecordLabel> RL="Sparrow Records"

Please note: The distributor and label may

contain the same data.
RLTR Red Letter The words spoken by Jesus Christ are printed in <Bible Detail> RLTR="Y"
red colored typeface. <RedLetter>

"Y" –The words spoken by Jesus Christ are in

red.
RF Restricted Flag This field indicates if an item has imposed [Link] <Ingram> <RestrictedFlag> RF<>"P";
restrictions limiting the sale to certain (RF<>"P" or RF<>"L");
geographical areas or market types. If more than (RF<>"Avail in USA &
one restriction applies, the higher priority most other countries")
restriction is supplied.
RSDT Review Citation Source and Issue Date This searches the review source and the issue <Source> <IssueDate> RSDT="BL|20100101";
date. The date is not required. RSDT="SPOR"

RSS Review Citation Source and Attribute The review source combined with the review <Source> <IssueDate> RSS="LJ|starred"
attribute. <Attribute>
RT Return Code Use with the return date mnemonic / RD or <ReturnCode> RT="Y"
<ReturnBy> value to determine returnability. RT<>"Y" or RT="N"

"Y" – Item is returnable.

"N" – Item is not returnable.
RVDT Review Citation Issue Date This will search all reviews within the date or <ReviewCitation> RVDT="20100614";
range specified. <IssueDate> RVDT="2011*";
RVDT="20000912::::2005
0912"
SADF Spring Arbor Division Flag Items approved by Spring Arbor for the Christian <SpringArbor> SADF="Y"
market. Same results as SRC="A".
SAP Spring Arbor Product Type & Subject Searches all Spring Arbor product types and <SAProductType> SAP="Video*" and
Category subject categories. Search values must match case SAP="Teaching Helps"
in code table.

Ingram Web Service ImplementationGuide 41

 SE Series Name Start of series name, e.g., "I Can Read", "Hardy [Link] <SeriesID> SE="Hardy*"
Boys". Series number, if assigned, is returned in
the response.
SENB Series Number This mnemonic allows searching for the series <SeriesNum> query example for Harry
number, when assigned to a book in a series. Potter book 7

SE="Harry Potter" and

SENB="7"
SRC Database Source "A" – Spring Arbor Active Database. <Source> SRC="S";
"S" – Ingram Active Database. SRC<>"X"
"X" – Extended Database.
TH Themes Specific Themes, such as the chronological [Link] <Theme> TH="19th Century"
period, or the geographic region, holiday, etc. <Description>
Amplifies the subject by identifying potential
audiences for the item. Each record can have up
to ten themes.
THG Themes Group Ingram theme data contains subject-like terms [Link] <Theme><Group> THG="Chronological
that are useful to limit searches. A general theme Period"
type or group paired with a more specific
description (see TH above).
TI Title Keyword The item title field contains data from a few various TI="Remains" and "Day"
fields. Therefore, this mnemonic with search the
title, edition description, and series name fields.
TIW Title - Beginning of title Searches the beginning of title - useful if title <Title> TIW="Thunder of Heaven"
contains a subtitle.
TS Title Status A code describing the current state of a item in <TitleStatus> (TS<>"OP" or TS<>"OI")
the publishing life cycle. Data supplied by the
Publisher and may not match the supplier status.
TTL Title Searches the item title field only. <Title> (TTL="Thunder" and
"Heaven")
UPC Universal Product Code A true 12-digit UPC. With this release the EAN <UPC> UPC="850411003028"
has an element of its own – so the UPC will
contain only a UPC.
VID Vendor ID Number Manufacturer's specific identification code for a <VendorStock> VID="SPD1179"
item.
WT Weight Weight of an item or package in pounds, with two <Dimensions> WT="162"; WT>"162";
implied decimals. Results will include the <Weight> WT="500::::1100"
decimal.

Ingram Web Service ImplementationGuide 42

Mnemonic Handling
The mnemonic handling table provides attributes for each mnemonic.

Column Descriptions
Book (1), Music (2), Gifts (3) & Bible (4)
These columns indicate whether the mnemonic is valid for each queryType.

Sort
This column specifies if the mnemonic can be used as a sort parameter.

Code Translation
This column indicates that the value that is queried is not equal to the value within the software. Therefore, a
translation is required to compensate. These translations can be retrieved using the document mnemonics operation:
[Link]

Document Mnemonics query structure:

REST request: mnemonic=string

SOAP request:
<soap:Body>
<DocumentMnemonics xmlns="[Link]
<mnemonic>string</ mnemonic>
</DocumentMnemonics>
</soap:Body>

Range Filter
This column denotes if an mnemonic has a Range Filter.
• Greater Than and Less Than queries are valid for these mnemonics only
• Use of a multiple Range Filter mnemonics are valid
o (LRL<"0400") and (PD>"20060101"))
• Use of Single Range Filter mnemonics are not valid
o ((LRL<"0400") or (LRL>"0400"))
• Range syntax is valid
o (LRL = "0200::::0300"); (PD = "200501::::200506")
• Inequality queries are not compatible
o (LRL<>"0400")

Ingram Web Service ImplementationGuide 43

Mnemonic Handling Table
Mnemonic Description Book (1) Music (2) Gifts (3) Bible (4) Sort Code Translation Range Filter Case Sensitive

AAMA Audience Age - Maximum Y Y Y Y N Y Y N

AAMI Audience Age - Minimum Y Y Y Y N Y Y N

AC Accessory Code Y N Y Y N N N Y

ACI Accessory Indicator Y Y Y Y N N N Y

AE Abridged Edition Flag Y N N Y N N N N

AGMA Audience Grade - Maximum Y Y N Y N Y Y N

AGMI Audience Grade - Minimum Y Y N Y N Y Y N

AR Audience Rating Y N Y Y N N N Y

ARIL Accelerated Reader Interest Level Y Y Y Y N Y N Y

ARPV Accelerated Reader Point Value Y Y Y Y N N Y N

ARQZ Accelerated Reader Quiz Number Y Y Y Y N N N N

AT Author Title Y N N Y N N N Y

ATOS Accelerated Reader Reading Level Y Y Y Y N N Y N

AWD Awards Y Y Y Y N Y N Y

BCI Barcode Indicator Y Y Y Y N N N N

BM Bible Binding Material N N N Y Y N N Y

BN ISBN or Item Code Y Y Y Y Y N N N

BND BISAC Binding Type Y N N Y N N N N

BO Bible Organization N N N Y N N N Y

BOI Backorder Only Indicator Y Y Y Y N N N Y

BP Bible Portion N N N Y N N N Y

Ingram Web Service ImplementationGuide 44

 BPS Bible Print Size N N N Y N Y Y N

BSC BISAC Subject Category Y N N Y N N N N

BSD1 BISAC Subject Description 1 Y N N Y N N N Y

BSD2 BISAC Subject Description 2 Y N N Y N N N Y
BSD3 BISAC Subject Description 3 Y N N Y N N N Y
BISAC Subject Category
BSU Y N N Y N N Y N
Description
BT Bible Type N N N Y N N N Y

BV Bible Version N N N Y N N N Y

CBT BISAC Children's Book Type Y N N Y N N N Y

CCD Concordance N N N Y N N N N

CID Contributor ID Code Y N N Y N N N N

CL Content Language Y Y N Y N Y N Y

CLR Bible Binding Color N N N Y Y N N Y

CMA1 CMTA Subject Category 1 N Y N N N N N Y

CMA2 CMTA Subject Category 2 N Y N N N N N Y
CMTA CMTA Subject Category N Y N N N N N N

CO Contributor Name Y Y Y Y Y N N N

COO Country Origin Y Y Y Y N N N N

CORCO Contributor and Role Y Y Y Y N N N N

CT Closure Type N N N Y N Y N Y
Dewey Decimal Classification
DDC Y N N Y N N Y Y
Number
DE Demand Ranking Y Y Y Y Y N N N

DF Display Flag Y Y Y Y N Y N Y

Ingram Web Service ImplementationGuide 45

 DP Discount Percentage Y Y Y Y N Y N Y

ED Edition Description Y Y Y Y N N N N

FE Feature Y Y Y Y N N N N

GCL Gift Product Colors N N Y N N N N Y

GPT Gift Product Type - Ingram N N Y N N N N Y

GR Grade Level Y N N Y N Y Y N

GRL Guided Reading Level Y Y Y Y N N N N

HC Hymnal color N Y N N N N N N

HT Height Y Y Y Y N N Y N

IC Item Code Y Y Y Y Y N N N

IFMT Product Format - Ingram N Y Y N N N N N

IL Illustration Flag Y N N Y N N N N

IMP Imprintable Flag Y N N Y N N N Y

IND Indexable Flag Y N N Y N N N Y

IPS Ingram Publisher Services Indicator Y Y Y Y N N N Y

IS Subject Category - Ingram Y Y N N N N N N

IST Index Style N N N Y N N N Y

KW Keywords Y Y Y Y N N N N

KWCO Keywords Contributor Y Y Y Y N N N N

KWPU Keywords Publisher Y N N Y N N N N

KWRL Keywords Label N Y N N N N N N

KWSE Keyword Series Y Y Y Y N N N N

KWTI Keyword Title Y Y Y Y N N N N

LN Length Y Y Y Y N N Y N

Ingram Web Service ImplementationGuide 46

 LPF Large Print Flag Y N N Y N N N N

LRL Lexile Reading Level Y N N Y N N Y N

LSU Library of Congress Subject Heading Y N N Y N N N N

MMI Media Mail Indicator Y Y Y Y N N N N

MT BISAC Media Type Y N N Y N Y N N

MUMT Product Media N Y Y N N N N Y

OHB On-Hand Quantity - Allentown, PA Y Y Y Y N N N N

On-Hand Quantity - Chambersburg,
OHC Y Y Y Y N N N N
PA
OHD On-Hand Quantity - Ft. Wayne, IN Y Y Y Y N N N N

OHE On-Hand Quantity - Roseburg, OR Y Y Y Y N N N N

OHF On-Hand Quantity – Fairfield, OH Y Y Y Y N N N N

OHJ On-Hand Quantity - Fresno, CA Y Y Y Y N N N N

OHN On-Hand Quantity - La Vergne, TN Y Y Y Y N N N N

OOB On-Order Quantity - Allentown, PA Y Y Y Y N N N N

On-Order Quantity - Chambersburg,
OOC Y Y Y Y N N N N
PA
OOD On Order Quantity - Ft. Wayne, IN Y Y Y Y N N N N

OOE On-Order Quantity - Roseburg, OR Y Y Y Y N N N N

OOF On-Order Quantity – Fairfield, OH Y Y Y Y N N N N

OOJ On-Order Quantity – Fresno, CA Y Y Y Y N N N N

OON On-Order Quantity - La Vergne, TN Y Y Y Y N N N N

PD Publication Date Y Y N Y Y N Y N

PLP Publisher List Price Y N N Y Y N Y N

PN Publisher Number Y Y Y Y N N N N

Ingram Web Service ImplementationGuide 47

 PR Price – Ingram Y Y Y Y Y N Y N

PT Playing time Y Y N Y N N Y N

PU Publisher Imprint Y N N Y N N N Y

RA Review Attribute Y N N Y N Y N Y

RD Return Date Y Y Y Y N N Y N

RDT On Sale Date Y Y N Y N N Y N

REF Reference Location N N N Y N N N Y

RF Restricted Flag Y Y Y Y N N N Y

RL Release Label N Y N N N N N N

RLTR Red Letter N N N Y N N N N

RSDT Review Citation Source and Date Y N N Y N Y N Y

Review Citation Source and
RSS Y N N Y N Y N N
Attribute
RT Return Code Y Y Y Y N Y N Y

RVDT Review Issue Date Y N N Y N N Y N

SADF Division Flag - Spring Arbor Y Y Y Y N Y N Y

SAP Product Type - Spring Arbor Y Y Y Y N N N N

SE Series Name Y Y Y Y N N N N

SENB Series Number Y Y Y Y N N N N

SRC Data Source Y Y Y Y N Y N N

TH Themes Y N N Y N N N N

THG Themes Group Y N N Y N N N Y

TI Keyword Title Y Y Y Y Y N N N

TIW Title - Beginning of title Y Y Y Y N N N Y

TS Title Status Y Y Y Y Y N N Y

Ingram Web Service ImplementationGuide 48

 TTL Title Y Y Y Y Y N N N

UPC Universal Product Code Y Y Y Y N N N N

VID Vendor ID Number N Y Y Y N N N N

WT Weight Y Y Y Y N N Y N

Ingram Web Service ImplementationGuide 49

Troubleshooting
The following are some troubleshooting tips that you might try before calling the Ingram integration team.

• Can't log in
o Please confirm that you are using the proper URL for your protocol. Using REST or SOAP (WSDL).
o Are you using the test or production server URL?
o Verify userName is correct for corresponding server.

• No results returned
o Check query structure.
o Check maintenance schedule.
o Call Ingram integration team to verify that the service is running.

• Images aren't appearing

o Are you using the test server? The test server will only contain a sample of available images.
o If you are using production – please contact Ingram; provide your account information and sample items (EAN's are also very helpful).

Error Messages
The following table containd specific error messages and their causes.
Error Message Description Category
"Y term" is not a valid value for query "X mnemonic" A code translation takes place for this query or there is code in place to restrict this Mnemonic
mnemonic to a specific set of values. The code entered is not a valid code. Handling
Authentication Failed Invalid userName. Query structure
Authentication Failed: Unauthorized Service User does not have access to the data that has been requested. Query structure
Connection denied Typically, this means that the Ingram Web service certificates have changed. The Web service
SSL certificates change periodically.
Error Parsing Query: Invalid "OR" Statement. Queries that would require two queries are not allowed, e.g., ((kw="dog" and BSC Query syntax
= "CRA043000") or (kw="cat" and BSC="STU026000")).

Error Parsing Query: Parenthesis Rule Violation. Unbalanced parenthesis – an Open parenthesis must be accompanied by close Query syntax
parenthesis, e.g., (kw=Harry produces this error.
Error parsing query: Please check that all parenthesis and quotes are Open parenthesis must be accompanied by close parenthesis, e.g., (RSDT="PW*") Query syntax
balanced. or (RSS="LJ*")).
Greater than query operator is not valid for query ("X mnemonic") The only valid search term for Inventory mnemonics, OHC, OHD, OHE, OHN, Mnemonic
unless search term is zero. OOC, OOD, OOE, and OON is zero. Handling

Ingram Web Service ImplementationGuide 50

 Greater than query operator is not valid for query ("X mnemonic"). Queries using the Greater than and Less than operators are only valid with Operator,
mnemonics that are configured for Range Filters. The following mnemonics are Mnemonic
configured for Greater than and Less than operators: GR, HT, LRL, PD, PLP, PR, Handling
PT, RD, RVDT, and WT.
Less than query operator is not valid for query ("X mnemonic"). Queries using the Greater than and Less than operators are only valid with Operator,
mnemonics that are configured for Range Filters. The following mnemonics are Mnemonic
configured for Greater than and Less than operators: GR, HT, LRL, PD, PLP, PR, Handling
PT, RD, RVDT, and WT.
Object reference not set to an instance of an object Invalid queryType. Query structure

Parameter is required queryType not specified or parameters passed do match queryType. Query structure

Please make sure that the double quote characters are balanced in unbalanced quotes, e.g., (KW="dog). Query syntax
number.
Query "X mnemonic" is not valid in this type of search. A mnemonics translation must be included in a Boolean search interface to be Mnemonic
valid with case 4 syntax. The mnemonics that are currently included in the existing Handling
Boolean search interface are BN, BND, BSU, CBT, CL, CO, CORCO, IC, KWPU,
KWRL, KWSE, KWTI, LSU, MUMT, PU, RL, SE, TH, THG, TI, and UPC.
Query ("X mnemonic") is invalid. The mnemonic listed in the error message is not a valid CWS mnemonic. Mnemonic
Handling

Query ("X mnemonic") is not valid for query type ("X Query Type"). See list of valid mnemonic and queryType combinations. Mnemonic
Handling

Query format is not valid for query type ("X Query Type"). When the query contains multiple mnemonics joined by 'or' statements. Boolean Operator,
queries are only valid in book searches, queryType 1, e.g., ((BN="rocketo*") or Mnemonic
(CO="rocketo*") or (KWTI="rocketo*") or (PU="rocketo*")). Handling

Query is too short. The query doesn't have an operator or the query began with "and", e.g., (kw"dog"), Operator
(and Harry and Potter and TS<>OP).

Query Parsing Error: Possible duplicate "And's" The query contains two AND's in a row, e.g., (kwti=yo and yo and tricks and and Query structure
TS<>OP).

Query Parsing Error: Possible duplicate or's The query contains two OR's in a row, e.g., (BN="1592650619") or or Query structure
(BN="0711216568").

Query segment has reached an excessive length. Please narrow your Query length is limited to 2048 characters. Query structure
terms and retry.

Ingram Web Service ImplementationGuide 51

 Search Query is Invalid Query structure is not correct. Query structure

Search query is invalid - no search term entered for query "X The query was incomplete, e.g., (kw=). Query structure
mnemonic".

Search query is invalid - use of the inequality operator is invalid for This query is Range Filter query - inequality queries are not compatible with Operator,
query "X mnemonic". Range Filter queries. This affects the following mnemonics: GR, HT, LRL, PD, Mnemonic
PLP, PR, PT, RD, RVDT, and WT, e.g., LRL<>0400 is not valid. Handling

Sort Field value ("sort Field") is not applicable. The requested sort field is not enabled for sorting. Mnemonic
Handling

This query combination is not valid. When using mnemonic "X We will allow Greater than and Less than operators, but not on the same term Operator,
mnemonic & " more than once, use the documented range format twice, which is how this would translate, e.g., "PD="200501::::200506". Mnemonic
where query terms are joined by "::::" Handling

UserName parameter is required Missing userName. Query structure

Please request a search interface to perform this type of query KWSU cannot be used with other KW query requests. Please change KWSU to a Mnemonic
specific subject category mnemonic, e.g., IS, BSU, BSD1, BSD2, BSD3, etc. Handling

Ingram Web Service ImplementationGuide 52

Frequently Asked Questions
This is a list of the common questions regarding the Ingram Web service.
Question Answer
How do we filter for items that require a backorder? Use the backorder indicator mnemonic, BOI="Y" = backorder required - see the
backorder only indicator mnemonic description for more information.
How do we block non-consumer items, like Publisher The display flag mnemonic denotes if an item falls into this category, e.g.,
Book Displays, Marketing packages, or multiple pack (DF<>"Y") – Adding this to your queries will retrieve all items that have a
items from my Web Site? display flag = "N".
How do we retrieve calendars from Ingram Web Calendars are a product or media type and can be requested using the media type
service? mnemonic. MT="calendar".
We would like to use our own Default Image - is there Yes, you can use the image indicator to determine if an image URL is available
a way to identify that an image is not available? for an item.
How is Demand Ranking determined? Desire is calculated using the current week's demand and the current month's
sales, less the previous five week demand and previous thirteen month's sales.
How do I filter for items with a price less than $15.00? Add the price mnemonic - (PR<"15.00") – to your query requests.
Can I filter for items that are currently available for You can use the on hand mnemonics, the real-time inventory option, and the
immediate shipment? <OnSaleDate> tag to determine if the item is available for shipment. However,
this is not a guarantee that the item will ship.

(OHN>"0" or OHC>"0" or OHE>"0" or OHD>"0" or OHB>”0”),

liveUpdate="Y" and <OnSaleDate> contains a date that is less than or equal to
the current date.

Please note: Filtering for items with on hand>"0" to build your item offering
may lead to an unsatisfactory customer experience – as your offering will
change frequently. It is recommend that you show all items carried regardless of
the inventory level (use the Source mnemonic to pull your item offering) and add
a status message to your customer regarding availability, e.g., "Available to
ship", "Item is temporarily out of stock", or "Reserve your copy today".
Can I send multiple sorts in one query? Yes, please see sortField for more information.
How do we determine if an item can be pre-ordered Use the publication date / PU and on sale date / RDT tag or mnemonic, the On
or has not yet released? hand mnemonics. The on sale date tag is only present if an "on sale date" has
been assigned by the publisher – therefore not all items will have this data.

• Interrogate the on hand quantity, publication date, and on

sale date fields
• (OHN="0" or OHE="0" or OHC="0" or OHD="0" or
OHB=’0”) and PD>"YYYYMM" and
RDT<"MMDDYYYY"
• Then, investigate the <OnSaleDate>tag in the results to
ensure that the date is in the past,
<OnSaleDate><"MMDDYYYY" = where the date is less
than the current date

On sale date items:

You may find on hand quantities greater than zero for items with a street date/on
sale date – these items cannot be fulfilled prior to this date. Use the <PubDate>
/ PU and <OnSaleDate> / RDT tag or mnemonic, the on hand quanitity
mnemonics. The on sale date tag is only present if an "on sale date" has been
assigned by the publisher – therefore not all items will have this data.

Sort results - You may want to sort your results by publication date / PD or title /
TTL.
Can we limit to results to mass market paperback? Mass market refers to the way that a book is bound. Use the binding type
mnemonic - BND="mass"
Is there way to determine if an item that is available Yes, by using the family query (queryType 6) – which will pull related works
in hardcover is also available in mass market or in available in different formats.
audio?
Can I request multiple EAN's in one query? Yes, for query types 1-4 or 9. e.g., (BN="9780375838415" or "9781416906162"
or "9780375828072" or "9780064437271" or "9780142401934" or
"9780375822230" or "9780142500613" or "9780375802942" or

Ingram Web Service ImplementationGuide 53

 Question Answer
"9780698119826" or "9780142302026" or "9780618065677")
How do I determine if an item is Returnable? If the return code value is equal to "Y" and return date is greater than the
"current date", the item is Returnable until the date specified. You can also use
the Return Code / RT and Return Date / RD mnemonics for displaying only
returnable items. RT="Y" and RD>"currentdate"
Bestselling items? You can use the Ingram demand sort the top demand items to the top of your
results, sortField=DE. You can also add the DE="Y" to find only items that have
a demand ranking or you could create your own bestsellers list from your own
book experience.
Bargain, Rare or Used Book data Ingram doesn't specialize in rare or bargain books. However, we do offer the
option to display items that are "Not available from Ingram", data source =
extended or SRC = "X".

Ingram Web Service ImplementationGuide 54

Best Practices
Below are some of the best practices that Ingram recommends for using Ingram Web service.

Use the UserName and URL that corresponds with the protocol - The test and production servers require
unique user names. Make sure you are using the correct UserName with URL that corresponds with the proper
server.

Use a Valid UserName – Each query request must contain a valid userName

Use Proper Query Syntax - Quotation marks should be used around the search words or numbers. Use
Parentheses around query phrases to illustrate precedence.

Stay within the query size limits -

• The maximum query length is 2048 characters.
• Limit use of redundant mnemonics, where applicable, e.g., both ((KW="dog" and "blue") and
(KWTI="dog" and "blue") and BSC="ART*") and ((KWI="dog" and "blue") and BSC="ART*") will
render the same results.
Filter Results - Add various filters to your query to retrieve the best results. See data filtering and sortField
sections of this document for more information.

Use Caching Carefully - To enhance performance of page loads we recommend that you cache images,
descriptions, contributor and family id's. Some data changes frequently, especially the inventory availability,
price, and discount – so we recommend that you do not cache this data.

Familiarize yourself with the "Terms and Conditions of Use" - The Ingram Web service license agreement
contains information regarding enforced limitations. Use restrictions are in place to ensure that all users benefit
equally from the service. To eliminate service interruptions, please ensure that your usage is within these
guidelines specified in the license agreement.

Ingram Web Service ImplementationGuide 55

Document History
Denotes changes since the last release of this guide (sorted by category then by action)
Version Date Action Category Description Notes

V16R6 09/17/2015 New Mnemonic / Tag Fairfield, OH On-Hand Quantity / OHJ Stock information for the Fairfield, OH Distribution Center (DC). Ordering from
this alternate DC is a business decision.
V16R6 09/17/2015 New Mnemonic / Tag Fairfield, OH On-Order Quantity / OOJ On order information for the Fairfield, OH Distribution Center.

V16R6 12/01/2014 New Mnemonic / Tag Fresno, CA On-Hand Quantity / OHJ Stock information for the Fresno, CA Distribution Center (DC). Ordering from
this alternate DC is a business decision.
V16R6 12/01/2014 New Mnemonic / Tag Fresno, CA On-Order Quantity / OOJ On order information for the Fresno, CA Distribution Center.

V16R5 07/31/2014 New Mnemonic / Tag Allentown, PA On-Hand Quantity / OHB Stock information for the Allentown, PA Distribution Center (DC). Ordering from
this alternate DC is a business decision.
V16R5 07/31/2014 New Mnemonic / Tag Allentown, PA On-Order Quantity / OOB On order information for the Allentown, PA Distribution Center.

V16R4 10/05/2013 New Functionality Document mnemonics The Document Mnemonic feature provides a tool to look up the code translation
values for any mnemonic that has a corresponding code translation.
V16R4 10/05/2013 New REST REST replaced HTTP POST.

V16R3 01/18/2012 New Mnemonic / Tag Accelerated Reader Interest Level / ARIL Renaissance Learning Accelerated Reader interest level provides the grade level of
interest for a book. Please click on the link to learn more,
[Link] Searchable in queryTypes 1 - 4 and the data is
returned in queryTypes 1 – 6.
e.g., ARIL="LG"

AR Interest Level codes

Search Code Description Grade Level Age Level
LG Lower Grades Kindergarten – 3 5–8
MG Middle Grades 4–8 9 – 13
MG+ Middle Grades Plus 6 and up 11+
UG Upper Grades 9 – 12 14+

Composite / tag
<Basic><ReadingPrograms><AcceleratedReaders><AcceleratedReader>
<InterestLevel>LG</InterestLevel>

Ingram Web Service ImplementationGuide 56

 V16R3 01/18/2012 New Mnemonic / Tag Accelerated Reader Reading Level / ATOS The Accelerated Reader reading level is the equivalent grade level of text for a
book. The first number is the grade and the number after the decimal is the month
of the school year. Searchable in query types 1 - 4 and the data is returned in query
types 1 – 6. This is a range filter which means that the greater than (>) and less
than (<) operators are valid with whole number (no decimal), use the range (::::)
operator to search decimal values.

e.g.,
ATOS >"7" (searches for all greater than 7).
ATOS <"10" (searches for all less than 10).
ATOS >"7.8" invalid - must use the range (::::) operator.
ATOS ="7.8::::8.5" (searches for a range between 7.8 and 8.5, inclusive).

Composite / tag
<Basic><ReadingPrograms><AcceleratedReaders><AcceleratedReader>
<ReadingLevel>3.40</ReadingLevel>
V16R3 01/18/2012 New Mnemonic / Tag Accelerated Reader Point Value / ARPV The Accelerated reader point value is used for rewarding the student. Searchable
in query types 1 - 4 and the data is returned in query types 1 – 6. This is a range
filter which means that the greater than (>) and less than (<) operators are valid
with whole number (no decimal), use the range (::::) operator to search for a range
with a decimal value.

e.g.,
ARPV>"8" (searches for all greater than 8).
ARPV="7.5::::9.0" (searches for a range between 7.5 and 9.0, inclusive).

Composite / tag
<Basic><ReadingPrograms><AcceleratedReaders><AcceleratedReader>
<PointValue>0.5</PointValue>
V16R3 01/18/2012 New Mnemonic / Accelerated Reader Quiz Number / ARQZ Accelerated Reader quizzes are used to test the students reading comprehension
Tag before awarding the AR points. Use with equals (=) or no equal (<>) operators.
Searchable in query types 1 - 4 and the data is returned in query types 1 – 6.

e.g.,
ARQZ="86513"
ARQZ<>"86513"

Composite / tag
<Basic><ReadingPrograms><AcceleratedReaders><AcceleratedReader>
<QuizNumber>0000008019</QuizNumber>

Ingram Web Service ImplementationGuide 57

 V16R3 01/18/2012 New Mnemonic / Tag Guided Reading Level / GRL The Guided reading level provides an equivalent reading level based on grade.
e.g. ,
GRL="F"
(GRL="A" or GRL="B") (searches for A or B)

Guided Reading Level values

Guided Reading Level Grade Level
Search Value Description
A, B, C Kindergarten – 1
D, E, F, G, H 1
I 1–2
J, K, L 2
M 2–3
N, O 3
P 3–4
Q, R, S 4
T, U V 5
W, X, Y 6
Z 7–8

Composite / tag
<Basic><ReadingPrograms><GuidedReadingLevel>A</GuidedReadingLev
el>
V16R3 01/18/2012 New Mnemonic / Tag Lexile Code / LXCD The Lexile code is a two-character code that can be used with the Lexile text
measure to match students to equivalent text for their reading skill level. Please
visit the Lexile Web site for more information, [Link]
lexile/lexile-codes/.

e.g.,
LXCD="AD"

Lexile Code
Lexile Code Lexile Code Description
AD Adult-Directed
BR Beginning Reader
GN Graphic Novel
HL High-Low
IG Illustrated Guide
NC Non-Conforming Text
NP Non-Prose

Composite / tag
<Basic><ReadingPrograms><Lexile><LexileCode>AD</LexileCode>

Ingram Web Service ImplementationGuide 58

 V16R3 01/18/2012 Change Tag LexileText Measure The Lexile text measure provides a numeric code that represents how difficult the
text is to comprehend. [Link]

Tag has been replicated to a new location to group the data under the new reading
level composite.

Composite / tag
<Basic><ReadingPrograms><Lexile><LexileLevel>0740</LexileLevel>
V16R3 01/18/2012 New Mnemonic / Tag Country of Origin / COO This is the country of manufacture or production. Use the ISO 3166-1 alpha-2
country code for search and response values -
[Link] Additional user access is
required to retrieve this data.

e.g.,
COO="ZA"
(COO="US" or "CA" )

Composite / tag
<Ingram><Logistics><CountryOfOrigin>US</CountryOfOrigin>
V16R3 01/18/2012 New Mnemonic / Tag Harmonized Code / HSCD You can use a range filter which means that the 'greater than (>)' and 'less than (<)'
operators are valid as long as you are using a whole number (no decimal). If you
search on a range with a decimal value, then you must use the 'range (::::)'
operator.

e.g.,
HSCD="4901.10"::::"4901.99" (searches for a range between 4901.10 and
4901.99, inclusive)
HSCD>="4901" (searches for all equal to or greater than 4901)
HSCD<"8523" (searches for all less than 8523)
HSCD>"4901.99" invalid and must use the :::: range operator

Composite / tag
<Ingram><Logistics><HarmonizedCode>4901.99.0070</HarmonizedCo
de>
V16R3 01/18/2012 New Mnemonic / Tag Barcode Indicator / BCI The barcode indicator denotes if the item has a barcode is printed on the book or
package.

e.g.,
BCI="Y" (returns all with a barcode indicator of Y)
BCI<>"Y"(returns all where the barcode indicator is not Y and will display as N
in xml data returned)

Composite / tag
<Ingram><Logistics><Barcode>Y</Barcode>

Ingram Web Service ImplementationGuide 59

 V16R3 01/18/2012 Change Tag Media Mail Indicator "Y" – Item is eligible to ship via the USPS Media Mail.
"N" – Item is NOT eligible.

Please note: The USPS defines the rules for the use of Media Mail – please visit
their Web Site for more information, [Link]

Tag has been replicated to a new location to group the data under the new
Logistics composite.

Composite / tag
<Ingram><Logistics><MediaMail>Y</MediaMail>
V16R3 01/18/2012 New Tag Carton Quantity Number of units included in a full carton.

Composite / tag
<Ingram><Logistics><CartonQuantity>78</CartonQuantity>
V16R3 01/18/2012 Change Tag Number of Units This pertains to pre-pack items included within the package, e.g., quantity of disks
included in an audio book or video package.

Tag has been replicated to a new location to group the tags under the new
Logistics composite.

Composite / tag
<Ingram><Logistics><Units>1</Units>
V16R3 01/18/2012 Change Tag Package Dimensions This new composite under Logistics will group some physical item attributes for
an item, weight, height, length and width. Results will include a decimal.

Tags have been replicated to a new location to group the data under the new
Logistics composite.

Composite / tag
<Ingram><Logistics><Dimensions><Weight>0.00</Weight><Length>0
.00</Length><Width>0.00</Width><Height>0.00</Height>
V16R3 01/18/2012 Change Tag Display Indicator / DF Indicates that the item is a display and contains multiple items that are purchased
together but are meant to be sold separately. Online databases may choose not to
show these items.

"Y" – Item contains multiple items.

<>"Y" – Item doesn’t contain multiple items.

Tag has been replicated to a new location to group the tags under the new
Logistics composite.

Composite / tag
<Logistics><Display>N</Display>
V16R3 01/18/2012 New Tag Display Type New value to define the type of display.

Composite / tag
<Logistics><DisplayType>Dump (Floor)</DisplayType>

Ingram Web Service ImplementationGuide 60

 V16R3 01/18/2012 New Mnemonic Series Number / SENB This mnemonic allows searching for the series number, when assigned to a book
in a series.
e.g., harry potter book 7.
SE="Harry Potter" and SENB="7" – returns Harry Potter and the Deathly
Hallows.

Composite / tag
<Basic><SeriesID>Harry Potter (Paperback)</SeriesID>
<SeriesNum>07</SeriesNum>
V16R3 01/18/2012 Change Mnemonic / Tag BISAC subject for Gift & Game (queryType 3) The BISAC subject mnemonics and tags are available for the gift & game query,
queryType 3. Please see the implementation guide for more information about the
BISAC subject mnemonics: BSC, BSU, BSD1, BSD2, BSD3.

Composite / tag
<BisacSubject> <Code>NON513000</Code><Description>Non-
Classifiable | Plush & Toy Items | General</Description>
V16R3 01/18/2012 Change Mnemonic / Tag Theme and Theme Group for Gift & Game Theme and theme group mnemonics and tags are available for the gift & game
(queryType 3) query, queryType 3. Please see the implementation guide for more information
about themes and theme group mnemonics: TH, THG.

Composite / tag
<Theme><Group>Gifts & Games</Group><Description>Activity
Books & Sets</Description>
V16R3 01/18/2012 New Tag Title Leading Article value If the <LeadingArticle> value is "Y" the <TitleLeadingArticle> tag and value
will be sent in the XML response.

Composite / tag
<Basic><TitleLeadingArticle>A</TitleLeadingArticle>
<Title>Good Night Walk</Title>
V16R3 01/18/2012 New Tag Leading Article The <LeadingArticle> tag will now appear in results for queryType 3 & 4.

V16R3 01/18/2012 New Review Source BlueInk Review BlueInk review provides review citation and text for self-published books.
Additional user access is required to retrieve this data.

queryType 5 dataRequest = BINK

V16R2 05/09/2011 Change Case sensitivity More mnemonics have been added to a code translation. The code translation
denotes that the search values are case sensitive.
V16R2 05/09/2011 New Code Table Citation Sources File name [Link].

V16R2 05/09/2011 New Functionality Multiple sortField may be applied to each query Author ascending and price descending, sort = CO|0, PR|1.

V16R2 05/09/2011 New Functionality QueryType 9 – Stock Check queryType 9 provides real-time inventory availability on items that are currently
carried by Ingram. Search for up to 25 items at a time by EAN or UPC using the
BN mnemonics and the "OR" operator.
V16R2 05/09/2011 Remove Functionality Boolean No restrictions on combining mnemonics in an "OR" statement.

Ingram Web Service ImplementationGuide 61

 V16R2 05/09/2011 Remove Functionality Record Filters No restrictions on use of operator "ANDNOT / <>".

V16R2 05/09/2011 Remove Functionality Pipe operator "|" This alternative to the "OR" operator is no longer available.

V16R2 05/09/2011 Remove Functionality Sort – Bible Type / BT The ability to sort results on this information has been removed.

V16R2 05/09/2011 Remove Functionality Sort – Bible Version / BV The ability to sort results on this information has been removed.

V16R2 05/09/2011 Remove Functionality Sort – Review Source and Attribute / RSS The ability to sort results on this information has been removed.

V16R2 05/09/2011 Remove Functionality Sort – Review Date / RVDT The ability to sort results on this information has been removed.

V16R2 05/09/2011 Change Mnemonic Publisher Name / PU Search value is case sensitive and requires exact publisher name or wildcard, e.g.,
PU="Random House" or PU="Random*". Use keyword publisher, KWPU, as an
alternative option.
V16R2 05/09/2011 New Mnemonic On Sale Date / RDT RDT = "201101::::201106".

V16R2 05/09/2011 New Mnemonic Review Source and Date / RSDT This mnemonic will search all review citation resources.
RSDT="BL|2011051"
V16R2 05/09/2011 New Mnemonic Title / TTL Search only the title field - TTL="Wild Goose".

V16R2 05/09/2011 New Mnemonic BSD1, BSD2 and BSD3 Searches the 1st, 2nd and 3rd level of the BISAC subject category.

V16R2 05/09/2011 New Mnemonic CMA1 and CMA2 Searches the 1st and 2nd level of the Christian Music Trade Association, CMTA
Subject Description.
V16R2 05/09/2011 New Mnemonic Accessory Indicator / ACI This indicates if an accessory, e.g., Book with CDROM, accompanies an item.
Use to find or filter out items that have an accessory.
V16R2 05/09/2011 Update Mnemonic Keyword Title / TI and KWTI Searches the title, edition description, and series name fields.

V16R2 05/09/2011 Change Mnemonic / Tag Features / FE Searchable and returned in query types 1 and 4.

V16R2 05/09/2011 Change Mnemonic / Tag Product Format / IFMT Searchable and returned in query types 1 and 4.

V16R2 05/09/2011 New Mnemonic / Tag Audience Rating / AR AR, e.g., AR="PG".

Composite / tag
<Audience><Rating>PG</Rating>
V16R2 05/09/2011 New Mnemonic / Tag Awards Code / AWD Search for items that have won or have been nominated for a specific award.
Pulitzer Prize - AWD="23"
V16R2 05/09/2011 New Tag Image Indicator Composite / tag
<Image><ImageIndicator187>
V16R2 05/09/2011 New Tag Images URL's returned in query types 1 – 6 in Composite / tag
three sizes 60 pixel = <Image><IMG60>
94 pixel = <Image><IMG94>
187 pixel = <Image><IMG187>

Ingram Web Service ImplementationGuide 62

 V16R2 05/09/2011 Change URL Test server URL change From [Link] to [Link].

Ingram Web Service ImplementationGuide 63

Contacts
Customer Care
Company Email Phone Business
Hours
IBC & Spring Arbor [Link]@[Link] (800) 937-8200 Extended
International [Link]@[Link] (615) 793-5000, ext 32622 or Extended
(800) 289-0687

Additional Contacts
Company Email Phone Business
Hours
Integration team integrate@[Link] (800) 937-7978 Normal

Business hours (all times CT and excluding Ingram recognized holidays)

• Normal: Monday – Friday, 8:00 a.m. to 5:00 p.m.
• Extended: Monday – Sunday, 7:30 a.m. to 8:30 p.m.

Policy
Copyright © 2012 Ingram Content Group, Inc. or its affiliates. All rights reserved.
Every effort has been made to ensure accuracy of the information provided. If you should find errors in this document, please notify the
Ingram integration team via email, integrate@[Link].

Ingram Web Service ImplementationGuide 64