0% found this document useful (0 votes)
57 views

Data Services: Inventory Specification

Uploaded by

df kjkjh
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
57 views

Data Services: Inventory Specification

Uploaded by

df kjkjh
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 20

DATA SERVICES | FTP

Inventory Specification

Implementation Guide
Version 2, Release 10
November 12,2018

Copyright© Ingram Data Services Inc. All rights reserved.


Table of Contents
Overview ......................................................................................................................................................... 3
StockV2 Implementation ............................................................................................................................... 4
Maintaining the Data ....................................................................................................................................................................... 4
Data Filtering................................................................................................................................................................................... 5
StockV2 File Specification Overview ........................................................................................................... 6
Stockv2 File Specification ............................................................................................................................. 0
Inventory Supplemental Files ....................................................................................................................... 4
Inventory Country Exclusion file .................................................................................................................................................... 4
Inventory Estimated Time of Arrival (ETA) File ............................................................................................................................ 5
Inventory International Price File .................................................................................................................................................... 6
Frequently Asked Questions ........................................................................................................................ 7
Glossary .......................................................................................................................................................... 8
Document History .......................................................................................................................................... 9
Contacts .......................................................................................................................................................... 9
Overview
The purpose of the inventory files is to supply Ingram Content Group customers with the necessary data fields to
update title availability electronically. Bibliographic and classification data, such as title, author, subject, binding
and additional data elements like images, title descriptions, desirability, contributor biographical information, etc.
are also available for subscription. Please contact IDS Sales for more information.

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

o International Price file - publishers international suggested retail price

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 IDS integration team to review or
update your technical contact information.

Data Services | FTP, Inventory Implementation Guide 3


StockV2 Implementation
In this section, you will find information about integration; maintaining data accuracy, a sample file ingestion
process strategy, and filtering of the data found in the inventory files. The average integration time varies per
customer: speed of integration is contingent on your resources.

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.

Maintaining the Data


It is critical to maintain the accuracy of the data, because out-of-date and inaccurate data can lead to poor customer
experiences and a potentially lengthy update process. Once you have a plan, we recommend that you develop an
automated processing schedule, with error alerts, to complete updates in a timely manner to prevent inaccurate data.

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 Services | FTP, Inventory Implementation Guide 4


Data Filtering
In this section, you will find information about filtering data, which is useful if you want to limit the titles that will
be made available to your customers or have limitations based on your data license.

Some benefits for filtering:


• Decreased time to perform table updates.
• Easier to maintain data integrity.
• Improved system performance and customer response time.
• Reduced disc consumption.

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.

Here are some common data filters (sorted - in no particular order):


