eBay File Exchange
User Guide
eBay Inc.
Date: March, 2007
Version: 1.5.2
2 eBay File Exchange Basic Template Instructions
Document History
Version Date
1.5 May, 2006
1.5.1 October, 2006
1.5.2 March, 2007
Copyright © 2007 eBay Inc. All rights reserved. The information contained in this document is CONFIDENTIAL and PROPRIETARY in
nature, and subject to the rights and ownership of eBay Inc. Any and all unauthorized copying or use of the contents hereof is prohibited.
The eBay logo and experience are trademarks of eBay Inc. All other brand or product names are or may be trademarks or registered trademarks
of their respective owners.
eBay Inc.
2145 Hamilton Ave.
San Jose, CA 95125
408.558.7400
fax 408.558.7401
eBay File Exchange Basic Template Instructions 2
3 eBay File Exchange Basic Template Instructions
Content
Advanced Instructions 5
VerifyAdd your Listings ....................................................................................................................5
Revising your Listings......................................................................................................................5
Relisting your Items..........................................................................................................................5
Ending your Listings.........................................................................................................................5
Updating Item Status........................................................................................................................6
Payment Status .........................................................................................................................6
Shipping Status .........................................................................................................................6
Leave Feedback........................................................................................................................6
Using Programmatic Instructions to Upload Files............................................................................6
Requesting an eBay Token .......................................................................................................7
Sample HTTP Post Request .....................................................................................................7
HTTP Post Request Components.............................................................................................7
Using Programmatic Instructions to Download Files .......................................................................8
Reference Material 9
File Conventions ..............................................................................................................................9
File Size and Content Rules......................................................................................................9
Using Quotation Marks as Text Qualifiers.................................................................................9
Your Upload Limit....................................................................................................................10
Using “Info” or Comment-only Rows .......................................................................................10
Required Fields .......................................................................................................................10
Including Multiple Actions in one File ......................................................................................11
Including Excess Fields for a Given Action .............................................................................11
Metadata Cell Information .......................................................................................................12
Overriding Metadata..........................................................................................................12
SiteID ................................................................................................................................13
Country..............................................................................................................................13
Currency............................................................................................................................16
API Compatibility Level.....................................................................................................16
Character Set....................................................................................................................16
Using Smart Headers ..............................................................................................................17
Understanding Field Relationships..........................................................................................17
Non-U.S. Site Information..............................................................................................................17
Default Template Formats.......................................................................................................17
Sites that Support Catalog Listing...........................................................................................18
Template Data Field Variations...............................................................................................19
ShippingService-n:Option Data Field Values..........................................................................22
Complete Data Field Dictionary .....................................................................................................32
Required Fields .......................................................................................................................32
eBay File Exchange Basic Template Instructions 3
4 eBay File Exchange Basic Template Instructions
Listing Details and Display Fields............................................................................................34
Pricing Fields ...........................................................................................................................36
Tax Fields ................................................................................................................................37
Gift Fields.................................................................................................................................37
Payment and Checkout Fields.................................................................................................38
Shipping Fields........................................................................................................................40
Payment, Shipping and Feedback Status Fields.....................................................................44
Load Results Report Fields .....................................................................................................45
Active Listings Data Fields ......................................................................................................46
Glossary 47
Index 49
eBay File Exchange Basic Template Instructions 4
5 eBay File Exchange Basic Template Instructions
Advanced Instructions
The following instructions describe how to perform more advanced functions in eBay File
Exchange.
VerifyAdd your Listings
This action tests your file format and listings BEFORE you upload them to eBay File Exchange. In
other words, this action is exactly like an Add but it doesn’t result in an added file; instead, it
allows you to test your upload file for any errors.
It verifies each record on the add file and returns a results file containing any associated fee data,
error warnings, etc. (If your VerifyAdd is successful, eBay File Exchange will return all the fee
amounts for each listing but no ItemIDs because nothing was actually added to the site.) When
you’re ready, you can use the Add action using the same values as those in your VerifyAdd file,
confident that they are correct and that your items will be listed on eBay without any errors.
The required fields for this action are exactly the same as those for “Add,” except that you use
“VerifyAdd” in the Action column instead.
Revising your Listings
Revising your listings means making a change to the listing in some way; for example, changing
the BuyItNow price.
To avoid errors when you upload your revised listings, include only the required fields and the
fields you are revising. The required fields for this action are:
o Action=Revise
o ItemID
An active listings report is available for download and contains a list of all active listings, including
a flag indicating that you can revise an item.
Refer to eBay online help for more detailed revising instructions.
Relisting your Items
Relisting your ended items means listing an item for sale again after it did not sell the first time.
(You cannot relist an item until either its auction ends or you end the listing yourself.) If you sell a
relisted item, eBay automatically refunds one of the two relisting fees (some restrictions apply).
To avoid errors when you relist, include only the required fields, which are:
o Action=Relist
o ItemID
Refer to eBay online help for more detailed relisting instructions.
Ending your Listings
Use this action to remove your listings from eBay. To avoid errors when you end your listing,
include only the required fields, which are:
o Action=End
eBay File Exchange Basic Template Instructions 5
6 eBay File Exchange Basic Template Instructions
o ItemID
o EndCode (values: LostorBroken, NotAvailable, Incorrect, OtherListingError)
Updating Item Status
Using the Status action, you can mark items Paid and Shipped and also Leave Feedback for
buyers in bulk. In fact, you can do all three with just one Status action in one row of your file. You
can only use Status for items that have sold; you cannot use this action on unsold or active
listings. For details on these fields, see the Payment, Shipping and Feedback Status Fields section
on page 80.
Payment Status
To mark an item paid, include the following fields in your upload file:
o Action=Status
o ItemID
o PaymentStatus=1
Shipping Status
To mark an item shipped, include the following fields in your upload file:
o Action=Status
o ItemID
o ShippingStatus=1
Leave Feedback
To leave feedback for buyers, include the following fields in your upload file:
o Action=Status
o ItemID
o BuyerUserID: eBay User ID
o FeedbackType: Positive, negative or neutral
o Feedback: Text
Using Programmatic Instructions to Upload Files
ADVANCED USERS ONLY! ONLY EXPERIENCED USERS SHOULD USE THIS METHOD TO UPLOAD DATA
TO THE E
BAY FILE EXCHANGE WEBSITE.
To upload your file programmatically, you must send an HTTP post request to eBay File
Exchange server to accept the request contents. Perform the following steps:
1. Download and complete the appropriate eBay File Exchange template.
2. Get a security token from eBay File Exchange, described in the next section.
3. Initiate an HTTPS connection and then post your data file with your token to the eBay File
Exchange Web address:
eBay File Exchange Basic Template Instructions 6
7 eBay File Exchange Basic Template Instructions
https://bulksell.ebay.com.sg/ws/eBayISAPI.dll?FileExchangeUploadForm
After eBay has processed your data file, you will receive an email that includes a URL to access
your Load Results Report. You can also get your upload results file by posting the following
parameters:
• jobId
• token
Requesting an eBay Token
As a non-Web authenticated user, you can only upload to eBay File Exchange using a token. Go
here to request one. Copy this token, paste it into a file, and save this file on your local disk in a
secure location (eBay recommends using a firewall). Do not share it with others. You will need to
include this token when you post your inventory data file.
The security token will serve as a key for entry to eBay File Exchange and will be valid for one
year, after which you must request another one.
Sample HTTP Post Request
POST /path/to/upload/script HTTP/1.0
Connection: Keep-Alive
User-Agent: My Client App v1.0
Host: https://bulksell.ebay.com/ws/eBayISAPI.dll?FileExchangeUploadForm
Content-type: multipart/form-data; boundary=THIS_STRING_SEPARATES
Content-Length: 256
--THIS_STRING_SEPARATES
Content-Disposition: form-data; name=”token”
12345678987654321
--THIS_STRING_SEPARATES
Content-Disposition: form-data; name=”file”; filename=”listings.csv”
Content-Type: text/csv
... contents of listings.csv ...
--THIS_STRING_SEPARATES—
HTTP Post Request Components
Notice that the HTTP Post Request must always include the following components:
- In the first line, the method to be applied to the resource, the identifier of the resource, and
the protocol version in use, such as:
POST /path/to/upload/script HTTP/1.0
- The connection, user-agent and host information is next:
Connection: Keep-Alive
User-Agent: My Client App v1.0
Host: https://bulksell.ebay.com/ws/eBayISAPI.dll?FileExchangeUploadForm
eBay File Exchange Basic Template Instructions 7
8 eBay File Exchange Basic Template Instructions
- Header containing file content and length information:
Content-type: multipart/form-data; boundary=THIS_STRING_SEPARATES
Content-Length: 256
- Contents, which includes your security token and then the actual file contents you want to
upload:
--THIS_STRING_SEPARATES
Content-Disposition: form-data; name=”token”
12345678987654321
--THIS_STRING_SEPARATES
Content-Disposition: form-data; name=”file”; filename=”listings.csv”
Content-Type: text/csv
... contents of listings.csv ...
--THIS_STRING_SEPARATES—
Using Programmatic Instructions to Download Files
ADVANCED USERS ONLY! ONLY EXPERIENCED USERS SHOULD USE THIS METHOD TO DOWNLOAD
DATA TO THE E
BAY FILE EXCHANGE WEBSITE.
To download your file programmatically, you must send an HTTP get request to eBay File
Exchange server to accept the request contents. Perform the following steps:
1. Download and complete the appropriate eBay File Exchange template.
2. Get a security token from eBay File Exchange, described in Requesting a token.
3. Initiate an HTTPS connection and then post your data file with your token to the eBay File
Exchange Web address:
https://bulksell.ebay.com.sg/ws/eBayISAPI.dll?FileExchangeProgrammaticDownload
After eBay has processed your data file, you will receive an email that includes a URL to access
your Load Results Report. You can also get their download results file by posting the following
parameters:
• refId
• token
eBay File Exchange Basic Template Instructions 8
9 eBay File Exchange Basic Template Instructions
Reference Material
File Conventions
File Size and Content Rules
o Files must be in one of these formats: comma-separated (.csv), semicolon-delimited
(.csv) or tab-delimited (.txt).
o A single file cannot be larger than 15 MB or the upload will fail.
o Files must contain data for each required field. Each required data field is denoted with
an asterisk (*) before its name. All other fields are optional (although some contain
dependencies, so that if you include one, you may be required to include another; see
the
Complete Data Field Dictionary table on page 32 for more information).
o Header (field) names are not case-sensitive: It does not matter whether you capitalize
the letters in the data field names or not. For example, eBay File Exchange will
recognize both “paypalaccepted” and “PayPalAccepted” as the same field. However,
we recommend that you use the header (field) names as they are provided in this
guide.
o Header (field) values are case-sensitive: When you provide particular string values for
data fields, make sure they conform to the case sensitivity noted in the data field
templates in this user guide. For example, “VerifyAdd” is an acceptable value for the
Action field; “verifyadd” is not.
o The Action field must always be the first cell and row in a file; it doesn’t matter what
order the rest of the data fields are in. (See Using “Info” or Comment-only Rows.)
o Do not include headers in a row of data.
o File Exchange does not support multi-line listings. Do not include extra lines, “new-
line” characters or carriage returns. However, you can still enter description and return
policy text using <BR> and <P> in HTML.
Using Quotation Marks as Text Qualifiers
When you use certain punctuation in CSV or .txt files in text fields, you must put quotation marks
around the text, as described in the table below.
Note: Use plain quotation marks ("); do not use smart quotes (“”). If you save an Excel file in
CSV or .txt format, Excel automatically adds the required text qualifiers.
Punctuation Where to put the quotes Enter it as
Comma or semicolon, for example:
Factory sealed, still in shrink wrap.
Put the text inside a set of quotes. "Factory sealed, still in shrink wrap."
Quotation marks inside a text field,
to denote a nickname, for example:
Clarence "Lumpy" Rutherford)
Put the quoted word(s) inside
another set of quotes and also put
quotes around the entire text field.
"Clarence ""Lumpy"" Rutherford"
Soft returns (line feeds), for
example: 123 [Alt+Ent] 456
Put the text inside a set of quotes. "123[Alt+Ent]456"
eBay File Exchange Basic Template Instructions 9
10 eBay File Exchange Basic Template Instructions
C
AUTION! USE PLAIN QUOTATION MARKS ("); DO NOT USE SMART QUOTES (“”).
HELPFUL HINT: IF YOU SAVE AN EXCEL FILE IN CSV OR .TXT FORMAT, EXCEL WILL
AUTOMATICALLY ADD THE REQUIRED TEXT QUALIFIERS FOR YOU
.
Your Upload Limit
You can only upload 1,000 actions every 24 hours. If you submit a file that exceeds this limit, the
entire file will fail and you will have to resubmit a smaller upload file. To request an increase in
your upload limit,
Contact Customer Support.
Using “Info” or Comment-only Rows
If you use “Info” in the first column of a row—which is always an Action field—this denotes that
this row is NOT requesting any action, but rather is an informational (or comment) row. You can
use the Info row to “comment out” notes about the flat file, without risking any processing
errors. An example file with Info rows is shown below.
Required Fields
Upload files must contain required fields. An asterisk (*) precedes each required field name; all
other fields are optional. (Some contain dependencies, so that if you use one, you may need to
include another). Different eBay File Exchange actions require different fields and are listed in the
table below.
Action Type and Corresponding Required Data Fields
Data Field Name
Add or VerifyAdd
(Non- Catalog)
Add or VerifyAdd
(Catalog)
Revise Relist End Status
*Action
*ProductIDType
*ProductIDValue
eBay File Exchange Basic Template Instructions 10
11 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 11
Action Type and Corresponding Required Data Fields
Add or VerifyAdd Add or VerifyAdd Revise Relist End Status
Data Field Name
(Non- Catalog) (Catalog)
*ItemID
*Category
*Title
*Description
*Quantity
*StartPrice
*Duration
*Country (also stored in
metadata cell)
*SiteID (also stored in
metadata cell)
*Location
*Currency (also stored in
metadata cell)
*EndCode
Including Multiple Actions in one File
Your uploaded flat files can contain any combination of actions. For example, you can upload a
file that only adds listings; you can also upload a file that contains added listings and revised
listings. However, you can only perform one action per row. Do not attempt to submit a file that
contains multiple actions for the same item as this may cause errors.
Including Excess Fields for a Given Action
If you submit a file that contains excess fields for a given action, then eBay File Exchange will
ignore those excess fields and process the action if all other required and eligible fields are valid.
For example, if you try to End a listing using the End action, but supply unnecessary fields like
“Description,” then eBay File Exchange will ignore those fields and end the listing.
12 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 12
Metadata Cell Information
eBay Term
METADATA: ALSO KNOWN AS “DATA ABOUT DATA,” METADATA IS THE INFORMATION THAT IS
ENCODED IN
, AND DESCRIBES ASPECTS OF, THE LISTING TEMPLATES, SUCH AS SITEID OR
COUNTRY. METADATA ALSO PROVIDES A MEANS TO CONTROL EACH HEADER’S VALUES. EBAY
FILE EXCHANGE SUPPLIES METADATA IN THE FIRST ROW OF THE FIRST COLUMN OF EACH
UPLOAD FILE
, WHICH IS THE FIRST ACTION CELL.
The metadata includes:
o SiteID
o Country
o Currency
o API Compatibility Level
o Character Set
The metadata cell should begin with the word “*Action” and the contents should follow
within parentheses in ASCII. Each piece of metadata should be separated by a pipe “|” to
isolate it from the Action tag.
For example, the first cell of an eBay File Exchange upload could be the metadata circled in
the example shown below:
*Action(SiteID=US|Country=US|Currency=USD|Version=403|CC= ISO-8859-1)
OVERRIDING METADATA
ADVANCED USERS ONLY! CHANGING METADATA VALUES CAN CAUSE UPLOAD ERRORS; DO
NOT OVERRIDE THE METADATA VALUES IN YOUR FILE UNLESS YOU ARE AN EXPERIENCED USER
.
If you change any values, do not add spaces between the data. You can alter data in several
ways:
o Manually edit the SiteID, Country and Currency values.
o Add a SiteID, Country or Currency field (column) to your file templates, which
then overrides the values in the metadata cell.
o Enter a data field and the one corresponding value you want to set for it in your
file. For example, if you want every item in your file to have a StartPrice of $1.99,
13 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 13
you can enter StartPrice=1.99 in the metadata cell and this value will be used for
every item in your file. The metadata would look like this:
*Action(SiteID=US|Country=US|Currency=USD|Version=403|CC=ISO-8859-
1|StartPrice=1.99)
SITEID
The SiteID represents the site where you want to list your items. The default SiteID is taken
from the site where you downloaded your template. For example, if you want to list on the
Germany site, make sure that SiteID=Germany. Valid values are provided in the table below.
SiteID Metadata Values
Site SiteID Valid Values
Australia Australia
Austria Austria
Belgium (Dutch) Belgium_Dutch
Belgium (French) Belgium_French
Canada Canada
China China
eBay Motors eBayMotors
France France
Germany Germany
India India
Italy Italy
Netherlands Netherlands
Spain Spain
Switzerland Switzerland
Taiwan Taiwan
United Kingdom UK
United States US
COUNTRY
The Country represents the country in which you’re located. The default Country is taken
from the site where you downloaded your template.
This metadata value is required for the Add and VerifyAdd actions but is NOT required for
the Revise, Relist, End and Status actions. (If you delete the default Country metadata from
your template and you need to Add or VerifyAdd, you must provide a Country field with
valid values entered for all records.)
14 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 14
The 240 country codes in the table below are established by ISO-3166-1.
Country Metadata Values
Country/Site
Valid
Values
Country/Site
Valid
Values
Country/Site
Valid
Values
Afghanistan AF Germany DE Norway NO
Aland Islands AX Ghana GH Oman OM
Albania AL Gibraltar GI Pakistan PK
Algeria DZ Greece GR Palau PW
American Samoa AS Greenland GL Palestinian Territory,
Occupied
PS
Andorra AD Grenada GD Panama PA
Angola AO Guadeloupe GP Papua New Guinea PG
Anguilla AI Guam GU Paraguay PY
Antarctica AQ Guatemala GT Peru PE
Antigua and
Barbuda
AG Guinea GN Philippines PH
Argentina AR Guinea-Bissau GW Pitcairn PN
Armenia AM Guyana GY Poland PL
Aruba AW Haiti HT Portugal PT
Australia AU Heard Island and
McDonald Islands
HM Puerto Rico PR
Austria AT Holy See (Vatican City
State)
VA Qatar QA
Azerbaijan AZ Honduras HN Reunion RE
Bahamas BS Hong Kong HK Romania RO
Bahrain BH Hungary HU Russian Federation RU
Bangladesh BD Iceland IS Rwanda RW
Barbados BB India IN Saint Helena SH
Belarus BY Indonesia ID Saint Kitts and Nevis KN
Belgium BE Iran, Islamic Republic of IR Saint Lucia LC
Belize BZ Iraq IQ Saint Pierre and Miquelon PM
Benin BJ Ireland IE Saint Vincent and the
Grenadines
VC
Bermuda BM Israel IL Samoa WS
Bhutan BT Italy IT San Marino SM
Bolivia BO Jamaica JM Sao Tome and Principe ST
Bosnia and
Herzegovina
BA Japan JP Saudi Arabia SA
Botswana BW Jordan JO Senegal SN
Bouvet Island BV Kazakhstan KZ Serbia and Montenegro CS
Brazil BR Kenya KE Seychelles SC
British Indian
Ocean Territory
IO Kiribati KI Sierra Leone SL
Brunei
Darussalam
BN Korea, Democratic
People’s Republic of
KP Singapore SG
Bulgaria BG Korea, Republic of KR Slovakia SK
15 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 15
Country Metadata Values
Valid Valid Valid
Country/Site Country/Site Country/Site
Values Values Values
Burkina Faso BF Kuwait KW Slovenia SI
Burundi BI Kyrgyzstan KG Solomon Islands SB
Cambodia KH Lao People’s Democratic
Republic
LA Somalia SO
Cameroon CM Latvia LV South Africa ZA
Canada CA Lebanon LB South Georgia and the
South Sandwich Islands
GS
Cape Verde CV Lesotho LS Spain ES
Cayman Islands KY Liberia LR Sri Lanka LK
Central African
Republic
CF Libyan Arab Jamahiriya LY Sudan SD
Chad TD Liechtenstein LI Suriname SR
Chile CL Lithuania LT Svalbard and Jan Mayen SJ
China CN Luxembourg LU Swaziland SZ
Christmas Island CX Macao MO Sweden SE
Cocos (Keeling)
Islands
CC Macedonia, the Former
Yugoslav Republic of
MK Switzerland CH
Colombia CO Madagascar MG Syrian Arab Republic SY
Comoros KM Malawi MW Taiwan, Province of China TW
Congo CG Malaysia MY Tajikistan TJ
Congo, the
Democratic
Republic of the
CD Maldives MV Tanzania, United Republic
of
TZ
Cook Islands CK Mali ML Thailand TH
Costa Rica CR Malta MT Timor-Leste TL
Cote D’Ivoire CI Marshall Islands MH Togo TG
Croatia HR Martinique MQ Tokelau TK
Cuba CU Mauritania MR Tonga TO
Cyprus CY Mauritius MU Trinidad and Tobago TT
Czech Republic CZ Mayotte YT Tunisia TN
Denmark DK Mexico MX Turkey TR
Djibouti DJ Micronesia, Federate
States of
FM Turkmenistan TM
Dominica DM Moldova, Republic of MD Turks and Caicos Islands TC
Dominican
Republic
DO Monaco MC Tuvalu TV
Ecuador EC Mongolia MN Uganda UG
Egypt EG Montserrat MS Ukraine UA
El Salvador SV Morocco MA United Arab Emirates AE
Equatorial Guinea GQ Mozambique MZ United Kingdom GB
Eritrea ER Myanmar MM United States US
Estonia EE Namibia NA United States Minor
Outlying Islands
UM
Ethiopia ET Nauru NR Uruguay UY
Falkland Islands
(Malvinas)
FK Nepal NP Uzbekistan UZ
16 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 16
Country Metadata Values
Valid Valid Valid
Country/Site Country/Site Country/Site
Values Values Values
Faroe Islands FO Netherlands NL Vanuatu VU
Fiji FJ Netherlands Antilles AN Vatican City State, see
Holy See
Finland FI New Caledonia NC Venezuela VE
France FR New Zealand NZ Viet Nam VN
French Guiana GF Nicaragua NI Virgin Islands, British VG
French Polynesia PF Niger NE Wallis and Futuna WF
French Southern
Territories
TF Nigeria NG Western Sahara EH
Gabon GA Niue NU Yemen YE
Gambia GM Norfolk Island NF Zambia ZM
Georgia GE Northern Mariana Islands MP Zimbabwe ZW
CURRENCY
Currency represents the currency in which you want to list your items. The default Currency
value provided is taken from the site where you downloaded your template. For example,
templates downloaded from the United States will have SiteID=US and Currency=USD.
Valid values are provided in the table below.
Currency Name Valid CurrencyID
US Dollar USD
Canadian Dollar CAD
UK Pound Sterling GBP
Australian Dollar AUD
Euro EUR
Swiss Franc CHF
Taiwanese Dollar TWD
Renminbi CNY
Indian Rupee INR
API COMPATIBILITY LEVEL
This refers to the eBay API (Application Program Interface); for example, Version=403. This
metadata is related to internal eBay system details. Do not alter these values.
CHARACTER SET
This refers to the Character Set metadata; for example, CC=GBK. The particular Character
Set in your file’s metadata will vary, depending on the site where you downloaded your
template. Possible Character Sets include ISO-8859-1, GBK, Big5, CP1252, and UTF-8 (the
names are not case-sensitive). This metadata is related to eBay system details. Do not alter
these values.
17 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 17
Using Smart Headers
In eBay File Exchange, you can use smart headers, which set a global file-level default
preference per column within each file, using the “=” sign within the header to designate a
default value for that entire column. For example, you can convert the “PayPalEmailAddress”
header to “PayPalEmailAddress=userid@mydomain.com,” to make the value of every
subsequent row in this column be “[email protected].”
If you want to use smart headers, follow these guidelines:
o Do not use spaces between the header name and the header value you provide.
For example, category 552 should be entered as “Category=552.”
o Follow the rules for the data field when entering a value. For example, the valid
values for “BoldTitle=” are “1” (true) or “0” (false), the valid values for
“Description=” is any text up to 500,000 characters, and so on.
o You cannot set a Smart Header for the Action field; you must explicitly list this
value for every item or row.
o If you include an “=” sign after the field header, but do NOT provide a value, eBay
File Exchange will treat this as a valid field header that has no default or global
value associated with it and will look for a value in each row for this field/column.
o Even if you set a Smart Header value, you can still override it on a row-by-row
basis.
o If you provide an override value that is invalid for that field, the listing will fail and
you will receive a warning in the results file for that row.
o You can also override a Smart Header with a minus symbol “-“ in individual cells.
eBay File Exchange will treat these cells as having no data at all.
Understanding Field Relationships
Many data fields you might use in your upload file have defined relationships; that is, the use
of one or perhaps the value you assign it can affect the values or use of other fields.
Improperly used fields can cause two common error messages in your results file:
o Inconsistent shipping parameters
o Inconsistent payment methods
All possible data fields and their relationships to other fields are described in the
Complete
Data Field Dictionary
section on page 32. Refer to those tables for more details.
Non-U.S. Site Information
This section includes eBay File Exchange information related to non-U.S. eBay sites only.
Default Template Formats
The table below lists the default template formats you can download from each eBay File
Exchange site.
Flat-file Formats for Each Site
18 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 18
Country Flat-file Format
US Comma-separated
CA Comma-separated
UK Comma-separated
AU Comma-separated
TW Comma-separated
CN Comma-separated
IN Comma-separated
DE Semicolon-delimited
AT Semicolon-delimited
CH Semicolon-delimited
FR Semicolon-delimited
BENL Semicolon-delimited
BEFR Semicolon-delimited
NL Semicolon-delimited
IT Semicolon-delimited
ES Semicolon-delimited
Sites that Support Catalog Listing
CAUTION! NOT ALL EBAY SITES SUPPORT CATALOG LISTING; THE TABLE BELOW SHOWS THE
E
BAY SITES THAT DO (USING UPCS OR ISBNS). IF YOU TRY TO LIST ITEMS USING ISBN OR
UPCS ON SITES THAT DO NOT SUPPORT CATALOG LISTING, YOU WILL RECEIVE AN ERROR.
eBay Sites and Catalog Listing
Site Books Movies Music Videogames
United States
Canada
Germany / Austria /
Switzerland
Belgium (Dutch and French)
France
Netherlands
United Kingdom
Australia Does not support catalog listing
Italy Does not support catalog listing
Spain Does not support catalog listing
India Does not support catalog listing
19 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 19
eBay Sites and Catalog Listing
Site Books Movies Music Videogames
China Does not support catalog listing
Taiwan Does not support catalog listing
Template Data Field Variations
The eBay File Exchange base templates vary from site to site. Refer to the table below for the
template fields and sites affected. Search the eBay API Documentation for
“Internationalization” to find detailed information on eBay site differences. (You must have
an eBay developer account to access this English-language page.)
Template Data Field Variations
Data Field Name Description Sites Affected
PaymentOther Specifies whether “other” is an acceptable payment method.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
AU, FR, IT, NL,
BE
VATPercent VAT (Value Added Tax) rate for the item. You can also print an invoice that
includes the item's net price, VAT percent, VAT amount, and total price, as
required by European law. Because VAT rates vary depending on the item
and on the user's country of residence, you are responsible for entering the
correct VAT rate; eBay does not calculate it. To specify a VATPercent, you
must have a VAT-ID registered with eBay and must be listing the item on a
site in the European Union or Switzerland.
Character limit: Max length 5 characters (max precision 3 decimal places)
Type: Double
Valid entry:
Field Relationship: When you specify the VATPercent, the VAT information
appears on the item's listing page. The View Item page displays the precision
to two decimal places with no trailing zeros. However, the full value you input
is stored.
UK, DE, AT, IT,
FR, BE, NL, ES,
CH
StartPrice
Required! Minimum acceptable bid for the item.
For Fixed Price listing, this is the price at which you are selling the item.
Because many European currencies use commas instead of periods for
money values, you can use commas or periods. For example: 3,95 (EUR).
Character limit: Max length 16, including decimal point or comma
Type: Money
Valid entry: for example, 10.00
Field Relationship: For Auction listings.
DE, CH, IT, FR,
BE, NL, ES
CCAccepted Specifies whether credit card accepted as payment.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
UK, AT, DE, CH,
TW
CashOnPickup Specifies whether payment on pickup is an acceptable payment term.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
AT, DE, NL, BE
(NL), CH, TW,
CN
COD
Accept Cash on Delivery as payment.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
DE, AT, CH, IT,
FR, BE, NL, ES,
TW, CN
MOCashiers Specifies whether money orders and cashiers checks are accepted as
payment.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
US, CA, UK
(Postal), AU, FR,
IT, BE (Fr), TW
20 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 20
Template Data Field Variations
Data Field Name Description Sites Affected
PersonalCheck Specifies whether personal checks accepted as payment.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
US, CA, UK, AU,
FR, IT, ES, BE
MoneyXferAccepted Specifies whether direct transfer of money is acceptable payment. See the
eBay online help for more information about accepting direct money
transfers. Applicable for certain sites only.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
At least one of the payment methods (VisaMastercard, etc.) must be set to 1
(true). Payment methods are not applicable for Real Estate listings.
If you set MoneyXferAcceptedinCheckout to 1 (true) and Checkout has been
enabled for the seller, the value you pass in this argument is ignored and
MoneyXferAccepted is set to 1 (true) automatically.
If you set MoneyXferAcceptedinCheckout to 1 (true), but Checkout has been
disabled, the value you specified for MoneyXferAccepted is used (i.e.,
MoneyXferAcceptedinCheckout has no effect, as if it were never specified).
AU, AT, DE, FR,
IT, NL, ES, BE,
CH, TW, CN
MoneyXferAccepted
InCheckout
Specifies whether direct transfer of money is an acceptable payment method
in checkout. If the seller has bank account information on file and eBay
Checkout is enabled you (see the Checkout Preferences page in My eBay),
setting MoneyXferAcceptedinCheckout to 1 (true) causes the bank account
information to be displayed in Checkout. If 1 (true) is passed but Checkout
has been disabled, eBay returns a warning and resets
MoneyXferAcceptedinCheckout to 0 (false). See the
eBay online help for
more information about accepting direct money transfers in Checkout.
Applicable for certain sites only.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
At least one of the payment methods (VisaMastercard, etc.) must be set to 1
(true). Payment methods are not applicable for Real Estate listings.
AU, AT, DE, FR,
IT, NL, ES, BE,
CH, TW, CN
Escrow Specifies whether you want to offer escrow as a payment method. Escrow is
available only in certain non-US sites.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1
Field Relationship: You cannot use this field with real estate listings.
UK, AU, AT, DE,
FR, IT, NL, ES,
BE, TW, CN
NowandNew (Sofort
and Neu)
This field is only available to Germany (DE), Austria (AT), and
Switzerland (CH) sites. Specifies whether you are listing with NowandNew,
which is an enhancement to the Buy It Now format. Only applicable for Buy It
Now, Fixed-Price, and Store Inventory listings. When a Buy It Now item is
listed with Now & New, an alternative icon replaces the Buy It Now icon on
applicable eBay Web sites. Users can also filter search results to only
retrieve items that are listed with Now & New.
The requirements that you must meet to list with Now & New are the same as
the requirements for listing with Buy It Now (for example, your feedback
score). Search the
eBay API Documentation for “Internationalization” to find
these requirements for each eBay site. (You must have an eBay developer
account to access this English-language page.)
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: Only valid if you also specify: the item condition as new
and can be purchased immediately (i.e., are Buy It Now), offer a predefined
return policy, and specify shipping costs. Requires that you specify Return
Policy.
DE, AT, CH
21 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 21
Template Data Field Variations
Data Field Name Description Sites Affected
ShippingService-
1:AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-
1:Option
First shipping service type offered (within your country only).
Character limit: n/a
Type: String
Valid entry: See the ShippingService-n:Option Data Field Values section of
this guide for valid entry values for each site.
Field Relationship: Must be accompanied by ShippingService-1:Cost.
NOTE: The "ShippingService-1:Cost" field is not
needed when
"ShippingType=Calculated."
All sites.
ShippingService-
1:Priority
Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options;
if you only use one shipping service, this field is unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-2:
AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-
2:Option
Second shipping service type offered (within your country only).
Character limit: n/a
Type: String
Valid entry: See the ShippingService-n:Option Data Field Values section of
this guide for valid entry values for each site.
Field Relationship: Must be accompanied by ShippingService-1:Cost.
NOTE: The "ShippingService-1:Cost" field is not
needed when
"ShippingType=Calculated."
All sites.
ShippingService-
2:Priority
Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options;
if you only use one shipping service, this field is unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-3:
AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-
3:Option
Third shipping service type offered (within your country only).
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values section of
this guide for valid entry values for each site.
Field Relationship: Must be accompanied by ShippingService-1:Cost.
NOTE: The "ShippingService-1:Cost" field is not
needed when
"ShippingType=Calculated."
All sites.
ShippingService-
3:Priority
Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options;
if you only use one shipping service, this field is unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
22 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 22
Template Data Field Variations
Data Field Name Description Sites Affected
IntlShippingService-
1:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
IntlShippingService-
1:Priority
Your preferred presentation order for each international shipping service
option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international
shipping options; if you only use one shipping service, this field is
unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
IntlShippingService-
2:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
IntlShippingService-
2: Priority
Your preferred presentation order for each international shipping service
option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international
shipping options; if you only use one shipping service, this field is
unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
IntlShippingService-
3:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use either decimal point or comma)
Valid entry: Default is 0.00
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
IntlShippingService-
3:Priority
Your preferred presentation order for each international shipping service
option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international
shipping options; if you only use one shipping service, this field is
unnecessary.
US, UK, and CN;
Fixed Price items
only: CA, AU,
AT, DE, FR, IT,
NL, ES, BEFR,
BENL, CH, TW
ShippingService-n:Option Data Field Values
U.S. Site Shipping Service Option Values
Value Description
UPSGround (in/out) UPS Ground.
UPS3rdDay (in/out) UPS 3rd Day.
UPS2ndDay (in/out) UPS 2nd Day.
UPSNextDay (in/out) UPS Next Day.
USPSPriority (in/out) USPS Priority.
USPSParcel (in/out) USPS Parcel.
23 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 23
U.S. Site Shipping Service Option Values
Value Description
USPSMedia (in/out) USPS Media.
USPSFirstClass (in/out) USPS First Class.
ShippingMethodStandard (in/out) Reserved for internal or future use.
ShippingMethodExpress (in/out) Reserved for internal or future use.
USPSExpressMail (in/out) USPS Express Mail.
UPSNextDayAir (in/out) UPS Next Day Air.
UPS2DayAirAM (in/out) UPS Next Day Air.
Other (in/out) Other (see description).
LocalDelivery (in/out) Local Delivery/Pickup.
NotSelected (in/out) Not Selected.
InternationalNotSelected (in/out) International Not Selected.
StandardInternational (in/out) Standard International Flat Rate Shipping.
ExpeditedInternational (in/out) Expedited International Flat Rate Shipping.
USPSGlobalExpress (in/out) USPS Global Express Mail.
USPSGlobalPriority (in/out) USPS Global Priority Mail.
USPSEconomyParcel (in/out) USPS Economy Parcel Post.
USPSEconomyLetter (in/out) USPS Economy Letter Post.
USPSAirmailLetter (in/out) USPS Airmail Letter Post.
USPSAirmailParcel (in/out) USPS Airmail Parcel Post.
UPSWorldWideExpressPlus (in/out) UPS Worldwide Express Plus.
UPSWorldWideExpress (in/out) UPS Worldwide Express.
UPSWorldWideExpedited (in/out) UPS Worldwide Expedited.
UPSStandardToCanada (in/out) UPS Standard To Canada.
OtherInternational (in/out) Other International Shipping (see description).
Austria (AT) Site Shipping Service Option Values
Value Description
AT_StandardDispatch (in/out) Standardversand (unversichert).
AT_InsuredDispatch (in/out) Versicherter Versand.
AT_Writing
AT_COD
AT_ExpressOrCourier (in/out) Express- oder Kurierversand.
AT_InsuredExpressOrCourier (in/out) Versicherter Express- oder Kurierversand.
AT_SpecialDispatch
AT_InsuredSpecialDispatch
AT_Sonstige (in/out) Sonstige (Siehe Artikelbeschreibung).
AT_UnversicherterVersandInternational (in/out) Unversicherter Versand International.
24 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 24
Austria (AT) Site Shipping Service Option Values
Value Description
AT_VersicherterVersandInternational (in/out) Versicherter Versand International.
AT_SonstigerVersandInternational (in/out) Sonstiger Versand International.
AT_UnversicherterExpressVersandInternational (in/out) Unversicherter Express Versand International.
AT_VersicherterExpressVersandInternational (in/out) Versicherter Express Versand International
Australia (AU) Site Shipping Service Option Values
Value Description
AU_Express (in/out) Express.
AU_Registered (in/out) Registered.
AU_Courier (in/out) Courier.
AU_Other (in/out) Other.
AU_EMSInternationalCourierParcels (in/out) EMS International Courier - Parcels.
AU_EMSInternationalCourierDocuments (in/out) EMS International Courier - Documents.
AU_ExpressPostInternationalDocuments (in/out) Express Post International - Documents.
AU_AirMailInternational (in/out) Air Mail.
AU_EconomyAirInternational (in/out) Economy Air.
AU_SeaMailInternational (in/out) Sea Mail.
AU_StandardInternational (in/out) Standard International Flat Rate Postage.
AU_ExpeditedInternational (in/out) Expedited International Flat Rate Postage.
Belgium (BEFR and BENL) Site Shipping Service Option Values
Value Description
BEFR_StandardDelivery (in/out)
BEFR_PriorityDelivery (in/out)
BEFR_ParcelPost (in/out)
BEFR_RegisteredMail (in/out)
BEFR_Other (in/out)
BEFR_DePostInternational (in/out) De Post.
BEFR_UPSInternational (in/out) UPS.
BEFR_FedExInternational (in/out) Fedex.
BEFR_DHLInternational (in/out) DHL.
BEFR_TPGPostTNTInternational (in/out) TPG Post/TNT (Netherlands).
BEFR_StandardInternational (in/out) Frais de livraison internationale fixes.
BEFR_ExpeditedInternational (in/out) Frais fixes pour livraison internationale express.
BEFR_OtherInternational (in/out) Autres livraisons internationales (voir description).
BEFR_LaPosteInternational (in/out) La Poste (France).
25 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 25
Belgium (BEFR and BENL) Site Shipping Service Option Values
Value Description
BENL_StandardDelivery (in/out) Standard Delivery.
BENL_PriorityDelivery (in/out) Priority Delivery
BENL_ParcelPost (in/out) Parcel Post
BENL_RegisteredMail (in/out) Registered Mail
BENL_Other (in/out) Other Shipping Service.
BENL_DePostInternational (in/out) De Post.
BENL_UPSInternational (in/out) UPS.
BENL_FedExInternational (in/out) Fedex.
BENL_DHLInternational (in/out) DHL.
BENL_TPGPostTNTInternational (in/out) TPG Post/TNT (Netherlands).
BENL_StandardInternational (in/out) Standard International.
BENL_ExpeditedInternational (in/out) Expedited International.
BENL_OtherInternational (in/out) Other International Shipping Services.
BENL_LaPosteInternational (in/out) La Poste (France).
Canada (CA) Site Shipping Service Option Values
Value Description
CA_StandardDelivery (in/out) Standard Delivery.
CA_ExpeditedDelivery
CA_PostLettermail (in/out) Canada Post Lettermail.
CA_PostRegularParcel (in/out) Canada Post Regular Parcel.
CA_PostExpeditedParcel (in/out) Canada Post Expedited Parcel.
CA_PostXpresspost (in/out)
CA_PostPriorityCourier (in/out) Canada Post Priority Courier.
CA_StandardInternational (in/out) Standard International Flat Rate Shipping.
CA_ExpeditedInternational (in/out) Expedited International Flat Rate Shipping.
CA_OtherInternational (in/out) Other International Shipping (see description).
CA_PostExpeditedParcelUSA (in/out)
CA_PostSmallPacketsUSA (in/out)
CA_PostXpresspostUSA (in/out)
CA_PostXpresspostInternational (in/out)
CA_PostInternationalParcelSurface (in/out)
CA_PostInternationalParcelAir (in/out)
CA_SmallPacketsInternational (in/out) Small Packets - International.
CA_PurolatorInternational (in/out) Purolator International.
26 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 26
Switzerland (CH) Site Shipping Service Option Values
Value Description
CH_StandardDispatchAPost (in/out) Standardversand (A-Post/Priority).
CH_StandardDispatchBPost (in/out) Standardversand (B-Post/Economy).
CH_InsuredDispatch (in/out) Versicherter Versand (z.B. Assurance/Fragile).
CH_Writing
CH_COD
CH_ExpressOrCourier (in/out) Express- oder Kurierversand.
CH_InsuredExpressOrCourier (in/out) Versicherter Express- oder Kurierversand.
CH_SpecialDispatch
CH_InsuredSpecialDispatch
CH_Sonstige (in/out) Sonstige (Siehe Artikelbeschreibung).
CH_SonstigerVersandInternational (in/out) Sonstiger Versand (Siehe Artikelbeschreibung).
CH_EconomySendungenInternational (in/out) ECONOMY Sendungen.
CH_PrioritySendungenInternational (in/out) PRIORITY Sendungen.
CH_UrgentSendungenInternational (in/out) URGENT Sendungen.
China (CN) Site Shipping Service Option Values
Value Description
CN_PersonalDelivery
CN_RegularPackage
CN_DeliveryCompanyExpress
CN_PostOfficeExpress
CN_Others
CN_StandardInternational
CN_ExpeditedInternational
CN_OtherInternational
CN_CODInternational (in/out)
CN_StandardMailingInternational (in/out)
CN_RegularLogisticsInternational (in/out)
CN_EMSInternational (in/out)
CN_OthersInternational (in/out)
German (DE) Site Shipping Service Option Values
Value Description
DE_StandardDispatch (in/out) Unversicherter Versand.
DE_InsuredDispatch (in/out) Versicherter Versand.
27 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 27
German (DE) Site Shipping Service Option Values
Value Description
DE_Writing
DE_COD
DE_ExpressOrCourier (in/out) Express- oder Kurierversand.
DE_InsuredExpressOrCourier (in/out) Versicherter Express- oder Kurierversand.
DE_SpecialDispatch
DE_InsuredSpecialDispatch
DE_UnversicherterVersand (in/out) Unversicherter Versand.
DE_DeutschePostBrief (in/out) Deutsche Post Brief.
DE_DHLPostpaket (in/out) DHL Postpaket.
DE_DHLPackchen
DE_DeutschePostWarensendung (in/out) Deutsche Post Warensendung.
DE_DeutschePostBuchersendung
DE_HermesPaketUnversichert (in/out) Hermes Paket (unversichert).
DE_HermesPaketVersichert (in/out) Hermes Paket (versichert).
DE_IloxxTransportXXL (in/out) iloxx Transport XXL.
DE_IloxxUbernachtExpress
DE_IloxxStandard (in/out) iloxx Standard.
DE_Sonstige (in/out) Sonstige (Siehe Artikelbeschreibung).
DE_UnversicherterVersandInternational (in/out) Unversicherter Versand.
DE_VersicherterVersandInternational (in/out) Versicherter Versand.
DE_DHLPostpaketInternational (in/out) DHL Postpaket International.
DE_DHLPackchenInternational
DE_SonstigerVersandInternational (in/out) Sonstiger Versand (Siehe Artikelbeschreibung).
DE_UnversicherterExpressVersandInternational (in/out) Unversicherter Express - Versand.
DE_VersicherterExpressVersandInternational (in/out) Versicherter Express - Versand.
DE_DeutschePostBriefLandInternational (in/out) Deutsche Post Brief (Land).
DE_DeutschePostBriefLuftInternational (in/out) Deutsche Post Brief (Luft).
DE_IloxxEuropaInternational (in/out) iloxx Europa.
DE_IloxxWorldWideInternational (in/out) iloxx World Wide.
Spain (ES) Site Shipping Service Option Values
Value Description
ES_CartasNacionalesHasta20 (in/out) Cartas nacionales hasta 20 gr.
ES_CartasNacionalesDeMas20
ES_CartasInternacionalesHasta20 (in/out) Cartas internacionales hasta 20 gr.
28 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 28
Spain (ES) Site Shipping Service Option Values
Value Description
ES_CartasInternacionalesDeMas20 (in/out) Cartas internacionales de mas de 20 gr.
ES_PaqueteAzulHasta2kg (in/out) Paquete Azul (nacional) hasta 2 kg.
ES_PaqueteAzulDeMas2kg
ES_PaqueteInternacionalEconomico
ES_Urgente
ES_Otros
ES_StandardInternational
ES_ExpeditedInternational
ES_OtherInternational
ES_CartasPostalInternational (in/out) Cartas y tarjetas postales internacionales.
ES_EmsPostalExpressInternational (in/out) Ems postal expres internacional.
ES_EconomyPacketInternational (in/out) Paquete internacional economico.
France (FR) Site Shipping Service Option Values
Value Description
FR_ChronoposteInternationalClassic (in/out) Chronoposte International Classic.
FR_ColiposteColissimoDirect (in/out) Coliposte Colissimo Direct.
FR_DHLExpressEuropack (in/out) DHL Express Europack.
FR_UPSStandard (in/out) UPS Standard.
FR_PostOfficeLetter (in/out) Lettre.
FR_PostOfficeLetterFollowed (in/out) Lettre avec suivi.
FR_PostOfficeLetterRecommended
FR_ColiposteColissimo (in/out) Colissimo.
FR_ColiposteColissimoRecommended
FR_UPSStandardAgainstRefund (in/out) Contre remboursement.
FR_Autre (in/out) Autre mode d'envoi de courrier.
FR_Ecopli (in/out) Ecopli.
FR_Colieco
FR_AuteModeDenvoiDeColis (in/out) Autre mode d'envoi de colis.
FR_RemiseEnMainPropre (in/out) Remise en main propre.
FR_StandardInternational
FR_ExpeditedInternational
FR_OtherInternational
FR_LaPosteInternationalPriorityCourier (in/out) La Poste - Courrier International Prioritaire.
FR_LaPosteInternationalEconomyCourier (in/out) La Poste - Courrier International Economique.
29 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 29
France (FR) Site Shipping Service Option Values
Value Description
FR_LaPosteColisPostalPriorityInternational (in/out) La Poste - Colis Postal Prioritaire.
FR_LaPosteColisPostalEconomyInternational (in/out) La Poste - Colis Postal Economique.
FR_EmballageColissimoInternational (in/out) Emballage Colissimo International.
FR_ChronopostClassicInternational (in/out) Chronopost Classic International.
FR_ChronopostPremiumInternational (in/out) Chronopost Premium International.
FR_UPSStandardInternational (in/out) UPS Standard.
FR_UPSExpressInternational (in/out) UPS Express.
FR_DHLInternational (in/out) DHL.
India (IN) Site Shipping Service Option Values
Value Description
IN_Regular (in/out) National - Regular (Delivery outside seller’s city.)
IN_Express (in/out) National - Express (Delivery anywhere in India.)
IN_NationalCOD (in/out) National - COD (Delivery outside seller’s city.)
IN_Courier (in/out) Local - Courier
IN_LocalCOD (in/out) Local - COD (Delivery within seller’s city.)
IN_BuyerPicksUpAndPays (in/out) Local - BuyerPicksUpAndPays
IN_StandardInternational (in/out) International - Standard
IN_ExpeditedInternational (in/out) International - Expedited
IN_OtherInternational (in/out) International - Other
IN_FlatRateCOD (in/out) FlatRate - COD (Delivery anywhere in India.)
Italy (IT) Site Shipping Service Option Values
Value Description
IT_RegularMail (in/out) Posta ordinaria.
IT_PriorityMail (in/out) Posta prioritaria.
IT_MailRegisteredLetter (in/out) Posta raccomandata.
IT_MailRegisteredLetterWithMark (in/out) Posta raccomandata con contrassegno.
IT_InsuredMail (in/out) Posta assicurata.
IT_QuickMail (in/out) Posta celere.
IT_RegularPackage (in/out) Pacco ordinario.
IT_QuickPackage1 (in/out) Pacco celere 1.
IT_QuickPackage3 (in/out) Pacco celere 3.
IT_ExpressCourier (in/out) Corriere espresso.
IT_StandardInternational (in/out) Spedizione internazionale standard a prezzo fisso.
30 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 30
Italy (IT) Site Shipping Service Option Values
Value Description
IT_ExpeditedInternational (in/out) Spedizione internazionale celere a prezzo fisso.
IT_OtherInternational (in/out) Altre spedizioni internazionali (vedi descrizione).
Netherlands (NL) Site Shipping Service Option Values
Value Description
NL_StandardDelivery (in/out) Standaardverzending.
NL_ParcelPost (in/out) Pakketpost.
NL_RegisteredMail (in/out) Verzending met ontvangstbevestiging.
NL_Other (in/out) Andere verzendservice.
NL_TPGPostTNTInternational (in/out) TPG Post/TNT.
NL_UPSInternational (in/out) UPS.
NL_FedExInternational (in/out) Fedex.
NL_DHLInternational (in/out) DHL.
NL_DPDGBRInternational (in/out) DPD (Germany).
NL_GLSBusinessInternational (in/out) GLS (Business only).
NL_StandardInternational (in/out) Vaste kosten standaard internationale verzending.
NL_ExpeditedInternational (in/out) Vaste kosten versnelde internationale verzending.
NL_OtherInternational (in/out) Andere internationale verzending (zie beschrijving).
Taiwan (TW) Site Shipping Service Option Values
Value Description
TW_RegisteredMail
TW_UnregisteredMail
TW_COD
TW_DwellingMatchPost
TW_DwellingMatchCOD
TW_SelfPickup
TW_ParcelPost
TW_ExpressMail
TW_Other
TW_CPInternationalLetterPost
TW_CPInternationalParcelPost
TW_CPInternationalRegisteredLetterPost
TW_CPInternationalRegisteredParcelPost
TW_CPInternationalEMS
31 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 31
Taiwan (TW) Site Shipping Service Option Values
Value Description
TW_CPInternationalOceanShippingParcel
TW_FedExInternationalPriority (in/out) Fedex International Priority.
TW_FedExInternationalEconomy (in/out) Fedex International Economy.
TW_UPSWorldwideExpedited (in/out) UPS Worldwide Expedited.
TW_UPSWorldwideExpress (in/out) UPS Worldwide Express.
TW_UPSWorldwideExpressPlus (in/out) UPS Worldwide Express Plus.
TW_OtherInternational
United Kingdom (UK) Site Shipping Service Option Values
Value Description
UK_RoyalMailFirstClassStandard (in/out) Royal Mail 1st Class Standard.
UK_RoyalMailSecondClassStandard (in/out) Royal Mail 2nd Class Standard.
UK_RoyalMailFirstClassRecorded (in/out) Royal Mail 1st Class Recorded.
UK_RoyalMailSecondClassRecorded (in/out) Royal Mail 2nd Class Recorded.
UK_RoyalMailSpecialDelivery (in/out) Royal Mail Special Delivery.
UK_RoyalMailStandardParcel (in/out) Royal Mail Standard Parcels.
UK_Parcelforce24 (in/out) Parcelforce 24.
UK_Parcelforce48 (in/out) Parcelforce 48.
UK_OtherCourier (in/out) Other Courier.
UK_SellersStandardRate (in/out) Seller's Standard Rate.
UK_CollectInPerson (in/out) Collection in Person.
UK_SellersStandardInternationalRate (in/out) Sellers Standard International Rate.
UK_RoyalMailAirmailInternational (in/out) Royal Mail Airmail.
UK_RoyalMailAirsureInternational (in/out) Royal Mail Airsure.
UK_RoyalMailSurfaceMailInternational (in/out) Royal Mail Surface Mail.
UK_RoyalMailInternationalSignedFor (in/out) Royal Mail International Signed-for.
UK_RoyalMailHMForcesMailInternational (in/out) Royal Mail HM Forces Mail.
UK_ParcelForceInternationalDatapost (in/out) Parcelforce International Datapost.
UK_ParcelForceIreland24International (in/out) Parcelforce Ireland 24.
UK_ParcelForceEuro48International (in/out) Parcelforce Euro 48.
UK_ParcelForceInternationalScheduled (in/out) Parcelforce International Scheduled.
UK_OtherCourierOrDeliveryInternational (in/out) Other courier or delivery service.
UK_CollectInPersonInternational (in/out) Collect in person.
32 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 32
Complete Data Field Dictionary
This section lists all the possible data fields for eBay File Exchange, grouped according to type
or function.
HELPFUL HINT: HEADER (FIELD) NAMES ARE NOT CASE-SENSITIVE. IT DOES NOT MATTER
WHETHER YOU CAPITALIZE THE LETTERS IN THE DATA FIELD NAMES OR NOT
. FOR EXAMPLE,
E
BAY FILE EXCHANGE RECOGNIZES BOTH “PAYPALACCEPTED” AND “PAYPALACCEPTED” AS
THE SAME FIELD
.
IF YOU DO NOT NEED TO USE OPTIONAL FIELDS, LEAVE THEM SET TO NULL OR 0.
Required Fields
The table below lists eBay File Exchange actions and corresponding required fields.
Required Data Fields
Data Field
Name
Description Action
where
Required
*Action Required! Determines the purpose of the row: add-item, relist item, revise item, end
listing, mark and item’s status, and verify an added item.
Character limit: n/a
Type: String
Valid entry: Add, Revise, Relist, End, Status, VerifyAdd, Info
All
*ProductIDType Required! You must fill in the type of data contained in ProductIDValue. Currently only
valid for catalog-based listing and required if you want to use pre-filled item specifics
in books, movies, music, and videogames. (If you upload an item that has multiple
matches for its ISBN, UPC, or EAN, you must resubmit the item using
ProductIDType=ProductIdentifier.
To use both ISBN-10 and ISBN-13 numbers simultaneously, a second
ProductIDValue field needs to be added to the right of ProductIDValue. Name this
new column ProductIDValue-2. Enter the 13-digit number in the ProductIDValue field,
and enter the ISBN-10 number in the ProductIDValue-2 field. To use either the ISBN-
10 or ISBN-13 number only, enter that value in the ProductIDValue field.
Character limit: n/a
Type: Text String
Valid entry: ISBN, UPC, EAN, ProductIdentifier
Field Relationship: Based on ProductIDValue
Add and
VerifyAdd
(for catalog)
*ProductIDValue Required! Value of ProductIDType. Currently only valid for catalog-based listing and
required if you want to use pre-filled item specifics in books, movies, music, and
videogames. (If you upload an item that has multiple matches for its ISBN or UPC,
you must resubmit the item using ProductIDType=ProductIdentifier.
Character limit: n/a
Type: String
Valid entry: Integer Value for ISBN, UPC, EAN or String for ProductIdentifier (for
example,
58640:2:1055:2281435410:39473100:30d76c76f23f6bf7325148c5088c3c46:1:1:1:11
95808884)
Field Relationship: Based on ProductIDType
Add and
VerifyAdd
(for catalog)
*ItemID Required! eBay-generated unique ID that is only given to successful listings, returned
in your Load Results Report.
Character limit: n/a
Type: Integer
Valid entry: Integer Value
Revise,
Relist, End,
Status
*Category Required! Category in which you want to list your items. Required for non-catalog.
Character limit: Max length 10
Type: Integer
Valid entry: Integer
Add and
VerifyAdd
(for non-
catalog)
33 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 33
Required Data Fields
Data Field
Name
Description Action
where
Required
*Title Required! Title for eBay listing. (This field is optional for catalog listings but required
for non-catalog listings.)
Character limit: Max length 55
Type: Text String
Valid entry: User input
Add and
VerifyAdd
(for non-
catalog)
*Description Required! Description of the item. (This field is optional for catalog listings but
required for non-catalog listings.)
Character limit: Max length 500,000 characters
Type: Text String
Valid entry: User input
Add and
VerifyAdd
(for non-
catalog)
*Quantity Required! Number of items being sold in the listing.
Character limit: n/a
Type: Integer
Valid entry: for example, 200
Field Relationship: If LotSize is greater than 1, then Quantity field indicates the
number of lots being listed and LotSize indicates the number of items in each lot. You
can only use LotSize in lot-enabled categories.
Add and
VerifyAdd
(both
catalog and
non-catalog)
*StartPrice Required! Minimum acceptable bid for the item. For Fixed Price listing, this is the price
at which you are selling the item.
Character limit: Max length 16, including decimal point or comma
Type: Money
Valid entry: for example, 10.00
Field Relationship: For Auction listings.
Add and
VerifyAdd
(both
catalog and
non-catalog)
*Duration Required! Number of days the listing is active.
Character limit: Max length 3
Type: String
Valid entry: Only certain values are allowed, and the choice of values depends on
the listing format. Specify GTC for the
Good Til Cancel feature for eBay Stores
Inventory items only. See the
Durations Table. (You must have an eBay developer
account to access these English-language pages.)
Add and
VerifyAdd
(both
catalog and
non-catalog)
*Country Required! The country you are selling from.
Character limit: Two-letter country code
Type: String
Valid entry: A default value is already included in the template metadata and is
related to the site where you downloaded your template. For example, AU, AT, BE,
CA, CN, FR, DE, IT, IN, NL, ES, CH, TW, GB, US.
Add and
VerifyAdd
(both
catalog and
non-catalog)
*SiteID Required! The eBay site you want to list your items on.
Character limit: n/a
Type: String
Valid entry: A default value already included in the template metadata is for the site
where you downloaded your template. For example, Australia, Austria,
Belgium_Dutch, Belgium_French, Canada, China, eBayMotors, France, Germany,
Italy, India, Netherlands, UK, US.
Add and
VerifyAdd
(both
catalog and
non-catalog)
*Location Required! Geographical location of the item.
Character limit: Max length 45
Type: String
Valid entry: User Input
Field Relationship: Notice that this is the shipping location of the item only; you can
also use PostalCode (see the
Listing Details and Display Fields table on page 34) if
you are located somewhere else.
Add and
VerifyAdd
(both
catalog and
non-catalog)
*Currency Required! Currency value for your listings.
Character limit: Three-letter code
Type: String
Valid entry: A default currency value is already included in the template metadata
and is related to the site where you downloaded your template. (You only need to
change it if you want to list your item on a different eBay site.) USD, CAD, GBP, AUD,
EUR, CHF, TWD, CNY, INR
Add and
VerifyAdd
(both
catalog and
non-catalog)
*EndCode Required! Reason for ending a listing.
Character limit: n/a
Type: String
Valid entry: LostorBroken, NotAvailable, Incorrect, OtherListingError
End
34 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 34
Listing Details and Display Fields
Listing Details and Display Data Fields
Data Field Name Description
Region Numeric code used to list an item regionally.
Character limit: n/a
Type: Integer
Valid entry: n/a. Search the
eBay API Documentation for “Region Codes” to get a full list of
values. (You must have an eBay developer account to access this English-language page.)
PostalCode Postal code where you are actually located, which may differ from the item’s shipping location.
Character limit: n/a
Type: String
Valid entry: User input
Field Relationship: See the Location data field in the
Required Fields table.
Format The listing format you want to use for this item.
Character limit: n/a
Type: String
Valid entry: Auction (default), RealEstateAd, StoresFixedPrice, FixedPrice
LotSize Single listing consisting of two or more similar items that must be purchased together.
Character limit: n/a
Type: Integer
Valid entry: Integer value
Field Relationship: If LotSize is greater than 1, then Quantity field indicates the number of lots
being listed and LotSize indicates the number of items in each lot. You can only use LotSize in
lot-enabled categories.
Counter Hit counter for the item’s listing page.
Character limit: n/a
Type: String
Valid entry: NoHitCounter, HonestyStyle (US only), GreenLED (US only), Hidden (US only),
BasicStyle, RetroStyle, HiddenStyle. If you input any value other than these, 0 is used as the
default instead.
PrivateAuction Specifies whether this is a private auction.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: You cannot use this with Fixed Price items.
ScheduleTime Allows you to schedule a listing to start at a specified time in the future.
Character limit:
Type: YYYY-MM-DD HH:MM:SS. Hours are in 24-hour format (for example, 2:00:00pm is
shown as 14:00:00) and treated as GMT.
Valid entry: User input
StoreCategory Custom categories for subdividing the items within an eBay Store. Store owners can create up
to 19 custom categories for their stores.
Character limit:
Type: Integer
Valid entry: If specified, must be an integer between 0 and 20. If you specify an invalid value
(e.g., 21), the system resets the value to 1 (Other). 0=Not an eBay Store item, 1=Other,
2=Category 1, 3=Category 2…20=Category 19
StoreCategory2 Specifies a second store category. Custom categories for subdividing the items within an eBay
Store. Store owners can create up to 19 custom categories for their stores.
Character limit:
Type: Integer
Valid entry: If specified, must be an integer between 0 and 20. If you specify an invalid value
(e.g., 21), the system resets the value to 1 (Other). 0=Not an eBay Store item, 1=Other,
2=Category 1, 3=Category 2…20=Category 19
Category2 Secondary category in which the item is listed.
Character limit: Max length 10
Type: Integer
Valid entry: Integer Value
35 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 35
Listing Details and Display Data Fields
Data Field Name Description
SubTitle SubTitle to use in addition to the title. Provides more keywords when buyers search in titles and
descriptions. Additional fees apply.
Character limit: Max length 55
Type: String
Valid entry: User input; If you pass any value, this feature is applied.
A:Condition Condition of item. This field is case-sensitive.
Character limit: n/a
Type: String
Valid entry: New, Used
PicURL URLs of self-hosted photos you can use in the listing. Separate multiple URLs with pipes.
Character limit: Max length 2048
Type: String
Valid entry: User input
BoldTitle Specifies whether the title for the listing will be in boldface type. Additional fees apply.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Featured Specifies whether the item appears at the top of item listings in its category. Additional fees
apply.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
BestOfferEnabled If you are selling a fixed price format item (in a category for which Best Offer is also enabled),
you can enable Best Offer for that item. This feature enables a buyer to make a lower priced
binding offer on your item. You can choose to accept the offer, decline the offer or let the offer
naturally expire after 48 hours. If you accept an offer, the listing ends and the Best Offer price
and terms are displayed upon viewing the ended listing. See the
eBay online help for more
information. Additional fees apply.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true or enabled, default is 0)
GalleryType Specifies whether the item is included in the Gallery, either in the general Gallery or in the
special “featured” section above it.
Character limit: n/a
Type: Text String
Valid entry: None (default), Gallery, Featured
Highlight Highlights item listing. Additional fees apply.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Border Specifies whether the item listing will have a border around it. Available only in US and CA.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: Using this field does not affect the item SubTitle, if any. This option is only
available on the US and Canada sites; all other sites will ignore the value if passed in.
FE:ListByDate Specifies the date/time by which a listing action request must be completed; if the listing action
request is not completed by this time, the item action request fails and a corresponding error
code is noted in the results file.
Character limit: n/a
Type: YYYY-MM-DD HH:MM:SS. Hours are in 24-hour format (for example, 2:00:00pm is
shown as 14:00:00) and treated as GMT.
Valid entry: up to 21 days
PrivateNotes Value you can assign that can help identify the line items (for example, a short description or
SKU) and is returned in the Load Results Report.
Character limit: n/a
Type: String
Valid entry: User input
36 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 36
Listing Details and Display Data Fields
Data Field Name Description
CustomLabel Value you can assign, such as your own unique ID for this item, which is returned in the Load
Results Report and Active Listings files.
Character limit: 50
Type: String
Valid entry: User input
GiftIcon Specifies whether a small, attention-getting image denoting seasonal sales items is displayed in
the listing’s Title.
Character limit: n/a
Type: Integer
Valid entry: 0,1
Field Relationship: If you use this field, you must also set at least one of the following to true:
GiftExpressShipping, GiftShipToRecipient, or GiftWrap.
NowandNew (Sofort and
Neu)
This field is only available to Germany (DE), Austria (AT), and Switzerland (CH) sites.
Specifies whether you are listing with NowandNew, which is an enhancement to the Buy It Now
format. Only applicable for Buy It Now, Fixed Price, and Store Inventory listings. When a Buy It
Now item is listed with Now & New, an alternative icon replaces the Buy It Now icon on
applicable eBay Web sites. Users can also filter search results to only retrieve items that are
listed with Now & New.
The requirements that you must meet to list with Now & New are the same as the requirements
for listing with Buy It Now (for example, your feedback score). Search the
eBay API
Documentation for “Internationalization” to find these requirements for each eBay site. (You
must have an eBay developer account to access this English-language page.)
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: Only valid if you also specify: the item condition as new and can be
purchased immediately (i.e., are Buy It Now), offer a predefined return policy, and specify
shipping costs. Requires that you specify Return Policy.
Pricing Fields
Pricing Data Fields
Data Field Name Description
*StartPrice See the Required Fields section on page 65.
BuyItNowPrice For auction listings, this allows a buyer to instantly purchase the item at a set price and end
the auction.
Character limit: Max length 16, including decimal point or comma
Type: Money
Valid entry: for example, 11.00
Field Relationship: Not applicable to Fixed Price items and AdFormat listings.
ReservePrice Minimum price at which you are willing to sell the item. (This value must be greater than
StartPrice value.)
Character limit: Max length 166, including decimal point or comma
Type: Money
Valid entry: for example, 10.50
Field Relationship: Not valid for Fixed Price items.
InsuranceOption Specifies whether insurance fee is required.
Character limit:
Type: String
Valid entry: NotOffered (default); Optional; Required; IncludedInShippingHandling
Field Relationship: You cannot set this value to IncludedInShippingHandling if
ShippingType=Calculated. If you set this field to Optional or Required, you must also set
InsuranceFee.
InsuranceFee Total cost of insuring the item.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: 0.00 (default)
Field Relationship: If you set InsuranceOption=Optional or =Required, this field is required.
37 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 37
Pricing Data Fields
Data Field Name Description
PackagingHandlingCosts Optional fees you want to assess for the shipping of the item.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: for example, 5.50 or 5,50
Tax Fields
Tax Data Fields
Data Field Name Description
SalesTaxPercent Specifies the sales tax for the item. Pass 0.00 to remove a SalesTaxPercent in your Revise
action. Available in US, CA, IN.
Character limit: Max length 5 characters (max precision 3 decimal places)
Type: Double
Valid entry: 0.00 (default), 0, 1
Field Relationship: If you specify this field, you must also specify a SalesTaxState.
SalesTaxState Specifies the state that is associated with the SalesTaxPercent. Available in US, CA, IN.
Character limit: 2
Type: String
Valid entry: 2-letter abbreviation for the state
Field Relationship: Required field if you specify SalesTaxPercent.
ShippingInTax
Specifies whether shipping costs are included in the tax amount. Available in US only.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
UseTaxTable Specifies whether you are using the eBay tax table.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
VATPercent VAT (Value Added Tax) rate for the item. You can also print an invoice that includes the item's
net price, VAT percent, VAT amount, and total price, as required by European law. Because
VAT rates vary depending on the item and on the user's country of residence, you are
responsible for entering the correct VAT rate; eBay does not calculate it. To specify a
VATPercent, you must have a VAT-ID registered with eBay and must be listing the item on a
site in the European Union or Switzerland.
Character limit: Max length 5 characters (max precision 3 decimal places)
Type: Double
Valid entry:
Field Relationship: When you specify the VATPercent, the VAT information appears on the
item's listing page. The View Item page displays the precision to two decimal places with no
trailing zeros. However, the full value you input is stored.
Gift Fields
Gift Data Fields
Data Field Name Description
GiftIcon See the Listing Details and Display Fields section on page 34.
GiftExpressShipping Specifies whether you are offering to ship the item via an express shipping method as described in
the item description.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1, (0=false, 1=true, default is 0)
Field Relationship: If you used GiftIcon, you must also set at least one of the following to true:
GiftExpressShipping, GiftShipToRecipient, or GiftWrap to True. Not applicable for eBay Store
Inventory (Type=7) listings.
38 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 38
Gift Data Fields
Data Field Name Description
GiftShipToRecipient Specifies whether you are offering to ship to the gift recipient, not the buyer, when payment clears.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: If you used GiftIcon, you must also set at least one of the following to true:
GiftExpressShipping, GiftShipToRecipient, or GiftWrap to True.
GiftWrap Specifies whether you are offering to wrap the item (and optionally include a card) as described in
the item description.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: If you used GiftIcon, you must also set at least one of the following to true:
GiftExpressShipping, GiftShipToRecipient, or GiftWrap to True.
Payment and Checkout Fields
Although eBay File Exchange does not require a particular payment method for each listing,
you must set AT LEAST ONE to true (1). New sellers are required to choose one of the
following payment options: PayPal, AmEx, Discover, or VisaMastercard.
Payment and Checkout Data Fields
Data Field Name Description
*Duration See the Required Fields section on page 65.
ImmediatePayRequired Specifies whether you require immediate payment. This is available for items that are listed on
sites and in categories that support immediate payment.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: If you use this field, you must also set PayPalAccepted=1 and no other
payments can be specified. You must have a Premier or Business PayPal account.
PayPalAccepted Specifies whether you accept PayPal as a form of payment. Available in US, CA, UK, AU, AT,
DE, FR, IT, NL, BE, CH.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: You can only use this field for sites that support PayPal. If no value is
passed but your eBay preferences are set to offer PayPal on all listings, eBay will return a
warning notifying you that PayPalAccepted was added as a payment method. If
PayPalAccepted is passed, also pass PayPalEmailAddress.
PayPalEmailAddress The email address associated with the item that you have on file with PayPal. Available in US,
CA, UK, AU, AT, DE, FR, IT, NL, BE, CH.
Character limit: n/a
Type: String
Valid entry: User input
Field Relationship: This field is required if you use PayPalAccepted.
PaymentInstructions Your instructions to the buyer and your return policy.
Character limit: Max length 500
Type: String
Valid entry: Null (default); user input
CashOnPickup Specifies whether payment on pickup is an acceptable payment term. Available in AT, DE, NL,
BE (NL), CH, TW, CN.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
39 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 39
Payment and Checkout Data Fields
Data Field Name Description
CCAccepted Specifies whether credit card accepted as payment. Available in UK, AT, DE, CH, TW.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
AmEx Specifies whether American Express accepted as payment. Available in US, CA, AU, FR, IT,
NL, ES, BE.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Discover Specifies whether Discover accepted as payment. Available in US only.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
VisaMastercard Specifies whether Visa and/or MasterCard accepted as payment. Available in US, CA, AU, FR,
IT (includes EuroCard), NL (includes EuroCard), ES, BE (Fr), BE (NL, includes EuroCard), TW.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
COD Specifies whether cash on delivery accepted as payment. Available in DE, AT, CH, IT, FR, BE,
NL, ES, TW, CN
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
MOCashiers Specifies whether money orders and cashiers checks are accepted as payment. Available in
US, CA, UK (Postal), AU, FR, IT, BE (Fr), TW.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
PersonalCheck Specifies whether personal checks accepted as payment. Available in US, CA, UK, AU, FR, IT,
ES, BE.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
MoneyXferAccepted Specifies whether direct transfer of money is acceptable payment. Applicable for certain sites
only (AU, AT, DE, FR, IT, NL, ES, BE, CH, TW, CN)
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
MoneyXferAcceptedInChec
kout
Specifies whether direct transfer of money is an acceptable payment method in checkout. If the
seller has bank account information on file and eBay Checkout is enabled you (see the
Checkout Preferences page in My eBay), setting MoneyXferAcceptedinCheckout to 1 (true)
causes the bank account information to be displayed in Checkout. If 1 (true) is passed but
Checkout has been disabled, eBay returns a warning and resets
MoneyXferAcceptedinCheckout to 0 (false). See the
eBay online help for more information
about accepting direct money transfers in Checkout. Applicable for certain sites only (AU, AT,
DE, FR, IT, NL, ES, BE, CH, TW, CN).
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
At least one of the payment methods (VisaMastercard, etc.) must be set to 1 (true). Payment
methods are not applicable for Real Estate listings.
PaymentOther Specifies whether “other” is an acceptable payment method. Available in AU, FR, IT, NL, BE.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
OtherOnlinePayments Specifies whether non-eBay online payment is an acceptable payment method.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
40 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 40
Payment and Checkout Data Fields
Data Field Name Description
PaymentSeeDescription Specifies whether acceptable payment method is in Description.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true); If you do not set any other payment method, you must
specify PaymentSeeDescription =1
PaymentStatus Denotes whether the item has been paid for.
Character limit:
Type: Boolean
Valid entry: Valid entry: 0 or 1 (0=unpaid, 1=paid, default is 0)
Escrow Specifies whether you want to offer escrow as a payment method. Escrow is available only in
certain non-US sites. Available in UK, AU, AT, DE, FR, IT, NL, ES, BE, TW, CN.
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1
Field Relationship: You cannot use this field with real estate listings.
Shipping Fields
Shipping Data Fields
Data Field Name Description
InsuranceOption See the Pricing Fields section on page 36.
InsuranceFee See the Pricing Fields section on page 36.
PackagingHandlingCosts See the Pricing Fields section on page 36.
GiftExpressShipping See the Gift Fields section on page 37.
GiftShipToRecipient See the Gift Fields section on page 37.
GiftWrap See the Gift Fields section on page 37.
ShippingInTax See the Tax Fields section on page 37.
ApplyShippingDiscount Specifies whether a shipping discount is applied for the item when its transaction is combined
into a buyer-created Combined Payment order. If you don’t specify this field, it is set based on
your “My eBay” page preferences. (See the
Combined Payment overview for more information.
You must have an eBay developer account to access this English-language page.)
Character limit: n/a
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: Not applicable for Real Estate listings.
ShippingStatus Specifies whether the item has been shipped.
Character limit:
Type: Boolean
Valid entry: 0,1 (0=not shipped, 1=shipped)
ShipToLocations Item-level specification with one or more ShipToLocation elements. If there are two or more
ShipToLocations and one of them is set to None, all are ignored and a warning is returned.
ReviseItem can add a ShipToLocation. This field is different from IntlShippingService:Locations
field, which specifies specific ship-to locations for the shipping option selected.
Character limit:
Type: String
Valid entry: Worldwide; Americas; Europe, None
ShippingType Specifies whether you determine the shipping rate (flat) or let a shipping service calculate it.
Character limit:
Type: String
Valid entry: Flat (default), Calculated, FlatDomesticCalculatedInternational, or
CalculatedDomesticFlatInternational
Field Relationship: If you set this to calculated, you also must also set ShipFromZipCode.
41 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 41
Shipping Data Fields
Data Field Name Description
ShipFromZipCode Specifies the zip code from which you are shipping the item. Valid on U.S. site only.
Character limit:
Type: String
Valid entry: Must contain 5 or 9 digits, for example: 90210 or 90210-4141
Field Relationship: Only specify this field if ShippingType=Calculated.
ShippingIrregular Specifies whether the item requires special handling because it cannot go through the stamping
machine at the shipping service office.
Character limit:
Type: Boolean
Valid entry: 0 or 1 (0=false, 1=true, default is 0)
Field Relationship: Only specify this field if ShippingType=Calculated.
ShippingPackage Specifies the nature of the package to be shipped.
Character limit:
Type: String
Valid entry: None, Letter, LargeEnvelope, USPSLargePack, VeryLargePack, UPSLetter,
USPSFlatRateEnvelope, PackageThickEnvelope, Roll, Europallet, OneWayPallet, BulkyGoods,
Furniture, Cars, Motorbikes, Caravan, IndustryVehicles
Field Relationship: Only specify this field if ShippingType=Calculated.
WeightMajor The whole number portion of the shipping weight. For example, for a shipping weight of 3 lbs, 8
oz., the value would be “3.”
Character limit:
Type: Integer
Valid entry: Integer value
Field Relationship: Only returned if ShippingType=Calculated.
WeightMinor Sub-unit of shipping weight. If using English measures (lbs), this should be ounces and if you use
metric weight, this should be the number of hundredths of kilograms. For example, for a shipping
weight of 3 lbs, 8 oz., the value would be “8.”
Character limit:
Type: Integer
Valid entry: Integer value
Field Relationship: Only returned if ShippingType=Calculated. Sub-unit of WeightMajor.
WeightUnit Unit of measure for shipping weight, either English measure (lb) or metric (kg).
Character limit:
Type: String
Valid entry: valid unit string (lb or kg)
Field Relationship: Only returned if ShippingType=Calculated.
ShippingService-1:Option First shipping service type offered (within your country only).
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values section of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by ShippingService-1:Cost.
NOTE: The "ShippingService-1:Cost" field is not
needed when "ShippingType=Calculated."
ShippingService-1:Cost Shipping Cost specified for ShippingService-1:Option.
Character limit: n/a
Type: Money
Valid entry: To set this for free shipping or no shipping costs, set to 0.00.
Field Relationship: Must accompany ShippingService-1:Option.
NOTE: The "ShippingService-1:Cost" field is not
needed when "ShippingType=Calculated."
ShippingService-
1:AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
ShippingService-1:Priority Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options; if you only use one
shipping service, this field is unnecessary.
42 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 42
Shipping Data Fields
Data Field Name Description
ShippingService-2:Option Second shipping service type offered (within your country only). Use this field if you are offering
multiple shipping options.
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values sectiopn of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by ShippingService-2:Cost.
ShippingService-2:Cost Shipping Cost specified for ShippingService-2:Option. Use this field if you are offering multiple
shipping options.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: To set this for free shipping or no shipping costs, set to 0.00.
Field Relationship: Must accompany ShippingService-2:Option.
ShippingService-2:
AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
ShippingService-2:Priority Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options; if you only use one
shipping service, this field is unnecessary.
ShippingService-3:Option Second shipping service type offered (within your country only). Use this field if you are offering
multiple shipping options.
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values section of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by ShippingService-3:Cost.
ShippingService-3:Cost Shipping Cost specified for ShippingService-3:Option. Use this field if you are offering multiple
shipping options.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry:
Field Relationship: Must accompany ShippingService-3:Option.
ShippingService-3:
AdditionalCost
Any additional shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
ShippingService-3:Priority Your preferred presentation order for each shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple shipping options; if you only use one
shipping service, this field is unnecessary.
IntlShippingService-
1:Option
First international shipping type offered.
Character limit: n/a
Type: String
Valid entry: See the ShippingService-n:Option Data Field Values section of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by IntlShippingService-1:Cost and
IntlShippingService-1:Locations.
NOTE: The "IntlShippingService-1:Cost" field is not
needed when "ShippingType=Calculated."
43 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 43
Shipping Data Fields
Data Field Name Description
IntlShippingService-
1:Cost
Shipping Cost specified for IntlShippingService-1:Option.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: To set this for free shipping or no shipping costs, set to 0.00.
Field Relationship: Must accompany IntlShippingService-1:Option and IntlShippingService-
1:Locations.
NOTE: The "IntlShippingService-1:Cost" field is not
needed when "ShippingType=Calculated."
IntlShippingService-
1:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
IntlShippingService-
1:Locations
Country or Region where IntlShippingService-1:Option applies. You can enter multiple locations
by separating them using pipes, for example: “Asia|Europe”.
Character limit: n/a
Type: String
Valid entry Please refer to the tables listed under the
Overriding Metadata section of this guide.
If you set multiple locations and one of them is None, then all are ignored and a Warning is
returned. If you set multiple locations and one of them is Worldwide, then Worldwide is used and
other values are ignored.
Field Relationship: Must accompany IntlShippingService-1:Option and IntlShippingService-
1:Cost.
IntlShippingService-
1:Priority
Your preferred presentation order for each international shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international shipping options; if you
only use one shipping service, this field is unnecessary.
IntlShippingService-
2:Option
Second international shipping type offered.
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values section of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by IntlShippingService-2:Cost and
IntlShippingService-2:Locations.
IntlShippingService-
2:Cost
Shipping Cost specified for IntlShippingService-2:Option.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: To set this for free shipping or no shipping costs, set to 0.00.
Field Relationship: Must accompany IntlShippingService-2:Option and IntlShippingService-
2:Locations.
IntlShippingService-
2:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
IntlShippingService-
2:Locations
Country or Region where IntlShippingService-2:Option applies. You can enter multiple locations
by separating them using pipes, for example: “Asia|Europe.”
Character limit: n/a
Type: String
Valid entry Please refer to the tables listed under the
Overriding Metadata section of this guide.
If you set multiple locations and one of them is None, then all are ignored and a Warning is
returned. If you set multiple locations and one of them is Worldwide, then Worldwide is used and
other values are ignored.
Field Relationship: Must accompany IntlShippingService-2:Option and IntlShippingService-
2:Cost.
IntlShippingService-2:
Priority
Your preferred presentation order for each international shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international shipping options; if you
only use one shipping service, this field is unnecessary.
44 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 44
Shipping Data Fields
Data Field Name Description
IntlShippingService-
3:Option
Third international shipping type offered.
Character limit: n/a
Type: String
Valid entry: See the
ShippingService-n:Option Data Field Values section of this guide for valid
entry values for each site.
Field Relationship: Must be accompanied by IntlShippingService-3:Cost and
IntlShippingService-3:Locations.
IntlShippingService-
3:Cost
Shipping Cost specified for IntlShippingService-3:Option.
Character limit: n/a
Type: Money (you can use decimal point or comma)
Valid entry: To set this for free shipping or no shipping costs, set to 0.00.
Field Relationship: Must accompany IntlShippingService-3:Option and IntlShippingService-
3:Locations.
IntlShippingService-
3:AdditionalCost
Any additional international shipping costs for the item.
Character limit:
Type: Money (you can use decimal point or comma)
Valid entry: Default is 0.00
IntlShippingService-
3:Locations
Country or Region where IntlShippingService-3:Option applies. You can enter multiple locations
by separating them using pipes, for example: “Asia|Europe”.
Character limit: n/a
Type: String
Valid entry Please refer to the tables listed under the
Overriding Metadata section of this guide.
If you set multiple locations and one of them is None, then all are ignored and a Warning is
returned. If you set multiple locations and one of them is Worldwide, then Worldwide is used and
other values are ignored.
Field Relationship: Must accompany IntlShippingService-3:Option and IntlShippingService-
3:Cost.
IntlShippingService-
3:Priority
Your preferred presentation order for each international shipping service option.
Character limit:
Type: Integer
Valid entry: 1, 2, 3
Field Relationship: This field is required if you use multiple international shipping options; if you
only use one shipping service, this field is unnecessary.
Payment, Shipping and Feedback Status Fields
Payment, Shipping and Feedback Status Data Fields
Data Field Name Description
PaymentStatus See the Payment and Checkout Fields section on page 38.
ShippingStatus See the
Shipping Fields table on page 70.
BuyerUserID Unique identifier (eBay User ID) denoting the user you want to leave feedback for. (This UserID
is included in your Sales History Report download file.) If there are multiple matches found
based on the ItemID/BuyerUserID combination (for example, if one buyer purchases multiple
items separately in a Dutch auction), then the upload will fail and you will get an error warning.
Character limit:
Type: String
Valid entry: eBay User IDs
FeedbackType Text of feedback, explaining or justifying the Positive, negative, or neutral feedback rating.
Regardless of the site/language you or your buyer use, these values are always in English.
Applications designed for use in non-English-speaking countries should translate these values
to the target language when they are displayed in the application's UI.
Character limit: Max length 80 (125 for Taiwan)
Type: String
Valid entry: Positive, negative, neutral
45 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 45
Payment, Shipping and Feedback Status Data Fields
Data Field Name Description
Feedback Text of feedback, explaining or justifying the Positive, negative, or neutral feedback rating.
Character limit: 80 (125 for Taiwan)
Type: String
Valid entry: User input
Load Results Report Fields
Data Field Name Description
Line Number Line number of the listing from your upload file.
Action Action value for corresponding listing.
Status Specifies success or failure of action for listing. If “Fail,” ErrorCode and ErrorMessage fields
provide corresponding information.
ErrorCode Code denoting reason for listing failure.
ErrorMessage Text description that corresponds to ErrorCode.
ItemID eBay-designated ID number that is given to successful listings only.
ApplicationData Custom, application-specific data to be associated with the new item.
StartTime Time listing went live on eBay site (same as ScheduleTime, if used). Type: YYYY-MM-DD
HH:MM:SS. Hours are in 24-hour format (for example, 2:00:00pm is shown as 14:00:00) and
treated as GMT.
EndTime Time listing will end on eBay site. Type: YYYY-MM-DD HH:MM:SS. Hours are in 24-hour format
(for example, 2:00:00pm is shown as 14:00:00) and treated as GMT.
AuctionLengthFee eBay fee for 10-day auction for this listing.
BoldFee
eBay fee to boldface the title for the item listing.
BorderFee eBay fee to display a border around an item in the listing.
BuyItNowFee eBay fee to add the BuyItNow feature on this listing.
CategoryFeaturedFee eBay fee for listing the item in the selected category.
CurrencyId Specifies currency type, such as USD, CAD, GBP, AUD, EUR, CHF, TWD, CNY, INR
FeaturedFee eBay fee to list the item at the top of the item listings.
FeaturedGalleryFee eBay fee to list a fixed-price item for a certain duration.
FixedPriceDurationFee eBay fee for using the FixedPriceDuration feature on this listing.
GalleryFee eBay fee to have the item included in the gallery.
GiftIconFee eBay fee to display the gift icon next to the listing.
HighlightFee eBay fee to make the listing appear highlighted.
InsertionFee Basic eBay fee for listing the item. EU residents who sell items on EU sites may be subject to
VAT.
InternationalInsertionFee For sites that don’t normally charge insertion fees, a fee for offering shipping to countries other
than the country of the listing site.
ListingDesignerFee eBay fee to list the item using a Listing Designer layout or theme template. Using Motors vehicle
listings might result in a higher fee. (See
http://developer.ebay.com/DevZone/docs/API_Doc/Developing/DescriptionTemplates.htm for
more details. You must have an eBay developer account to access this English-language page.)
ListingFee Total eBay fee for listing the item, which includes basic fee (InsertionFee) plus any specialty
listing features (GalleryFee, HighLightFee, FeaturedFee, ListingDesignerFee, etc.). EU residents
who sell items on EU sites may be subject to VAT.
PhotoDisplayFee eBay fee use of Photo Hosting feature, a slideshow of multiple images.
PhotoFee eBay fee for associating photos with the listed item.
ProPackBundleFee Fee for selecting ProPackBundle (at a discount over individually selecting Border, BoldTitle,
Featured and Highlight). Valid only for U.S. and Canadian eBay Motors.
ReserveFee eBay fee for specifying a reserve price for the auctioned item.
46 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 46
Data Field Name Description
SubtitleFee eBay fee to add a subtitle to item listing.
SchedulingFee eBay fee to schedule a listing for a later date.
CustomLabel Holds your internal SKU or unique identifier and is a very useful way to index your inventory with
eBay listings and associated costs.
PrivateNotes Value you can assign that can help identify the line items (for example, a short description).
Active Listings Data Fields
Active Listings File Data Fields
Data Field Name Description
ItemID eBay-generated ID number that is given to successful listings only.
CustomLabel Value you can assign (such as internal SKU or unique identifier); way to index your inventory with
eBay listings and associated costs.
ProductIDType Type of data contained in ProductIDValue such as ISBN, UPC, EAN or eBay-generated
ProductIdentifier.
ProductIDValue Value of ProductIDType.
QuantityAvailable Number of items remaining for a particular listing.
Purchases Only applies to Store Inventory and Fixed Price. Current number of purchases for a listing. Note that
# of purchases does not necessarily = # of items purchased.
Bids Current number of bids on a listing. Only applies to Chinese, Dutch and Live Auctions. (Note that the
Live Auctions option gives you a snapshot of your My eBay active listings which includes any Live
Auction listings.)
Price
Chinese, Dutch, Live Auctions = Highest current bid; Fixed Price, Store Inventory = Buy It Now price;
Second Chance Offer = Price offered; Ad/Real Estate = Listed price
(Note that the Live Auctions option gives you a snapshot of your My eBay active listings which
includes any Live Auction listings.)
StartDate Date the listing was created; for example, Mar-25-05.
EndDate Date the listing was ended; for example, Apr-01-05.
Condition Condition of the item.
Type Format ID: 0 = Unknown auction type, 1 = Chinese auction, 2 = Dutch Auction, 5 = Live Auctions, 6 =
Ad/Real Estate, 7 = Store Inventory, 8 = Second Chance Offer, 9 = Fixed Price.
(Note that the Live Auctions option gives you a snapshot of your My eBay active listings which
includes any Live Auction listings.)
ItemTitle Listing title.
CategoryLeafName Name of leaf category.
CategoryNumber Number of the leaf category in which the listing was created.
PrivateNotes Value you can assign that can help identify the line items (for example, a short description or SKU).
SiteListed eBay site on which the item is listed, denoted by an integer; for example, 0 (U.S.), 100 (eBay
Motors), 77 (Germany).
DownloadDate Date/time the Active Listings file was downloaded; for example, Mar-29-05 13:32:01 PST.
47 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 47
Glossary
Attributes
Also known as
Item Specifics
.
BMMG
Books, Movies, Music and Videogames category. These are “catalog-enabled” categories.
Also referred to as “Media” or “Books and Entertainment” categories.
Catalog
A database of products that includes data describing each unique product, for example, the
‘Muze’ catalog for Movies.
CSV File
Comma Separated Values file format (see Flat File) that has .csv extension. File format that
separates values with a comma or semicolon. This format is compatible with Microsoft Excel.
Data Transfer or Data Upload
The manner in which data is transmitted from one device to another. This transfer activity is
usually defined in rates such as megabytes per second.
eBay Store Listing
eBay Store listings are listings that can be seen only in the Seller’s store. These listing will not
be found in the standard search and are priced differently than eBay Core Listing.
eBay Core Listing
eBay Core listings are found using the standard eBay browse or search process.
Flat File
A flat file is a file containing records that have no structured interrelationship. Many users
would call a Microsoft® Word or Excel document that has been saved as “text only, .txt” a
flat file. Files or spreadsheets saved in text (.txt), comma-separated values (.csv), or semicolon-
separated (also .csv) format are “flat files.”
Item Specifics
Also known as
Attributes. Item Specifics is an eBay feature that allows you to provide
additional item details within a category that help buyers find your item. Buyers view Item
Specifics as search or browse options called Product Finders.
The Item Specifics are determined by the category in which you sell your item. For example,
the Item Specifics available in an apparel category would be related to size and style, while
Item Specifics in a CD music category could refer to genre and condition.
48 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 48
The Item Specifics you provide are displayed at the top of your item description and are used
by buyers to search for items. They are considered a binding part of your item description.
ItemID
ItemID is a field in the eBay File Exchange Data Dictionary that corresponds to the eBay
unique ID given to an eBay listing upon successful completion of the listing process.
Metadata
Also known as “data about data,” metadata is the information that is encoded in the listing
templates and describes aspects of the template, such as SiteID, Country, Currency, API
Compatibility, and Character Set, as well as providing a means to control the values in each
header. eBay File Exchange provides metadata information in the first row of the first column
of each upload file (the same cell as the Action field).
Pre-filled Item Information
The name used to refer to the catalog in the user interface and help text. When sellers list
using the catalog, they are listing using the “Pre-filled Item Information”. If the listing’s
catalog data might be affected by a change elsewhere, we say that it may affect the listing’s
“Pre-filled Item Information”.
Stock Photo
A product image for a specific product that is supplied by Catalog.
Token
The means by which File Exchange files are authenticated for users who automate their data
exchange with eBay. Product tokens are used to allow communicating applications to identify
themselves by software name and version.
o eBay issues a token per seller request and is valid for up to a year.
o Tokens issued by File Exchange cannot be used to authenticate for any other
operation on the eBay site.
ProductIDType
ProductIDType is a field in the Complete Data Field Dictionary
on page 32 that corresponds
to the product number, SKU, UPC or EAN as designated by the Seller.
49 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 49
Index
API compatibility level...................................................... 16
BIG5 ........................................................................ 16
Checkout and Payment Fields......................................... 38
Country
Metadata Values table................................................. 14
CP1252 ........................................................................ 16
Currency
Metadata Values table................................................. 16
Data field dictionary ......................................................... 32
gift fields ...................................................................... 37
listing details and display fields.................................... 34
post-sale management fields....................................... 44
pricing and checkout fields .......................................... 38
pricing fields................................................................. 36
required fields only ...................................................... 32
shipping fields.............................................................. 40
tax fields ...................................................................... 37
Ending your listings............................................................ 5
required fields............................................................ 5, 6
Field relationships............................................................ 17
troubleshooting............................................................ 17
File Conventions................................................................ 9
Action field..................................................................... 9
asterisks in data field names ......................................... 9
comment rows............................................................... 9
Comment-only rows..................................................... 10
excess fields for given action, including....................... 11
field relationships......................................................... 17
file size limit................................................................... 9
Info rows.................................................................. 9, 10
multiple actions in one file, including ........................... 11
required fields................................................................ 9
Required Fields, table.................................................. 10
smart headers..............................................................17
Upload Limit.................................................................10
Filling in the template
data values.....................................................................9
GB2312 ........................................................................16
Gift Fields ........................................................................37
HTML
using <BR> and <P>......................................................9
International sites
variations in template contents.....................................19
Item Specifics
as determined by category selected.............................12
Leaving feedback
required fields.................................................................6
Listing details and display fields .......................................34
Marking items paid
required fields.................................................................6
Marking items shipped
required fields.................................................................6
Metadata cell
API compatibility level ..................................................16
character set ................................................................16
Country ........................................................................13
Currency ......................................................................16
SiteID ...........................................................................13
Non-U.S. eBay sites.........................................................17
template formats for each site......................................17
Payment and Checkout Fields..........................................38
Post-Sale Management Fields .........................................44
Pricing Fields....................................................................36
Programmatic instructions to download files
requirements..................................................................8
Programmatic instructions to upload files
50 eBay File Exchange Basic Template Instructions
eBay File Exchange Basic Template Instructions 50
HTTP post request components.................................... 7
requesting an eBay token.............................................. 7
requirements.................................................................. 6
Relisting your items ........................................................... 5
required fields................................................................ 5
Revising your listings......................................................... 5
active listings report....................................................... 5
required fields................................................................ 5
Shipping Fields ................................................................ 40
SiteID
Metadata Values table................................................. 13
Smart headers..................................................................17
overriding .....................................................................17
rules .............................................................................17
Tax Fields 37
Updating Item Status..........................................................6
leaving feedback............................................................6
marking items paid.........................................................6
marking items shipped ...................................................6
UTF-8 16
VerifyAdd your listings........................................................5
