Data Services: Inventory Specification
Data Services: Inventory Specification
Inventory Specification
Implementation Guide
Version 2, Release 10
November 12,2018
This document includes file descriptions and a layout specification for the StockV2 and supplemental files, as well
as file and field usage tips.
• The StockV2 files provide inventory availability for all Ingram titles that are available to sell. The
inventory files can be very large (average 4GB), are available in a fixed-width text file format, and can be
downloaded from the Ingram FTP server. We have created all files in a single format for ease of
development with a database or similar application. The inventory files provide a snapshot of available
inventory and therefore, do not guarantee that the title will be available during order processing.
o The StockV2 file is offered in several options – please see the File Description Table for more
information on the available files.
o The file layout specification can be found in StockV2 File Specification section of this document.
• The supplemental files, also available for download from the Ingram FTP server, contain additional
inventory information like country excluded for sale (Country Exclusion), predicted estimated time of
arrival of title in any Ingram Distribution Center (Inventory Estimated Time of Arrival), and the publishers
international suggested retail price (International Price). Please click on the links below to learn more about
each of these files;
o Inventory Country Exclusion file - country excluded for sale of the title
o Inventory Estimated Time of Arrival (ETA) file - predicted estimated time of arrival of title in an
Ingram Distribution Center
We recommend that you begin development as soon as you have reviewed the implementation guide, determined a
plan to maintain the accuracy of the data, and have identified any data filtering that is required for your business
needs.
Getting Started
1. Determine how you will maintain the accuracy of the data. See the table below for some suggestions and the
processing schedule sample for examples.
2. Review available files. Please see the data file description table for more information about the different files
that are available. Please review options carefully to select the best choice for your business needs.
3. Download selected files and code translation files.
4. Create tables based on the file specifications. Sample SQL create table and import scripts are available upon
request.
5. Import data into a database or similar application.
6. Create links to other data using the primary key.
7. The remaining steps will vary based on your systems.
Here are some suggestions for maintaining the accuracy of the data:
# Desired Result Suggestion
1 Maintain up-to-date inventory levels on all titles with Download the Full and Delta files up to six times daily. This will maintain
faster processing. up-to-date inventory. The Delta files report deleted or discontinued titles,
once. These records, called "zero" records, and contain zeros ("0"), spaces /
blanks, and no's ("N") in all fields. You must process all Delta files so that
you will not miss any of these records.
2 Maintain up-to-date inventory levels with faster Download the first Full file one time only and all sequential Delta files.
processing.
3 Update only titles that have been added, changed, or Same as # 2.
have been deleted since the last inventory file.
4 Update inventory levels once daily. Download the Full file once and the daily Delta file.
5 Refresh active titles, which will remove Ingram as the If an title is not found in a Full file or if you receive a Delta "zero record,
supplier for titles no longer carried. the title is no longer available from Ingram.
6 Maintain up-to-date inventory levels on the Slice We provide a Data Slice Full file once weekly. We recommend that you use
inventory. the daily Delta files to maintain the inventory availability.
7 Use Microsoft Excel as a spreadsheet database. The Full and Part files are too large to import into MS Excel. If Excel is
your only option, you may try to split the file into smaller files using a text
file split application; these applications / utilities are downloadable from the
Internet.
8 Use Microsoft Access as the primary database software. MS Access (97/2003/2007/2008) has a 2GB size limitation and the Full and
Part files exceed this limit. You may find that using one of our smaller
stock files or building a link to the Full text file, instead of importing the
data into a table, is your only option for this database solution. You can find
instructions for "How to Link a text file" on the www.microsoft.com web
site.
Data filtering can be accomplished in a variety of ways. Based on the ever-growing number of titles provided by
Ingram, we recommend the following:
• All data can be filtered prior to or at the time it is loaded into your tables.
• Filtering can and should be applied to all files, except for reference files.
The Return Date is the date on which the title must be returned to
Ingram. Please allow plenty of time for shipment and receipt at an
Ingram DC.
9 Determine if an title is not returnable. Return Date = "00010101" or > "current date" and Returnable
Indicator = "N"
10 How do I filter titles that are restricted to sell? You are responsible for excluding restricted titles for sale in your
system. The Ingram ordering systems will block the title from order
fulfillment.
Please use the Restricted Code and the Country Exclusions files to
determine which titles are restricted for sale. Each title restriction
depends on the Publisher. You can use the Country Exclusion file to
determine which countries are excluded from purchasing/selling
specific titles.
1
Filtering for On-Hand Qty titles only to build your title offering may lead to an unsatisfactory customer experience – as your offering will change frequently. It is
recommend that you show all titles carried regardless of the inventory level and add a message to your customer regarding availability (e.g., "Available to ship", "Title
is temporarily out of stock", "Pre-Orders are now being taken" or "Reserve your copy today"). You can use the Product Availability Code (position 272-273) in
addition to the On Hand Qty (positions 039-094) and On Sale Date (position 197-204) fields to assist with assigning the proper status.
File Delivery
The inventory files can be downloaded from the Ingram FTP server.
FTP Folder
• \Inventory
• \Inventory_Top_Titles (International Only)
• \Slice – file is available in the data slice folder.
• Slice *- in the file name column denotes the three character slice prefix of a pre-defined data slice, e.g., Top
250k Slice = [email protected]
• x - in the file name column signifies the sequential daily run – "a" indicates the 1st file generated, "b" (2nd
file) and so on, up to "f". e.g., [email protected]
• YYMMDD or YYYYMMDD - in the file name column represents the date the file was created, e.g.,
[email protected] or dly_stkv2delta20120630.zip
*
Only available for data slice subscriptions, please contact IDS Sales for more information
You are responsible for the additional filtering of titles that are not available to sell based
on the publishers request or in a particular country. Please see the Restricted Code and
County Exclusion file for assistance with identifying restrictions.
As of June 2012, the size of this file is over 4GB and is expected to grow significantly
over the next year. Therefore, this file requires adequate resources for processing.
2 StockV2 Full - Spring This Full file contains books, bibles, and gift & game titles for the Christian Market [email protected] 6MB full part
Arbor (Spring Arbor).
3 StockV2 Delta This Delta file contains all incremental updates for titles where select fields have changed, [email protected] delta full
a record has been added, or deleted since the previous file was created.
This file is created by comparing the current and previous master files (StockV2 Full). A
unique file name is used for each new file.
4 StockV2 Daily Delta This Delta file contains incremental updates for titles where any field may have changed, a dly_stkv2deltayYYYYMMDD.zip delta part
record has been added, or deleted since the previous file was created. A unique file name
is used for each new file.
5 StockV2 Weekly Delta This Delta file contains incremental updates for titles where any field may have changed, a wkly _stkv2deltaYYYYMMDD.zip delta part
record has been added, or deleted since the previous file was created. A unique file name
is used for each new file.
6 StockV2 Part One Full This Full file contains a subset of books, bibles, and gift & game titles. Please see the [email protected] 1GB full part
other "part files" for public domain reproduction, compilation, digital, media, or music
titles. The file name is overwritten, but the "date modified" will change.
7 StockV2 Part One Delta This Delta file contains incremental updates for books, bibles, and gift & game titles. A [email protected] delta part
unique file name is used for each new file.
8 StockV2 Part One Daily This once daily Delta file contains incremental updates for books, bibles, and gift & game dly_stkv2pt1YYYYMMDD.zip delta part
Delta titles. A unique file name is used for each new file.
9 StockV2 Part One Weekly This once weekly Delta file contains incremental updates for books, bibles, and gift & wkly _stkv2pt1YYYYMMDD.zip delta part
Delta game titles. A unique file name is used for each new file.
10 StockV2 Part Two Full This Full file contains all public domain reproduction or compilation titles and is available stkv2pt2_fileXofX.zip 400MB full part
in five separate files for faster downloads, each file size is approximately 400MB. The file
name is overwritten, but the "date modified" will change.
11 StockV2 Part Two Delta This Delta file contains incremental updates for all public domain reproduction or [email protected] delta part
compilation titles. A unique file name is used for each new file.
12 StockV2 Part Two Daily This once daily Delta file contains incremental updates for public domain reproduction or dly_stkv2pt2YYYYMMDD.zip delta part
Delta compilation titles. A unique file name is used for each new file.
19 StockV2 Media Delta This Delta file contains incremental updates for titles where any field may have changed, [email protected] delta part
or a record has been added or deleted, media titles. A unique file name is used for each
new file.
20 StockV2 Media Daily This once daily Delta file contains incremental updates for media titles. A unique file dly_stkv2mdaYYYYMMDD.zip delta part
Delta name is used for each new file.
21 StockV2 Media Weekly This once weekly Delta file contains incremental updates for media titles, includes product wkly _stkv2mdaYYYYMMDD.zip delta part
Delta type "X" = Music. A unique file name is used for each new file.
22 StockV2 Music Full This Full file contains inventory data for music titles. The file name is overwritten, but the [email protected] 120MB full part
"date modified" will change.
23 StockV2 Music Delta This Delta file contains incremental updates for titles where any field may have changed, [email protected] delta part
or a record has been added, or deleted music titles. A unique file name is used for each
new file.
24 StockV2 Music Daily This once daily Delta file contains incremental updates for music titles. A unique file dly_stkv2musYYYYMMDD.zip delta part
Delta name is used for each new file.
25 StockV2 Music Weekly This once weekly Delta file contains incremental updates for music titles. A unique file wkly _stkv2musYYYYMMDD.zip delta part
Delta name is used for each new file.
26 StockV2 Slice Full This Full file contains inventory data for all titles in a specific data slice. The file name is [email protected] varies full part
overwritten, but the "date modified" will change.
Please note: All times are central time (CT) and are subject to change without notice. If a file is not available at the time specified, please check back at 15-minute intervals – as it may have been delayed due to
unforeseen circumstances.
Part One and Part Two full files once weekly with daily delta files
Monday Tuesday Wednesday Thursday Friday Saturday Sunday
21 22 23 24 25 26 27
* The Delta files report titles that are no longer carried by sending a zero record, once.
These records that contain all zeros ("0"), spaces / blanks, and no's ("N") in all fields. You
28 29 30 31 June 1 2 3 must process all Delta files so that you will not miss any of these records.
151 – 157 7 N Price This is the U.S. Suggested Retail Price (SRP) and
is the highest list price in any active Distribution
Center (DC). This is the Price that Ingram uses for
account billing purposes and is most widely used
as the MSRP. Two decimals are implied. Format:
"0001495" = $14.95
166 – 168 3 A, N Discount Level Discount percent (e.g., "NET", " 5%", "35%") or
standard discount represented by the codes "REG"
or "LOW" (please contact Customer Care to obtain
your account level discounts for these values). The
data in this field is left justified and space filled,
e.g., five percent = " 5%"
179 – 180 2 A, N Publisher Status Code This data is supplied by the publisher and
represents the current state of the title in the
publishing life cycle. Please see Product
Availability Code (position 272 – 273) for the
supplier status information. See reference file,
inventory\ pubstatus.txt for complete list of
values.
181 1 A, N La Vergne, TN Stock Flag "Y" – title is Active and carried/stocked in the
specific DC, the title can be ordered or
backordered based on the on-hand quantity.
"N" – title is no longer carried/stocked, backorders
are no longer accepted. Please note: For sell down
titles - please see the on-hand quantity fields
(positions 039 – 094) for available inventory.
189 – 196 8 DT Publication Date Date in which the title was or is due to be
published.
Please note: If the publisher only supplies a month
and year as the Publication Date - Ingram will
populate DD (=Day) with the first day of the
month or the date specified in the On Sale Date
(position 197-204).
197 – 204 8 DT On Sale Date The on sale date, also known as "Street Date", is
the date that the publisher will allow the item to be
sold to the public. Please note:
Date = "000000" – indicates that an On Sale Date
has not been set and the item can be sold upon
receipt.
206 – 213 8 DT Return Date This represents the last date the title can be
returned to Ingram. Please allow plenty of time for
shipment and receipt at an Ingram DC.
Please note:
Date = "00010101" – the title is NOT Returnable.
Date = "99991231" – a Return Date has not been
set.
219 1 A, N Backorder Only Indicator This indicator is used to flag titles which will be
ordered only when a backorder is placed for the
title. Backorders may be placed in any "Y" flagged
DC (see DC Stock Flag, positions 181 – 188).
Valid Codes:
"Y" – a backorder is required for ordering.
"N" – Backorder is not required.
"1" – approximate one day backorder, (e.g., title
transfer between DC's).
"2" – approximate two day backorder.
220 1 A, N Media Mail Indicator "Y" – Title is eligible to ship via the USPS Media
Mail.
"N" – Title is NOT eligible.
256 – 259 4 A, N Ingram Publisher Number An Ingram assigned code representing the
publisher imprint. See reference file,
inventory\ipspubnum.txt for a complete list of
values for our IPS partners.
265 1 A, N, Blank Restricted Code The code indicates if an title has imposed
restrictions limiting the sale to certain geographical
areas or market types. If more than one restriction
applies to any one title, the higher priority code is
supplied. If blank a restriction does not exists for
the title. Please see reference file,
inventory\restrictcodes.txt for complete list of
values.
266 – 270 5 A, N Discount Category Code This is the Ingram Publisher Services (IPS)
discount code that is assigned by the publisher and
can be used in conjunction with the Ingram
Publisher Number (position 256 – 259) to translate
the discount on IPS titles.
272 – 273 2 A, N Product Availability Code This code indicates the stock availability status of
the title within Ingram systems. This status relates
to the Ingram system only and may not match the
Publisher Status Code (position 179 – 180). See
reference file, inventory\prodstat.txt for complete
list of values.
274 – 282 9 A, N Ingram Title Code This is an alternative Ingram assigned item
identifier and can be used when ordering from
Ingram.
283 – 284 2 A, N Product Classification Type This field will provide the ability to include or
exclude public domain reproduction and
compilation titles on your site or designate them
with the additional classification.
File Location
\inventory
File Name
ctry_excl_titles.txt
Availability
• Download from FTP server
• Monday by 1:00am CST
• Updated weekly
Reference File
country.txt
File Format
This file specification adheres to the following:
File Location
\inventory
File Name
[email protected]
Availability
• Download from FTP server
• Available by 8:00am CST
• updated daily
File Format
This file specification adheres to the following:
File Location
\inventory
File Name
[email protected]
Availability
• Download from FTP server
• Available by 8:00am CST
• updated daily
File Format
This file specification adheres to the following:
Please note: Ingram is NOT responsible for the accuracy of the data in
this field.
4 54 A, N, Blank Filler 1
Question Answer
How do I calculate my cost? Your cost is the Price minus (Price multiplied by the Discount Level). Price-
(Price*Discount Level) = Cost
Example:
Price: $9.95
Discount Level: 40%
9.95-(9.95*0.4) = $5.97
How do I identify titles that are restricted for sale? Please use the Restricted Code (position 265) and the Country Exclusions file ti
identify titles that are restricted for sale.
Is there anything in the full or delta files that There is not a flag in the inventory file that denotes that a record is new or has
identifies or flags "what" field has been changed? been changed. However, there is a Delta file.
What are your product types for DVD's? Ingram Product Type (position 221) = "K", Video
Where can I find the "Country of Origin" for a title? This data can be found in the logistics file. Please contact IDS Sales for
information about this or other files.
What code will Backorder Only titles have in the A Backorder Only title will have a "Y", "1", or "2" in the Backorder Only
inventory file? Indicator field or a "22" in the Product Availability Code field.
If an order is placed for a Backorder Only title Since you do not allow backorders, we would recommend that you filter the
without a cancellation date, the order will reject – backorder only titles from your offering. Here is the filter options:
since we’re managing our own backorders, we don’t Backorder Only Indicator <> "N" or Product Availability Code = "22" - "To
send you a cancellation date and theoretically, if these order - Available from us as a non-stock title, by special order".
titles have zero stock, we would never send at
all…..how do we do this?
How many Backorder Only titles exist? This amount varies by data license.
Does the reference file, ipspubnum.txt, contain all of This file contains all possible publisher numbers for publishers that are currently
are available publishers from Ingram Publisher distributed by IPS. The file, ipspubnum.txt, is a reference file for the code found
Services (IPS)? in the Ingram Publisher Number field and the file is updated as needed.
The Delta files report deleted or discontinued titles, called zero records, once. You must process all Delta files so
that you will not miss any of these records.
A unique file name is used for each new file, e.g., [email protected].
Full This is the "master" file, which contains all titles that are available to sell (some restrictions may apply) and is
generated six times per day. You are responsible for the additional filtering of titles that are not available to sell
based on the publishers request or in a particular country. Please see the Restricted Code and County Exclusion file
for assistance with identifying restrictions.
This file tends to be very large (as of July 2012, it is over 4GB) and is expected to grow significantly over the next
year. Therefore, this file requires adequate resources for processing.
Discontinued or deleted titles will drop off the Full file; please see the Delta files for delete records.
The file name is overwritten, but the "date modified" will change, e.g., [email protected]
Primary Item The EAN is the Primary Item Identifier or Primary Key which is used to uniquely identify a record in a file or table.
Identifier No two distinct rows in a table can have the same value (or combination of values). This key can be used to link
data from other files or tables.
Primary Key See Primary Item Identifier.
Slice See Data Slice.
Zero Record The Delta files report deleted or discontinued titles, once. These records, called zero records, contain zeros ("0"),
spaces / blanks, and no's ("N") in all fields and a Product Availability Status = "40".
The version and release are represented in the abbreviated format for version.release, X.X, in this table.
2.9 09/17/2015 Change StockV2 File Specification / On Hand Fairfield, OH added. Positions 081 - 087
Quantity
2.9 09/17/2015 Change StockV2 File Specification / On Order Fairfield, OH added. Positions 137 - 143
Quantity
2.9 09/17/2015 Change StockV2 File Specification / Stock Flag Fairfield, OH added. Position 187
2.9 09/17/2015 Change Inventory Supplemental Files / Fairfield, OH added. Code “FF”. Column 2
Inventory Country Exclusion file /
Ingram Distribution Center Code
Contacts
Customer Care
Additional Contacts
Setup and Login Instructions, Data [email protected] (800) 937-7978, option 6 Normal
Sales, and Administration