AccountStateCodeType - Type declaration to be used by other schema. These are the possible codes to describe the state of an account of an eBay user. Amex Visa Mastercard Reserved for internal or future use. AckCodeType - Type declaration to be used by other schema. This code identifies the acknowledgement code types that could be used to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application level acknowledgement element. Request processing succeeded. Request processing failed. Request processing completed with warning information being included in the response message. Request processing completed successful with some with some warning information that could be useful for the requesting application to process and/or record. Request processing failed with some error and warnining information that requesting application should process to determine cause(s) of failure. Reserved for internal or future use. AddressOwnerCodeType - Type declaration to be used by other schema. This code identifies the AddressOwner code types which indicates who owns the user'a address. PayPal owns address. eBay owns address. Reserved for internal or future use. AuctionTypeCodeType - Type declaration to be used by other schema's. This includes codes indicating the type of auction for the listed item. Unknown auction type Chinese auction Dutch auction Live Auctions-type auction Ad type auction Stores Fixed-price auction (US only) Personal Offer auction Fixed Price item ("BIN only"). Reserved for internal or future use. BalanceCodeType - Type declaration to be used by other schema. This code identifies the types of balances in an account, e.g., a PayPal account. Custom Code Reserved for internal or future use. BuyerPaymentMethodCodeType - Type declaration to be used by other schema. The includes the codes for payment methods used by buyers to pay sellers. No payment method specified Money order/cashiers check American Express Payment See Description American Express Personal check COD Visa/Mastercard Other forms of payment. Some custom method is accepted by seller as payment method in the transaction. For Motors vehicle items, this field refers to the Deposit payment method. PayPal Discover Payment on delivery acceptable payment term. Direct transfer of money acceptable payment term. If the seller has bank account information on file, and MoneyXferAcceptedinCheckout = true, then the bank account information will be displayed in Checkout. Applicable to German site only. Online Escrow paid for by seller. Reserved for internal or future use. BuyerProtectionCodeType - Type declaration to be used by other schema. Item is ineligible (e.g., category not applicable). Item is eligible per standard criteria. Item marked ineligible per special criteria (e.g., seller's account closed). Item marked eligible per other criteria. Reserved for internal or future use. CheckoutStatusCodeType - Type declaration to be used by other schema. Checkout complete. Checkout incomplete. No details specified. Buyer requests total. Seller responded to buyer's request. Reserved for internal or future use. CountryCodeType - Type declaration to be used by other schema. This code list module defines the enumerated types of standard 2-letter ISO 3166 country codes. This codelist contains some additional country code not defined in the ISO 3166 country code set. NOTE: APO/FPO was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country code list for backward compatibility. NOTE: Guernsey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jan Mayen was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jersey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Tahiti was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. Reserved for internal or future use. This code list module defines the enumerated types of standard 3-letter ISO 4217 currency codes. Reserved for internal or future use. DepositTypeCodeType - Type declaration to be used by other schema's. This code identifies the DepositType codes used to specify deposit types for Motors items. If the ietm listed is not a Motors item, then always return DepositType value to be "None". None Other Method Fast Deposit. Reserved for internal or future use. DetailLevelCodeType - Type declaration to be used by other schema. Return in response message all detail levels. Return item description. Return attributes as part of the item. This file defines re-useable base and aggregate components of the eBay Business Lanaguage (eBL) that would be used to compose message payloads for eBay APIs. Represents the unique identifier for an item. To be used to specify the elements that represents an ItemID. Balance as of a given entry, can be 0.00. Credit Amount for a detail entry, can be 0.00. Date entry was posted, in GMT. Debit Amount for this detail entry, can be 0.00. Item number if transaction is associated with an auction or 0 if no item is associated with an account entry. Memo line for an account entry, can be empty string. eBay reference number for an account entry. Integer code for account details entry type. This element element specifies an index to a table of explanations for accounting charges. The AdditionalAccount component represents historical data related to accounts that the user held with a country of residency other than the current one. eBay users can have one active account at a time. For users who change their country of residency and modify their eBay registration to reflect this change, the new country of residence becomes the currently active account. Any account associated with a previous country is treated as an additional account. Because the currency for these additional accounts are different than the active account, each additional account includes an indicator of the currency for that account. Users who never change their country of residence will not have any additional accounts. Merchandizing info for an Item. This contains a list of crosssell or upsell items. Item ID for the base item. Based on this item other items are promoted. it is teh only tag that would show up in all calls that use promoted item type. some are not in soap yet, such as get and ser promotion rules URL for the picture of the promoted item. Where to display in the list of items.currentl y even forget and set does not have to be minoccur =0 but if we ever were to do revise promotion tems, it can be omitted Promotion Price. Price at which the buyer can buy the item now. Item Title for the promoted item. Merchandizing info for an Item. This contains a list of crosssell or upsell items. PrimaryScheme, PromotionMethod,SellerId,ItemId, ShippingDiscount do not have be min occur 0 Item ID for the base item. Based on this item other items are promoted. Id of the Seller who is promoting this item. Shipping Discount offered or not by the seller. Key of the Seller who is promoting this item. Store Name for the seller. Includes account summary for the user. Number of additional accounts. Amount past due, 0.00 if not past due. First four digits (with remainder Xed-out). This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Last time/day BankAccountInfo and/or BankRoutingInfo was modified, in GMT. This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Indicates the billing cycle in which eBay sends a billing invoice to the specified user. Possible values: 0 = On the last day of the month. 15 = On the 15th day of the month. Expiration date for the credit card selected as payment method, in GMT. Empty string if no credit card is on file or if account is inactive -- even if there is a credit card on file. Last four digits of user's credit card selected as payment type. Empty string if no credit is on file. This may be an empty string depending upon the value of the payment type for the user account (e.g, if no debit-card specified). Last date credit card or credit card expiration date was modified, in GMT. This may be an empty string depending upon the value of the payment type for the user account (e.g, Empty string if no credit card is on file. User's current balance. Can be 0.00, positive, or negative. Amount of last payment posted, 0.00 if no payments posted. Amount of last invoice. 0.00 if account not yet invoiced. Date of last invoice sent by eBay to the user, in GMT. Empty string if this account has not been invoiced yet. Date of last payment by specified user to eBay, in GMT. Empty string if no payments posted. Indicates whether the account has past due amounts outstanding. Possible values: true = Account is past due. false = Account is current. Indicates the method the specified user selected for paying eBay. The values for PaymentType vary for each SiteID. Information about user used by buying applications Information about user used by selling applications there are number of required elements - they will always show up for seller node there is not such a call to do revise seller info. only added minoccur=0 to elements that will not show up in every type of request/responce Indicates whether the user has elected to participate as a seller in the Merchandising Manager feature. Definition of an eBay Fee type. Following are the current set of eBay fee types AuctionLengthFee BoldFee BuyItNowFee CategoryFeaturedFee FeaturedFee FeaturedGalleryFee FixedPriceDurationFee GalleryFee GiftIconFee HighLightFee InsertionFee ListingDesignerFee ListingFee PhotoDisplayFee PhotoFee ReserveFee SchedulingFee ThirtyDaysAucFee Instances of this type could hold one or more supported types of fee. Calculated cost of shipping, based on shipping parameters and selected shipping service. Only returned if ShippingType = 2 (i.e., calculated shipping rate). Optional fees a seller might assess for the shipping of the item. Describes any error message associated with the attempt to calculate shipping rates. If there was no error, returns "No Error" (without the quotation marks). is unique identified of shipping carrier, without this element the whole node makes no sence Potal/zip code from where package will be shipped. Indicates an item that cannot go through the stamping machine at the shipping service office (a value of True) and requires special or fragile handling. Only returned if ShippingType = 2. contains information about shipping fees per each shipping service chosen by the seller May need to be moved into details - wait for George! The size of the package to be shipped. Possible values are: None Letter Large envelope USPS flat rate envelope Package/thick envelope USPS large package/oversize 1 Very large package/oversize 2 UPS Letter Shipping weight unit of measure (major). If unit of weight is kilogram (i.e., metric system) this would be the exact weight value in kilogram (i.e., complete decimal number, e.g., 2.23 kg). Only returned if ShippingType is 2. Shipping weight unit of measure (minor). If unit of weight is in pounds and/or ounces, this would be the exact weight value in ounces (i.e., complete decimal number, e.g., 8.2 or 8.0 ounces). Only returned if ShippingType is 2. Any additional shipping costs for the item. Amount of the sales tax to be collected for the transaction. Sales tax is only for US. Sales tax for the transaction, expressed as a percentage. Should be empty for items listed on international sites (hence, this is US-only element). Indicates whether shipping is included in the tax. Applicable if ShippingType = 1 or 2. This element is used for US-only. Specifies the shipping payment details. Indicates whether the buyer edited the payment amount. Calculated shipping rate details. If present, then the calculated shipping rate option was used. Indicates whether the payment instructions are included (e.g., for updating the details of a transaction). Flat shipping rate details. If present, then the flat shipping rate option was used. Total cost of insurance for the transaction. Indicates whether buyer selected to have insurance. Payment instuctions. Sales tax details. Sales tax applicable for only US sites. For non-US sites this sub-element should not be used. Postal/Zip code from where the seller will ship the item. URLs for item picture that are stored/hosted at eBay site. Type of display for photos used for PhotoHosting slide show. Here are display options: None = No special Picture Services features. SlideShow = Slideshow of multiple pictures. SuperSize = Super-size format picture. PicturePack = Picture Pack. Default is 'None'. This will be either "Featured" or "Gallery". URLs for item picture that are stored/hosted at eBay site. URL for a picture for the gallery. If the GalleryFeatured argument is true, a value must be supplied for either the GalleryURL or the PictureURL argument. In either case: (a) If a URL is provided for only PictureURL, it is used as the Gallery thumbnail. (b) If a URL is provided for both GalleryURL and PictureURL, then the picture indicated in GalleryURL is used as the thumbnail. The image used for the Gallery thumbnail (specified in the GalleryURL or PictureURL argument) must be in one of the graphics formats JPEG, BMP, TIF, or GIF. This will be either "Featured" or "Gallery". Specific physical attribute of an item. ValueList of the Attribute being described by the AttributeID. Constant name of the attribute that identifies a physical attribute within a set of characteristics that describe something in a formalised way. AttributeSet. Container for data on the primary category of listing. CSIDList is not present if Attributes enabled. Contains the eBay Stores-specific item attributes department number and store location. StorefrontInfo is shown for any item that belongs to an eBay Store owner, regardless of whether it is fixed price or auction type. Returned as null for international fixed price items. assumed this type is specific to add/get/revise item, then each StorefrontType nust have category id, for store details this node makes no sense to use in case or revise item for example - to change store category (department) you do not need to change store URL, so it will notbe in request Identifies the Layout and the Theme template associated with the item. in case of revision - all data can be min occur = 0 Identifies the Layout template associated with the item. A value of true for OptimalPictureSize indicates that the picture URL will be enlarged to fit description of the item. Identifies the Theme template associated with the item. Contains information about a Charity listing.in case of revision - all data can be min occur = 0 Contains the listed items price details which consists of following information: BuyItNowPrice, ConvertedBuyItNowPrice, ConvertedPrice, ConvertedStartPrice, CurrentPrice, MinimumToBid, ReservePrice, and StartPrice. need to take in account get seller events when defining minoccurs = 0 Number of bids placed so far against the item. Not returned for International Fixed Price items. Smallest amount a bid must be above the current high bid. Not returned International Fixed Price items. Converted current price of listed item. For auction-format listings, current minimum asking price or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed against the item. This field does not reflect the actual current price of the item if it's a Type=7 or Type=9 (Fixed Price) item and the price has been revised. (See StartPrice for revised asking price.) Contains one User node representing the current high bidder. GetItem returns a high bidder for auctions that have ended and have a winning bidder. For Fixed Price listings, in-progress auctions, or auction items that received no bids, GetItem returns a HighBidder node with empty tags. Applicable to ad-format items only. Indicates how many leads to potential buyers are associated with this item. For other item types (other than ad-format items), returns a value of 0 (zero). Minimum acceptable bid for the item. Not returned for International Fixed Price items. Number of items purchased so far. (Subtract from the value returned in the Quantity field to calculate the number of items remaining.) Returns true if the reserve price was met or no reserve price was specified. Contains the revise status information details (e.g., item properties information). ths node contains system set data only - always output and always all data. no minccurs needed, except for motors specific data, since it wil lnot be retruned for non motors items Indicates whether the item was revised since the auction started. If true, indicates that a Buy It Now Price was added for the item. Only returned for Motors items. Replaces BinLowered as of API version 305. If true, indicates that the Buy It Now Price was lowered for the item. Only returned for Motors items. If true, indicates that the Reserve Price was lowered for the item. Only returned for Motors items. If true, indicates that the Reserve Price was removed from the item. Only returned for eBay Motors items. Contains the listed item details which consists of following information: . Converted value of the BuyItNowPrice in the currency indicated by SiteCurrency. This value must be refreshed every 24 hours to pick up the current conversion rates. Converted value of the StartPrice field in the currency indicated by SiteCurrency. This value must be refreshed every 24 hours to pick up the current conversion rates. Indicates the converted reserve price for a reserve auction. Returned only if DetailLevel = 4. ReservePrice is only returned for auctions with a reserve price where the user calling GetItem is the item's seller. Returned as null for International Fixed Price items. For more information on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1. Indicates the new ItemID for a relisted item. When an item is relisted, the old (expired) listing is annotated with the new (relist) ItemID. This field only appears when the old listing is retrieved. The ItemID for the original listing (i.e., OriginalItemID specific to Second Chance Offer items). Time stamp for the start of the listing (in GMT). For regular items, StartTime is not sent in at listing time. Time stamp for the end of the listing (in GMT). Returns custom, application-specific data associated with the item. The data in this field is stored with the item in the items table at eBay, but is not used in any way by eBay. Use ApplicationData to store such special information as a part or SKU number. Maximum 32 characters in length. Carries one or more instances of the AttributeSet in a list. If true (1), indicates that the seller requested immediate payment for the item. False (0) if immediate payment was not requested. (Does not indicate whether the item is still a candidate for puchase via immediate payment.) Only applicable for items listed on US and UK sites in categories that support immediate payment, when seller has a Premier or Business PayPal account. Indicates the status of the item's eligibility for the Buyer Protection Program. Possible values: ItemIneligible - Item is ineligible (e.g., category not applicable) ItemEligible - Item is eligible per standard criteria ItemMarkedIneligible - Item marked ineligible per special criteria (e.g., seller's account closed) ItemMarkedIneligible - Item marked elegible per other criteria Applicable for items listed to the US site and for the Parts and Accessories category (6028) or Everything Else category (10368) (or their subcategories) on the eBay Motors site. Amount a Buyer would need to bid to take advantage of the Buy It Now feature. Not applicable to Fixed-Price items (Type = 7 or 9) or AdFormat-type listings. For Fixed-Price items, see StartPrice instead. Charity listing container. 2-letter ISO 3166 Country Code. CrossPromotions container, if applicable shows promoted items 3-letter ISO Currency Code. Item Description. Online Escrow paid for by buyer or seller. Cannot use with real estate auctions. Escrow is recommended for for transactions over $500. Escrow service, available via Escrow.com, protects both buyer and seller by acting as a trusted third-party during the transaction and managing the payment process from start to finish. Also, if escrow by seller option used, then for Motors, this means that Escrow will be negotiated at the end of the auction. If set, a generic gift icon displays in the listing's Title. GiftIcon must be set to to be able to use GiftServices options (e.g., GiftExpressShipping, GiftShipToRecipient, or GiftWrap). Gift service options offered by the seller of the listed item. Optional hit counter for the item's listing page. Possible values are: "NoHitCounter" "HonestyStyle" "GreenLED" "Hidden" The ID that uniquely identifies the item listing. Includes listing details in terms of start and end time of listing (in GMT) as well as other details (e.g., orginal item for second chance, converted start price, etc.). When an item is first listed (using AddItem), a Layout template or a Theme template (or both) can be assigned to the item. A Layout template is assigned to a new item by specifying the Layout template ID (in the AddItem input argument LayoutID). Similarly, a Theme template is assigned to the item using the ThemeID argument. Describes the number of days the auction will be active. Describes the types of enhancment supported for the item's listing. Describes the type of listing for the item a seller has chosen (e.g., Chinese, Dutch, FixedPrice, etc.). Indicates the geographical location of the item. Needed for add item only for partners. Needed for add item only for partners. List of payment methods accepted by a seller from a buyer for a (checkout) transaction. Valid PayPal e-mail address if seller has chosen PayPal as a payment method for the listed item. Container for data on the primary category of listing. Private auction. Not applicable to Fixed Price items. Number of items being sold in the auction. Region where the item is listed. See Region Table for values. If the item is listed with a Region of 0 (zero), then this return field denotes no region association with the item, meaning that it is not listing the item regionally. If true, creates a link from the old listing for the item to the new relist page, which accommodates users who might still look for the item under its old item ID. Also adds the relist ID to the old listing's record in the eBay database, which can be returned by calling GetItem for the old ItemId. If your application creates the listing page for the user, you need to add the relist link option to your application for your users. Indicates the reserve price for a reserve auction. Returned only if DetailLevel = 4. ReservePrice is only returned for auctions with a reserve price where the user calling GetItem is the item's seller. Returned as null for International Fixed Price items. For more information on reserve price auctions, see http://pages.ebay.com/help/basics/f-format.html#1. Revise Status contains information about the item being revised. Container for data on the secondary category of listing. Secondary category is optional. Item picture information for pictures hosted at eBay site. Seller user. Container for for selling status information (e.g., BidCount, BidIncrement, HighBidder, MinimimumToBid, etc). Specifies where the seller is willing to ship the item. Default "SiteOnly". Valid values are: SiteOnly (the default) WorldWide SitePlusRegions WillNotShip If SitePlusRegions is selected, then at least one regions argument (ShipToNorthAmerica, ShipToEurope, etc.) must also be set. Contains the shipping payment related information for the listed item. Regions that seller will ship to. Describes who pays for the delivery of an item (e.g., buyer or seller). eBay site on which item is listed. Starting price for the item. For Type=7 or Type=9 (Fixed Price) items, if the item price (MinimumBid) is revised, this field returns the new price. Storefront is shown for any item that belongs to an eBay Store owner, regardless of whether it is fixed price or auction type. Not returned for International Fixed Price items. Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. Time until the the end of the listing (e.g., the amount of time left in an active auction). Name of the item as it appears for auctions. Universally unique constraint tag. The UUID is unique to a category. VAT info container. Item picture information for pictures hosted at vendor (i.e., remote) site. Contains information about multiple individual transations. Contains information about a single transaction. A transaction contains information about the sale of a particular item. The system creates a transaction when a buyer has made a purchase (Fixed Price items) or is the winning bidder (BIN and auction items). A listing can be associated with one or more transactions in these cases: Multi-Item Fixed Price Listings Dutch Auction Listings A listing is associated with a single transaction in these cases: Single-Item Fixed Price Listings Single-Item Auction Listings The amount the buyer paid for the item or agreed to pay, depending on how far into the checkout process the item is. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by calling GetSellerTransactions or GetSellerTransactions and comparing the AmountPaid value to what the seller expected. For Motors items, AmountPaid is the amount paid by the buyer for the deposit. Container for buyer data. Includes shipping payment data. Value returned in the Transaction/AmountPaid element, converted to the currency indicated by SiteCurrency. Value returned in the Transaction/TransactionPrice element, converted to the currency indicated by SiteCurrency. For fixed-price, Stores, and BIN items indicates when the purchase (or BIN) occurred. For all other item types indicates when the transaction was created (the time when checkout was initiated). Deposit type for Motors items. If item is not a Motors item, then returns a DepositType of None. Possible values: None Other Method Fast Deposit Item info associated with the transaction. Contains the number of individual items the buyer purchased in the transaction. Shipping cost totals shown to user (for both flat and calculated rates). Container node for transaction status data. Unique identifier for a transaction. Returns 0 when Type=1 (Chinese auction). Typically, an ItemID and a TransactionID uniquely identify a checkout transaction. Unique identifier for an authorization. Price of the item, before shipping and sales tax. For Motors, TransactionPrice is the deposit amount. VAT rate for the item, if the item price includes the VAT rate. Specify the VATPercent if you want include the net price in addition to the gross price in the listing. VAT rates vary depending on the item and on the user's country of residence; therefore a business seller is responsible for entering the correct VAT rate (it will not be calculated by eBay). Indicates the success or failure of an eBay Online Payment for the transaction. If the payment failed, the value returned indicates the reason for the failure. Possible values: 0 = No payment failure. 3 = Buyer's eCheck bounced. 4 = Buyer's credit card failed. 5 = Buyer failed payment as reported by seller. 7 = Payment from buyer to seller is in PayPal process, but has not yet been completed. Indicates the current state of the checkout process for the transaction. Possible values: 0 = Checkout complete. 1 = Checkout incomplete. No details specified. 2 = Buyer requests total. 3 = Seller responded to buyer's request. Indicates last date and time checkout status or incomplete state was updated (in GMT). Payment method used by the buyer. (See BuyerPaymentCodeList/Type). Indicates whether the transaction process complete or incomplete. Possible values: 1 = Incomplete 2 = Complete Feedback scores are a quantitative expression of the desirability of dealing with that person as a Buyer or a Seller in auction transactions. Each auction transaction can result in one feedback entry for a given user (the Buyer can leave one feedback about the Seller and the Seller can leave one feedback about the Buyer). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). This rating is commonly expressed as the eBay Feedback score for the user. If present, indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See Value-Added Tax (VAT). Not returned for users whose country of residence is outside the EU. Possible values for the user's status: 2 = Residence in an EU country but user registered as VAT-exempt 3 = Residence in an EU country and user not registered as VAT-exempt Contains information required To list a business item. BusinessSeller - only for add item, the RestrictedToBusiness and VATPercent for both get and add, for revise all must be optional Contains information for Scheduling limits for the user. All dtails must be present,unless we will have revise call one day, just in case we might let's make min occur = 0 Amount of insurance. Applicable if ShippingType is Flat shipping rate orCalculated shipping rate. Indicates whether insurance fee is required. Possible values: Insurance not offered. Insurance optional. Insurance required. Insurance included in Shipping and Handling costs. Applicable if ShippingType is Flat shipping rate or Calculated shipping rate. Shipping carrier for the item. Possible values are: UPS Ground UPS 3rd Day UPS 2nd Day UPS Next Day USPS Priority USPS Parcel USPS Media USPS First Class Custom categories for subdividing the items within an eBay Store. Store owners can create up to 12 custom categories for their stores. (One Store category cannot be customized and retains the value of "Other") If specified, must be number between 0 and 12. 0=Not an eBay Store item 1=Other 2=Category 1 3=Category 2 ... 11=Category 10 12=Category 11 Returned as null for international fixed priced item. URL pointing to the seller's eBay Store page. Returned as null for International Fixed Price items. This URL follows the format below, where "####" is replaced by the seller's eBay Stores ID (that uniquely identifies the eBay Store). http://www.ebaystores.com/id=#### Inclusion of all supported eBay Business Language (eBL) Code Lists. This schema definition file contains specification for: 1) eBay Business Langauge (eBL) Abstract Request and Response Message which will be used to construct payloads for various applications; 2) Re-useable error components of the eBL that would be used to communicate application-level error messages back to the client application. These application error messages may be due to a problem detected while processing the request message. 3) Other utility components needed by various eBay buying, selling, and payment applications, e.g., address type and element. Value of the application-specific error parameter. Specifies application-specific error parameter name. Error code can be used by a receiving application to debugging a response message. These codes will need to be uniquely defined for each application. SeverityCode indicates whether the error is an application level error or if it is informational error, i.e., warning. This optional element may carry additional application-specific error variables that indicate specific information about the error condition particularly in the cases where there are multiple instances of the ErrorType which require additional context. Error code can be used by a receiving application to debugging a SOAP response message that contain one or more SOAP Fault detail objects, i.e., fault detail sub-elements. These codes will need to be uniquely defined for each fault scenario. Severity indicates whether the error is a serious fault or if it is informational error, i.e., warning. Base type definition of request payload that can carry any type of payload content with optional versioning information and detail level requirements. This specifies the required detail level that is needed by a client application pertaining to a particular data component (e.g., Item, Transaction, etc.). The detail level is specified in the DetailLevelCodeType which has all the enumerated values of the detail level for each component. This should be the standard RFC 3066 language identification tag, e.g., en_US. The MessageID is used to correlate (i.e., reference) the response message to a specific request message. This refers to the version of the request payload schema. Base type definition of a response payload that can carry any type of payload content with following optional elements: - timestamp of response message, - application level acknowledgement, and - application-level errors and warnings. This value represents the date and time (GMT) when the response was generated by a service provider (as a result of processing of a request). Application level acknowledgement code. CorrelationID may be used optionally with an application level acknowledgement. This refers to the version of the response payload schema. This refers to the specific software build that was used in the deployment for processing the request and generating the response. This element should only be used in response elements and typically should not be used in creating request messages which specify the name of a country using the Country element (which refers to a 2-letter country code). Only applicable to SellerPaymentAddress today. Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress today. International state and city for the seller's payment address. Only applicable to SellerPaymentAddress today. Seller's international street address that is associated with the payment address. EscrowCodeType - Type declaration to be used by other schema. These are the possible codes to describe Escrow options. By Buyer By Seller. None. Reserved for internal or future use. FeedbackRatingStarCodeType - Type declaration to be used by other schema. No graphic displayed Yellow Star Turquoise Star Purple Star Red Star Green Star Yellow Shooting Star Turquoise Shooting Star Purple Shooting Star Red Shooting Star Blue Star Reserved for internal or future use. GalleryTypeCodeType - Type declaration to be used by other schema. Specifies the codes for various properties of an item. Indicates whether it is a featured item. Include in the gallery. Reserved for internal or future use. GeneralPaymentMethodCodeType - Type declaration to be used by other schema. This code identifies the general types of payment means, e.g., used by payment service provider applications. Custom Code Electronic check. ACH. Credit-card. Pay balance. Reserved for internal or future use. GiftServicesCodeType - Type declaration to be used by other schema's. Specifies the codes for the various Gift Services offered by sellers. If any of the Gift Services are offered by the seller, the generic gift icon should be used to display the item: http://pics.ebay.com/aw/pics/gift/gift.gif indicates that the seller is offering to ship the item via an express shipping method as described in the item description. indicates that the seller is offering to ship to the gift recipient, not the buyer, when payment clears. indicates that the seller is offering to wrap the item (and optionally include a card) as described in the item description. Reserved for internal or future use. HitCounterCodeType - Type declaration to be used by other schema. This code identifies the HitCounter codes used to specify whether a hit counter is used for the item's listing page and, if so, what type. No hit counter Honesty Style Hit Counter Green LED counter. Hidden counter. Reserved for internal or future use. InsuranceOptionCodeType - Type declaration to be used by other schema. These are the possible codes to describe insurance option as part of shipping service. Insurance optional. Insurance required. Insurance not offered. Insurance included in Shipping and Handling costs. Reserved for internal or future use. ListingDurationCodeType - Type declaration to be used by other schema. These are the possible codes to describe the number of days the auction will be active. Must be one of the values 3, 5, 7, or 10 for auction and basic Fixed-Price (Type 9) listings. Must be 30, 60, 90, 120, or GTC for Stores Fixed-Price (Type 7) listings. Specify GTC for the Good 'Til Cancel feature (eBay Stores items only). 1 Day 3 Days 5 Days 7 Days 10 Days 30 Days 60 Days 90 Days 120 Days GTC Reserved for internal or future use. ListingEnhancementsCodeType - Type declaration to be used by other schema. Specifies the codes for various properties of an item. Indicates whether an item will be displayed with a border that will go around the item (e.g., for category-based search result page or store search that brings up multiple items) to differentiate it from the rest of list. Indicates whether the bolding option was used. Indicates whether it is a featured item. Indicates item's listing is highlighted. Indicates item's listing is home page featured. Reserved for internal or future use. eBay Listing Enhancements Codes Code List Agency - eBay, Inc. Code List Version - 1.0 ListingTypeCodeType - Type declaration to be used by other schema. This includes codes indicating the type of auction for the listed item. Unknown Listing Type Chinese auction Dutch auction Live Auctions-type auction Ad type auction Stores Fixed-price auction (US only) Personal Offer auction Fixed Price item ("BIN only"). Reserved for internal or future use. MerchandizingPrefCodeType - Type declaration to be used by other schema. OptIn OptOut Reserved for internal or future use. ModifyCodeType - Type declaration to be used by other schema. This code identifies the types of modification you can make on an object. account. Indicate filed is to be dropped. Indicate filed is to be modified. Reserved for internal or future use. PhotoDisplayCodeType - Type declaration to be used by other schema. These are types of display for photos used for PhotoHosting slide show. No special Picture Services features. Slideshow of multiple pictures. Super-size format picture. Picture Pack. Reserved for internal or future use. Cross Promotion Method. Auction Item Buy It Now Reserved. Do not use. Cross Promotion Method. Manual Selection Automatic Selection Reserved. Do not use. Cross Promotion Method. Cross Sell Up Sell Reserved. Do not use. Cross Promotion Context Promotion Scheme. Item to Item Promotional Scheme Item to Item Store Scheme Store to Store Scheme Reserved. Do not use. PurchasePurposeTypeCodeType - Type declaration to be used by other schema. This code identifies the purpose of purchases, e.g., by a PayPal application. Custom Code Reserved for internal or future use. SellerLevelCodeType - Type declaration to be used by other schema. Bronze Silver Gold Platinum Titanium None Reserved for internal or future use. SellerPaymentMethodCodeType - Type declaration to be used by other schema. These are payment methods that sellers can use to pay eBay. No payment method specified - some other payment method. Amex Visa Mastercard Discover JCB Diners Reserved for internal or future use. SeverityCodeType - Type declaration to be used by other schema. This code identifies the Severity code types in terms of whether there is an API-level error or warning that needs to be communicated to the client. Warning or informational error. Application-level error. Reserved for internal or future use. ShippingOptionCodeType - Type declaration to be used by other schema. These are the possible codes to describe shipping options in terms of where the seller is willing to ship the item. Site only. WorldWide. SitePlusRegions. WillNotShip. Reserved for internal or future use. ShippingPackageCodeType - Type declaration to be used by other schema. These are the possible codes to describe shipping package options. None. Letter. LargeEnvelope USPS Large Package/Oversize 1 Very Large Package/Oversize 2 UPS Letter USPS Flat Rate Envelope Package/thick envelope Reserved for internal or future use. ShippingRatesTypeCodeType - Type declaration to be used by other schema. The includes the codes for shipping types supported by sellers to transport items sold to buyers. Flat shipping rate. Calculated shipping rate. Reserved for internal or future use. ShippingRegion CodeType - Type declaration to be used by other schema. This code list module defines the enumerated types of regions for shipping items (i.e., a seller may support shipment of an item). Africa Asia Carribbean Europe LatinAmerica MiddleEast NorthAmerica Oceania (i.e., Pacific region other than Asia) SouthAmerica Reserved for internal or future use. ShippingServiceCodeType - Type declaration to be used by other schema. These are the possible codes to describe insurance option as part of shipping service. UPS Ground UPS 3rd Day UPS 2nd Day UPS Next Day. USPS Priority. USPS Parcel. USPS Media. USPS First Class ShippingMethodStandard - used by merchant tool only ShippingMethodExpress- used by merchant tool only ShippingMethodNextDay- used by merchant tool only USPS Express Mail USPS Ground Reserved for internal or future use. ShippingTermsCodeType - Type declaration to be used by other schema's. Shipping terms code describes who pays for the shipping of an item. These are the standard shipping terms, i.e., terms of delivery of an item. Seller pays all shipping costs. Buyer pays all shipping costs. Reserved for internal or future use. SiteCodeType - Type declaration to be used by other schema. These are site codes that buyers and sellers can use to identify their sites. USA Canada United Kingdom Australia Austria Belgium (French) France Germany Italy Belgium (Dutch) Netherlands Spain Switzerland Taiwan eBay Motors Hong Kong Singapore Reserved for internal or future use. UnitCodeType - Type declaration to be used by other schema. Kilogram. Pounds. Ounces Centimeter. Inches. Feet. Reserved for internal or future use. UserStatusCodeType - Type declaration to be used by other schema. User properties have never been set. This value should seldom, if ever, be returned and typically represents a problem. User has been suspended from selling and buying, such as for violations of eBay terms or agreement. User has completed online registration and has properly responded to confirmation email. Most users should fall in this category. User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. . Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay. Temporary user record state indicating the record is in the process of being changed by eBay. Query user information again to get new status. Records for the specified user have been deleted. User has completed registration and confirmation, but is pending a verification of credit card information. User's account is on hold, such as for non-payment of amounts due eBay. User cannot sell or buy items. User record has been merged with another account record for the same user. User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email. User has been scheduled for account closure (typically when a user has requested to have their account closed.) A user in this state should not be considered an active user. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending. Passport User. User has completed the registration process, but the registration confirmation is still pending. Passport User Requiring Credit Card Verification. User has completed the registration process with credit card verification, but the registration confirmation is still pending. Half.com User. User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending. Reserved for internal or future use. VATStatusCodeType - Type declaration to be used by other schema. No VAT Tax VAT Tax VAT Exempt Reserved for internal or future use. Type declaration to be used by other schemas. This is the credit card type TransactionId - Type for a PayPal Transaction ID. AuthorizationId - Type for a PayPal Authorization ID. RefundPurposeTypeCodeType - Type declaration to be used by other schema. This code identifies the types of refund transactions supported. Custom Code Full Refund Partial Refund MerchantPullPaymentResponseType - Type declaration to be used by other schemas. Response data from the merchant pull. MerchantPullInfoType - Type declaration to be used by other schemas. Information about the merchant pull. PaymentTransactionSearchResultType - Type declaration to be used by other schemas. Results from a PaymentTransaction search MerchantPullPayment - Type declaration to be used by other schemas. Parameters to make initiate a pull payment PaymentTransactionType - Type declaration to be used by other schemas. Information about a PayPal payment from the seller side ReceiverInfoType - Type declaration to be used by other schemas. Receiver information. PayerInfoType - Type declaration to be used by other schemas. Payer information PaymentInfoType - Type declaration to be used by other schemas. Payment information. SubscriptionTermsType - Type declaration to be used by other schemas. Terms of a PayPal subscription. SubscriptionInfoType - Type declaration to be used by other schemas. Information about a PayPal Subscription. AuctionInfoType - Type declaration to be used by other schemas. Basic information about an auction. OptionType - Type declaration to be used by other schemas. PayPal item options for shopping cart. PaymentDetailsItemType - Type declaration to be used by other schemas. Information about a Payment Item. PaymentItemType - Type declaration to be used by other schemas. Information about a Payment Item. PaymentItemInfoType - Type declaration to be used by other schemas. Information about a PayPal item. PaymentDetailsType - Type declaration to be used by other schemas. Information about a payment. Used by DCC and Express Checkout. CreditCardDetailsType - Type declaration to be used by other schemas. Information about a Credit Card. PaymentTransactionCodeType - Type declaration to be used by other schemas. This is the type of a PayPal of which matches the output from IPN PaymentStatusCodeType - Type declaration to be used by other schemas. This is the status of a PayPal Payment which matches the output from IPN AddressStatusCodeType - Type declaration to be used by other schemas. This is the PayPal address status PaymentDetailsCodeType - Type declaration to be used by other schemas. This is the PayPal payment details type (used by DCC and Express Checkout) PendingStatusCodeType - Type declaration to be used by other schemas. The pending status for a PayPal Payment transaction which matches the output from IPN ReversalReasonCodeType - Type declaration to be used by other schemas. Reason for a reversal on a PayPal transaction which matches the output from IPN PaymentCodeType - Type declaration to be used by other schemas. This is the type of PayPal payment which matches the output from IPN. PayPalUserStatusCodeType - Type declaration to be used by other schemas. PayPal status of a user Address MerchantPullPaymentCodeType - Type declaration to be used by other schemas. Type of Payment to be initiated by the merchant MerchantPullStatusCodeType - Type declaration to be used by other schemas. Status of the merchant pull PaymentTransactionStatusCodeType - Type declaration to be used by other schemas. The status of the PayPal payment. PaymentTransactionClassCodeType - Type declaration to be used by other schemas. The Type of PayPal payment. MatchStatusCodeType - Type declaration to be used by other schemas. This is the PayPal (street/zip) match code CompleteCodeType - Type declaration to be used by other schemas. This is the PayPal DoCapture CompleteType code Custom Securiy Header. The username is the identifier for an account. Password contains the current password associated with the username. This field identifies an account (e.g., payment) on whose behalf the operation is being performed. For instance one account holder may delegate the abililty to perform certain operations to another account holder. This delegation is done through a separate mechanism. If the base username has not been authorized by the subject the request will be rejected.