# Desired Result Example Filter
1
1 Only show titles that are currently available to sell (or La Vergne, TN On-Hand Quantity > "00000000" and (On Sale Date
in stock). =< "current date" or = "00010101") and the title is not restricted.
2 Only show titles currently carried in one of the four DC's. Stocked in the La Vergne DC - La Vergne, TN Stock Flag = "Y"
3 Show titles that are temporarily out of stock (OS) and can La Vergne, TN On-Hand Quantity = "0000000", La Vergne, TN On-
be backordered in the La Vergne DC. Order Quantity > "0000000" and La Vergne, TN Stock Flag = "Y"
4 Show titles that can be pre-ordered or that have not yet La Vergne, TN On-Hand Quantity >= "00000000" and
published / released (NYP / NYR). (Publication Date > "current month" or the On Sale Date > "current
date")

For title with an On Sale Date – Ingram can receive On-Hand


quantities up to 14 days prior to the On Sale date. It is important that
you do not show these titles as "available" until the On Sale date has
passed, regardless if the On-Hand quantity is greater than "0000000".
5 Show titles that are carried in the La Vergne DC that La Vergne, TN On-Hand Quantity > "00000000"
have an On-Hand quantity greater than "0".
6 Show titles that are available in the Roseburg DC that Roseburg, OR Stock Flag = "Y", Roseburg, OR
have a Price less than $20.00. On-Hand Quantity > "0" and Price < "0002000"
7 Locate titles where a backorder is required. Backorder Only Indicator <> ("N")
8 Show only titles that are returnable. Returnable Indicator = "Y" and Return Date > "current date".

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.

Data Services | FTP, Inventory Implementation Guide 5


StockV2 File Specification Overview
In this section of the document, you will find detailed information regarding the StockV2 file; file delivery method,
file descriptions and update frequency, sample processing schedule for maintaining data integrity and the file layout
specification.

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.

FTP Server Availability and Notification


The FTP server is available 24 hours, seven days a week, with a twice-weekly scheduled maintenance windows. If
the server will be unavailable for any reason other than the scheduled maintenance windows listed below -
notification will be sent via email to the technical contact listed on your account profile.

FTP Maintenance Schedule


Day Duration
Sunday 12:00 a.m. – 05:00 a.m.
Friday 06:00 a.m. – 06:30 a.m.

File Description Table File Name Column Key

• 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

File Description Table Full/Delta and File Type Key


• Full/Full – this file contains all available to sell titles.
• Full/Part – indicates that the file contains a subset of titles that are available to sell. Please see the data file
name or description for more information.
• Delta/Full – this file contains incremental changes of a Full file.
• Delta/Part – this file contains incremental changes of a Part file.

*
Only available for data slice subscriptions, please contact IDS Sales for more information

Data Services | FTP, Inventory Implementation Guide 6


File Description Table
Data File Description File Name Avg Full / File
Size Delta Type
1 StockV2 Full This is the "master" file, which contains all active Ingram titles that are available to sell [email protected] 4GB full full
and is generated six times per day. The file name is overwritten, but the "date modified"
will change.

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.

Data Services | FTP, Inventory Implementation Guide 7


Data File Description File Name Avg Full / File
Size Delta Type
13 StockV2 Part Two Weekly This once weekly Delta file contains incremental updates for public domain reproduction wkly _stkv2pt2YYYYMMDD.zip delta part
Delta or compilation titles. A unique file name is used for each new file.
14 StockV2 Digital Full This Full file contains inventory data for library market digital titles, restricted use. The [email protected] 100MB full part
file name is overwritten, but the "date modified" will change.
15 StockV2 Digital 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, for digital titles. A unique file name is used for
each new file.
16 StockV2 Digital Daily This once daily Delta file contains incremental updates for digital titles. A unique file dly_stkv2digYYYYMMDD.zip delta part
Delta name is used for each new file.
17 StockV2 Digital Weekly This once weekly Delta file contains incremental updates for digital titles. A unique file wkly_stkv2digYYYYMMDD.zip delta part
Delta name is used for each new file.
18 StockV2 Media Full This Full file contains inventory data for media titles (video, video games and software [email protected] part
related titles) which includes product type "K"=Video and "S"=Software. The file name is
overwritten, but the "date modified" will change.

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.

Data Services | FTP, Inventory Implementation Guide 8


File Availability Grid

Monday Tue sday We dne sday Thursday Friday Saturday Sunday


a.m. p.m. a.m. p.m. a.m. p.m. a.m. p.m. a.m. p.m. a.m. p.m. a.m. p.m.
Data File 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9 1 5 9
1 StockV2 Full x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
2 StockV2 Spring Arbor Full x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
3 StockV2 Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
4 StockV2 Daily Delta x x x x x x x
5 StockV2 Weekly Delta x
6 StockV2 Part One Full x x x x x x x
7 StockV2 Part One Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
8 StockV2 Part One Daily Delta x x x x x x x
9 StockV2 Part One Weekly Delta x
10 StockV2 Part T wo Full x x x x x x x
11 StockV2 Part T wo Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
12 StockV2 Part T wo Daily Delta x x x x x x x
13 StockV2 Part T wo Weekly Delta x
14 StockV2 Digital Full x x x x x x x
15 StockV2 Digital Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
16 StockV2 Digital Daily Delta x x x x x x x
17 StockV2 Digital Weekly Delta x
18 StockV2 Media Full x x x x x x x
19 StockV2 Media Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
20 StockV2 Media Daily Delta x x x x x x x
21 StockV2 Media Weekly Delta x
22 StockV2 Music Full x x x x x x x
23 StockV2 Music Delta x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
24 StockV2 Music Daily Delta x x x x x x x
25 StockV2 Music Weekly Delta x
26 StockV2 Slice Full x

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.

Data Services | FTP, Inventory Implementation Guide 9


Inventory File Sample Processing Schedules
There are many different options for using the inventory files. Here are a few examples.

One full daily with all full delta files *


Monday Tuesday Wednesday Thursday Friday Saturday Sunday

Files represented: [email protected] [email protected]

Part One and Part Two full files once weekly with daily delta files
Monday Tuesday Wednesday Thursday Friday Saturday Sunday

Files represented: [email protected] stkv2pt2_fileXofX.zip dly_stkv2deltaYYMMDD.zip

One full weekly with once daily delta files


Monday Tuesday Wednesday Thursday Friday Saturday Sunday

Files represented: [email protected] dly_stkv2deltaYYMMDD.zip

One full monthly with once weekly delta files


File Key
Mon Tue Wed Thu Fri Sat Sun
Full files
April 30 May 1 2 3 4 5 6 [email protected]
[email protected]
stkv2pt2_fileXofX.zip
7 8 9 10 11 12 13
Delta files
[email protected]
dly_stkv2deltaYYMMDD.zip
14 15 16 17 18 19 20
wkly_stkv2deltaYYMMDD.zip

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.

Files represented: [email protected] wkly_stkv2deltaYYMMDD.zip

Data Services | FTP, Inventory Implementation Guide 10


Stockv2 File Specification
This file specification adheres to the following:

• File Format: fixed-width text file


• Record Length: 301 characters
• Text Qualifier: none
• Line Terminator: carriage return line feed
• Numeric Fields: right justified and zero filled
• Decimal: two decimals implied for all Price and Weight fields
• Date/Time Format: YYYYMMDD
• Field Format Key:
o A, N – Alpha Numeric (Text / String)
o DT – Date / Time
o N – Numeric

Position Length Format Field Name Description

1 1 A, N GTIN Prefix This is the Global Trade Item Number Prefix


(GTIN). A "0" represents a single unit and is
currently the only prefix defined for the book
industry. Add the GTIN Prefix to the EAN to
convert EAN to GTIN-14, no recalculation of the
check digit required.

2 – 14 13 A, N EAN EAN or ISBN – 13. The Bookland International


Article Number is the Ingram Primary Item
Identifier, will be present on ALL titles, and can be
used to link to other Ingram data files.

Please note: For titles that are not assigned an


EAN, Ingram will use the UPC with a leading zero.

15 – 28 14 A, N UPC Universal Product Code, item identifier, which has


been converted to the GTIN-14 form – prefixed
with two zeros. No recalculation of check digit is
required.

29 – 38 10 A, N ISBN-10 International Standard Book Number (ISBN-10), a


10-digit item identifier, used for books published
before 2007.

39 – 45 7 N La Vergne, TN On-Hand Quantity available to sell in the Distribution Center


Quantity (DC) specified in the "field name" column.

46 – 52 7 N Roseburg, OR On-Hand Quantity See description above.

53 – 59 7 N Ft. Wayne, IN On-Hand Quantity See description above.

60 – 66 7 N Chambersburg, PA On-Hand See description above.


Quantity

67 – 73 7 N Allentown, PA On-Hand Quantity See description above.

74 – 80 7 N Fresno, CA On-Hand Quantity See description above.

81 – 87 7 N Fairfield, OH On-Hand Quantity See description above.

88 – 94 7 N DC On-Hand Quantity Reserved for future use.

95 – 101 7 N La Vergne, TN On-Order Quantity On-Order with the supplier in the DC


Quantity specified in the "field name" column.

102 – 108 7 N Roseburg, OR On-Order Quantity See description above.

109 – 115 7 N Ft. Wayne, IN On-Order Quantity See description above.

Data Services | FTP, Inventory Implementation Guide 0


Position Length Format Field Name Description

116 – 122 7 N Chambersburg, PA On-Order See description above.


Quantity

123 – 129 7 N Allentown, PA On-Order See description above.


Quantity

130 – 136 7 N Fresno, CA On-Order Quantity See description above.

137 – 143 7 N Fairfield, OH On-Order Quantity See description above.

144 – 150 7 N DC On-Order Quantity Reserved for future use.

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

158 – 164 7 N Publisher Price The U.S. Publisher Supplied Price.

Please note: Ingram is NOT responsible for the


accuracy of the data in this field.

165 1 A, N, Blank Filler 1

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%"

169 – 178 10 A, N, Blank Filler 2

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.

182 1 A, N Roseburg, OR Stock Flag See description above.

183 1 A, N Ft. Wayne, IN Stock Flag See description above.

184 1 A, N Chambersburg, PA Stock Flag See description above.

185 1 A,N Allentown, PA Stock Flag See description above.

186 1 A,N Fresno, CA Stock Flag See description above.

187 1 A,N Fairfield, OH Stock Flag See description above.

188 1 Blank DC Stock Flag Reserved for future use.

Data Services | FTP, Inventory Implementation Guide 1


Position Length Format Field Name Description

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.

205 1 A, N Returnable Indicator "Y" – Title is returnable.


"N" – Title is NOT returnable.

Please note: Please see Return Date (position 206-


213) for allotted time frame for return.

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.

214 – 218 5 A, N, Blank Filler 3

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.

Please note: The USPS defines the rules for the


use of Media Mail – please visit their web site for
more information, www.usps.gov.

221 1 A, N Product Type Title classification assigned by Ingram. See


reference file, inventory\prodtp.txt for complete
list of values.

222 1 A, N Imprintable Indicator "Y" – Title is eligible to for a personal imprinting


preformed by Ingram.
"N" – title is NOT eligible for imprinting.

223 1 A, N Indexable Indicator "Y" – Title is eligible to for indexing preformed by


Ingram.
"N" – Title is NOT eligible for indexing.

224 – 238 15 A, N, Blank Filler 4

239 – 244 6 N Weight Title weight in pounds. Two decimals implied.


E.g., "000025" = .25 pounds.

245 – 255 11 A, N, Blank Filler 5

Data Services | FTP, Inventory Implementation Guide 2


Position Length Format Field Name Description

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.

260 – 264 5 A, N, Blank Filler 6

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.

Please note: The Country Exclusion file can be


used to determine which titles are Restricted for
Sale to a specific country.

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.

271 1 A, N, Blank Filler 7

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.

Possible values include:


"PR" – reproductions, previously published titles
that are now in the public domain.
"PC" – compilations, collections of public
information often gathered from internet Web sites.

285 – 301 17 A, N, Blank Filler 8

Data Services | FTP, Inventory Implementation Guide 3


Inventory Supplemental Files
Inventory Country Exclusion file
Certain export destinations are subject to trade sanctions, embargoes and other restrictions under United States law
and these restrictions may apply to both U.S. and International shipments. The Restricted by Country file contains
an EAN and a three-digit Alpha Country Code which signifies that the title in restricted for sale to the country that
will receive the titles.

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 Usage Suggestions


You can use this file with the Restricted Code field in the StockV2 file to exclude titles from showing as supplied by
Ingram for any shipments to a specific country. Use the Country Exclusion file to determine the specific countries.

Example – for EAN: 9788883709715


StockV2 Restricted Code = "C" – Available in the United States and some other countries.

Country Exclusion file:


"9788883709715","MHL" – Marshall Islands
"9788883709715","ZAR" – Zaire

File Format
This file specification adheres to the following:

• File Format: comma-delimited


• Record Length: 21 characters
• Text Qualifier: double quote
• Line Terminator: carriage return line feed
• Field Format Key
o A, N – Alpha Numeric (Text / String)
o DT – Date / Time
o N – Numeric
Column Length Format Field Name Description
1 13 A, N EAN EAN or ISBN-13. The Bookland International Article Number is
the Ingram Primary Item Identifier, will be present on ALL titles,
and can be used to link to other Ingram data files.
Please note: For titles that are not assigned an EAN, Ingram will
use the Universal Product Code (UPC) with a leading zero.
2 3 A, N Country Code Contains a three-digit alpha Country code. See reference file,
inventory\country.txt for complete list of values.

Data Services | FTP, Inventory Implementation Guide 4


Inventory Supplemental Files (continued)
Inventory Estimated Time of Arrival (ETA) File
This file provides an estimate time of arrival (ETA) for titles that are temporarily out of stock and On-Order with the
publisher. Ingram uses a historical publisher fulfillment performance to calculate the ETA for each of the Ingram
Distribution Centers (DC).

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 Format: comma-delimited


• Record Length: 80 characters
• Text Qualifier: none
• Line Terminator: carriage return line feed
• Numeric Fields: right justified and zero filled
• Decimal: Implied two decimals for all Price fields
• Date/Time Format: YYYYMMDD
• Field Format Key
o A, N – Alpha Numeric (Text / String)
o DT – Date / Time
o N – Numeric
Column Length Format Field Name Description
1 13 A, N EAN EAN or ISBN-13. The Bookland International Article Number is the
Ingram Primary Item Identifier, will be present on ALL titles, and can
be used to link to other Ingram data files.
Please note: For titles that are not assigned an EAN, Ingram will use
the Universal Product Code (UPC) with a leading zero.
2 2 A, N Ingram Distribution “BB” = Allentown, PA
Center Code "CI" = Chambersburg, PA
"DD" = Ft Wayne, IN
"EE" = Roseburg, OR
“FF” = Fairfield, OH
“JJ” = Fresno, CA
"NV" = La Vergne, TN
3 8 DT Estimated Time of Date that the title is predicted to be received in the DC.
Arrival
4 55 A, N, Blank Filler 1

Data Services | FTP, Inventory Implementation Guide 5


Inventory Supplemental Files (continued)
Inventory International Price File
This file supplies Ingram customers with the publisher supplied price for International currencies. Ingram currently
captures the Suggested Retail (SRP) and the Publisher Supplied Price in United States and Canadian dollars. Please
see the StockV2 file for the U.S. Suggested Retail Price and the U.S. Publisher Supplied Price.

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 Format: comma-delimited


• Record Length: 80 characters
• Text Qualifier: None
• Line Terminator: carriage return line feed
• Numeric Fields: right justified and zero filled
• Decimal: Implied two decimals for all Price fields
• Date/Time Format: YYYYMMDD
• Field Format Key
o A, N – Alpha Numeric (Text / String)
o DT – Date / Time
o N – Numeric
Column Length Format Field Name Description
1 13 A, N EAN EAN or ISBN-13. The Bookland International Article Number is the
Ingram Primary Item Identifier, will be present on ALL titles, and can
be used to link to other Ingram data files.
Please note: For titles that are not assigned an EAN, Ingram will use
the Universal Product Code (UPC) with a leading zero.
2 3 A, N Currency Code International Organization for Standardization (ISO) Currency Code
e.g., "CAD" = Canada
3 7 N Publisher Supplied Price This is the Publisher Supplied Price. e.g., "0001799" = $17.99

Please note: Ingram is NOT responsible for the accuracy of the data in
this field.
4 54 A, N, Blank Filler 1

Data Services | FTP, Inventory Implementation Guide 6


Frequently Asked Questions
This is a list of the common questions regarding the data and data files.

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.

Data Services | FTP, Inventory Implementation Guide 7


Glossary
Term Definition
Adds Adds are titles that have been added to the inventory file and are available to sell.
Available To Sell This refers to titles that are available to sell; however, some restrictions may apply. You are responsible for filtering
titles that are not available to sell; please see the Restricted Code and County Exclusion file for assistance with
identifying the title restrictions.
CDT Central Daylight Time (GMT - 5) is observed during the summer months.
Change Changes may have occurred in the following fields: On-Hand or On-Order Quantity, Discount Level, Price, Return
Indicator, Return Date, On Sale Date, Publisher Status, Weight or Restricted Code. For the daily and weekly Delta
files, changes can occur to any field in the file.
CT Central Time (Greenwich mean time, GMT - 6) and central daylight time (GMT - 5) is observed during the summer
months.
Current Date Current Date specifies a date that is based on a reading the time-of-day.
Data Slice Data Slices were developed for booksellers that focus on niche markets or that require a subset or pre-defined
portion of the titles available from Ingram, e.g., Self-Help, Top 250,000, Spanish Language, Fiction, Children's
titles, etc. A subscription is required to access the Slice inventory files.
Delete When a title has been discontinued and is no longer available to purchase from Ingram, the inventory record will no
longer appear in the Full inventory files. A delete or zero record is reported once in the Delta files.
Delta The Delta will contain incremental updates for titles, where select or all fields have changed, a record has been
added, or deleted. The Delta is created when comparing the current Full file with the previously created Full file or,
in the case of the daily and weekly Delta files; a change has been made to the inventory record since the last file
was generated.

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".

Data Services | FTP, Inventory Implementation Guide 8


Document History
This section describes the changes since the previously published release of this guide, including the change history
from the previous version. (Sorted descending by Version, Date, alphabetical by Activity, then by Field Name)

The version and release are represented in the abbreviated format for version.release, X.X, in this table.

Current Version Change History

Version Date Activity Section/Field Name Notes

2.10 11/12/2018 Change FTP Folder \Inventory_Top_Titles (International Only)

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

Company Email Phone Business Hours


IBC & Spring Arbor [email protected] (800) 937-8200 Extended

International [email protected] (615) 793-5000, ext 32622 or Extended


(800) 289-0687

Additional Contacts

Company Email Phone Business Hours


Development, Testing and [email protected] Normal
Production

Electronic Ordering [email protected] (800) 234-6737 Extended

Setup and Login Instructions, Data [email protected] (800) 937-7978, option 6 Normal
Sales, and Administration

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.

Data Services | FTP, Inventory Implementation Guide 9

You might also like