R-Index | eBay Trading API

This enumerated type is deprecated.

This field is deprecated.

The ranking of the corresponding keyword/category combination relative to other keywords that were returned in the response.

This container is used to reference and apply a seller's domestic and/or international shipping rate tables to a listing.

This type is used to reference a seller's specific domestic and/or international shipping rate tables.

This value is the seller's average rating (given by buyers) for the DSR area noted in the corresponding RatingDetail field.

A detailed seller rating for an order line item applied to the area in the corresponding RatingDetail field.

This field is deprecated.

This value is the total count of buyer ratings given for the DSR area noted in the corresponding RatingDetail field.

The value shown in this field indicates the Detailed Seller Rating area.

The area of a specific detailed seller rating for an order line item.

The status of a payment.

This field is deprecated.

Indicates if a message has been viewed by a given user.

This boolean field is used to change the 'Read' status of the message(s) in the MessageIDs container.

Describes how the application was marked down, automatically or manually.

This container includes brief and detailed text descriptions for the VeRO program intellectual property right infringement reason.

A container for VeRO reason code details.

Unique identifier for a reason code.

This field is returned only when the listing is currently being hidden from any searches occurring on eBay.

Enumerated type that defines the possible reasons why a listing is being hidden from search on the eBay site.

This field is deprecated.

Date and time that a message was received by My Messages and stored in a database for the recipient.

This boolean field is returned as true if the seller received a discount on the Final Value Fee for the order line item.

This field is deprecated.

This container consists of the name and email of the person who is receiving the digital gift card.

This field is used to specify the bidder that is being offered the Second Chance Offer.

Specifies the bidder from the original, ended listing to whom the seller is extending the second chance offer.

Recipient's eBay user ID.

This field is used to specify the postal code of the user to whom the seller is offering the Transaction Confirmation Request.

A seller can make a Transaction Confirmation Request (TCR) for an item.

The enumeration value supplied in this field specifies the current relationship between the seller and the potential buyer.

Recipient user ID of the notification.

This field is used to specify the recipient of the Transaction Confirmation Request (TCR).

This field is deprecated.

Displayable user ID of the recipient.

This field is deprecated.

This enumerated type is deprecated.

This field is deprecated.

This container provide details about relevant Item Specifics for the specified category.

This type is used to provide details about recommended Item Specifics and Product Identifier types.

This type was replaced by ListingRecommendationType

This type is used by the ValidationRules containers that are returned for each Item Specific in the GetCategorySpecifics response.

If true, indicates that the product is an exact match, suitable for listing the item.

The list of the sites where a seller has agreed to the cross-border recoupment terms.

Type used by the RecoupmentPolicyConsent container that is returned in the GetItem call response to indicate which sites the user (specified in UserID field of call request) has signed a cross-border trade Recoupment Policy Agreement.

Details the recoupment policies for the site specified in the request.

Details the recoupment policy on this site.

If true, ReduceReserveAllowed indicates that all categories on the site allow the seller to reduce an item's reserve price.

Uniquely identifies an order shipped using the Global Shipping Program.

This field is deprecated.

Reference identifier for the notification.

This field is deprecated.

A unique transaction ID for the payment.

This value is a merchant-defined identifier used to track In-Store Pickup refunds.

This field is deprecated.

This value is the unique identifier for the account entry.

Note: RefundArrayType and the Refund field are no longer applicable since the Half.com site has been shut down.

This container consists of the supported refund/exchange/replacement item options that the seller may make available to the buyer in case the buyer wants to return the original item.

This container consists of detailed information on an In-Store Pickup item refund.

Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers.

The amount of the refund due to, or already issued to the buyer for the order.

This field is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This dollar value is the amount of the refund to the buyer for this specific refund transaction.

This field is deprecated.

Note: This container was only used for Half.com orders, and since the Half.com site was taken down, this container is no longer applicable.

Note: This container is only applicable for Half.com order refunds, and since the Half.com site has been shut down, this field is no longer applicable.

Note: This type was only used for Half.com order refunds, and since the Half.com site has been shut down, this type is no longer applicable.

The number of reminders to the buyer on refund cancelled.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

Type defining the ReturnPolicyDetails.Refund container that is returned in GeteBayDetails.

This field is deprecated.

This enumerated type is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This type is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This field is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This type is deprecated.

Revise only

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

Type defining the Refunds container, which contains an array of Refund containers.

This field is deprecated.

This enumerated type is deprecated.

The number of reminders to the seller on refunds initiated

This field is deprecated.

This type is deprecated.

This enumerated type is deprecated.

The number of reminders to the buyer on refund on hold.

Indicates how the seller will compensate the buyer for a returned item.

This field indicates how the seller compensates buyers for returns.

This enumerated type contains the possible refund, exchange, or store credit options that a seller may offer a buyer when the buyer wants to return the item.

Note: This type was only used for Half.com order refunds, and since the Half.com site has been shut down, this type is no longer applicable.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

Revise only

This container consists of an array of one or more Refund containers, and each Refund container consists of detailed information about a merchant's refund (or store credit) to a buyer who has returned an In-Store Pickup item.

Enumerated type defining the refund types that a merchant can offer a buyer who is returning an In-Store Pickup item to the store.

This string value indicates the result of a seller's refund to the buyer.

This field is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item.

This enumerated type is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This date/time value is the timestamp for the refund transaction.

This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant.

This field is deprecated.

Note: RefundType and all of its fields are no longer applicable since the Half.com site has been shut down.

This type is deprecated.

Type defining the Refund container, which consists of detailed information on an In-Store Pickup item refund.

This type is deprecated.

This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item.

Note: This type is only used for Half.com order refunds, and since the Half.com site has been shut down, this type will also be deprecated.

The region code to which the location belongs.

If the infringement type stated in the VeROReasonCodeID has anything to do about which geographical region the item is shipped to, each region that would trigger this infringement type should be specified in its own Region field.

Lists the cities and other domestic regions for the specified site's country.

This type is no longer used; replaced by ShippingLocationDetails.

This field is deprecated.

String identifier for a continent, a geographic region, or a country.

Lists the worldwide regions and individual countries that can be set as shipping locations from the specified eBay site.

This type is no longer used; replaced by ShippingLocationDetails.

If true, the user is registered as a vehicle dealer on the eBay Motors site.

This container consists of the Registration address for the eBay user making the call.

Indicates the date the specified user originally registered with eBay.

The date and time that the requested contact registered with eBay.

Value for the date and time that a user's registration begins.

The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Regular vehicle subscription.

This field is deprecated.

Specifies the default site setting for whether LocalMarketRegularSubscription feature is supported for most categories.

Indicates category support for listing of Local Market items by sellers subscribed to Local Market for Regular Vehicles.

Indicates the Item Specific's logical dependency on another Item Specific, if any.

This container is returned for an item specific if eBay has data on how many searches have been performed for listings in the category using that item specific.

This type is used by the RelevanceIndicator container, which is returned for an item specific if eBay has data on how many eBay users have searched for an item in the category using that item specific.

This boolean field is returned as true if the item in this listing was relisted.

Indicates the new item ID for a re-listed item.

Enables a seller to relist a fixed-price listing that has recently ended on a specified eBay site.

The base response type for the RelistFixedPriceItem call.

The number of reminders advising the seller that relisting is needed.

Enables a seller to relist a listing that has recently ended on a specified eBay site.

The base response type for the RelistItem call.

Applicable only to relisting an item.

The identifier of the original listing that contained the item before the item was relisted.

Specifies how to return certain reminder types from the user's My eBay account.

This type contains the counts of various eBay Buying and Seller Reminders that are returned in the GetMyeBayReminders call.

This field should be included and set to true if the seller wants to clear all users from the Unpaid Item Assistant Exclusion list.

If this field is included and set to true, then all the items in the user's Watch List are removed.

The call enables a user to remove one or more items from their Watch List.

The base response type for the RemoveFromWatchList call.

Number of buyers who bought more than once from this seller.

Percentage of repeat buyers.

Set this value to true to delete or replace all existing parts compatibility information when you revise or relist an item.

Indicates if there has been a reply to the message.

Contains the data and status of a reported item.

This container of one or more reported items that match the input criteria in the call request.

A ReportItem container is required for each eBay item that the product owner is reporting as violating the product owner's copyright, trademark, or intellectual property rights.

Container (packet) for items being reported.

Authentication information for the user on whose behalf the application is making the request.

An eBay user ID that uniquely identifies the person who is making the call.

This field contains a possible action that a seller can take to expedite the release of a payment hold.

Container consisting of one or more RequiredSellerAction fields.

This type defines the RequiredSellerActionArray container, which may contain one or more RequiredSellerAction fields.

Enumerated type that defines the list of possible actions that a seller can take to expedite the release of funds for an order into their account.

Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout.

This field is included and set to true if the seller wishes to require the buyer to provide a shipping phone number upon checkout.

This field is returned as true if the Reserve price on the original auction listing was lowered as part of a revision to the original auction listing.

Indicates whether the reserve price has been met for the listing.

The lowest price at which the seller is willing to sell an auction item.

If true, ReservePriceAllowed indicates that all categories on the site allow the seller to specify a reserve price for an item.

This field is returned as true if the Reserve price on the original auction listing was removed as part of a revision to the original auction listing.

This boolean field can be used in the SetMessagePreferences call to reset all custom Ask Seller a Question (ASQ) subjects to their default eBay values.

This field is deprecated.

The date and time the dispute was resolved, in GMT.

This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer.

The BestOffer.CallStatus value returned in this container will indicate whether or not the action specified in the call request (accept, decline, or counter offer) was successful.

This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer.

This is the base response type for the RespondToBestOffer call.

Enables a seller to reply to Feedback that has been left for a user, or to post a follow-up comment to a Feedback comment the user has left for someone else.

Base response for the RespondToFeedback.

An answer to the question.

This type is deprecated.

This field is deprecated.

Details relating to the response to a message.

Whether a message can be responded to.

This boolean value indicates whether or not eBay replaced the response to the Feedback comment with a message that the response to the Feedback comment was removed.

Textual comment that the user who is subject of feedback may leave in response or rebuttal to the Feedback comment.

Specifies whether the response is a reply or a follow-up to a Feedback comment left by the user identified in the TargetUserID field.

A URL that the recipient must visit to respond to a message.

This type is deprecated, as sellers are no longer allowed to set a restocking fee through a listings's return policy.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.

This type is deprecated, as sellers are no longer allowed to set a restocking fee through a listings's return policy.

This field is deprecated as of release 1061 and any values supplied in this field are ignored. eBay no longer allows sellers to charge a restocking fee when returning items.

This field must be included in an Add/Revise/Relist call and set to true if a German (Site ID 77), Austrian (Site ID 16), or Swiss (Site ID 193) seller wishes to restrict sales of their item to other users registered on eBay as business users.

The REST authentication token for the user.

Returns the total number of retries for the given notification.

Set to true to retrieve reason codes for all sites.

In a SetStorePreferences call, this field should be included in the request if the eBay store owner wants to inform shoppers when he/she will return from vacation.

This value indicates the total number of listings being shown on the current page of the results set.

Indicates the total number of orders returned.

Number of order line items retrieved in the current page of results just returned.

This value indicates the total number of (non-empty) order line items retrieved in the current page of results.

Describes the seller's return policy.

In some EU countries, sellers are legally required to describe the return policy they offer.

If present, this flag indicates the seller can choose to describe the return policy they offer (providing return-policy details is required in some EU countries).

In some EU countries, sellers are legally required to describe the return policy they offer.

Lists the supported values that may be used for return policies on the specified eBay site, such as the return period, supported restocking fees, and refund options.

Type defining the ReturnPolicyDetails container, which is returned in GeteBayDetails, and provides the seller with the Return Policy features (and applicable values) that are supported by the listing site.

For most sites: If true, listings in this category require a return policy.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the use of return policies in listings.

Specifies the default site setting for whether a return policy is required for most categories.

Defines the feature that specifies whether a return policy could be enabled on the site.

Indicates the Business Policies category group that may be used for Return Policy profiles.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites support the use of category groups in return business policies.

Specifies what categories the Return Policy profile is applicable to.

Type used to express the details of the return policy for an item.

The unique identifier of a return policy business policy.

The name of a return policy business policy.

This container consists of the enumeration values that can be passed into the ReturnPolicy.ReturnsAcceptedOption field when using an Add/Revise/Relist API call.

Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers.

This enum defines the different options that are available for specifying whether or not the seller accepts returns.

Type defining the ReturnPolicyDetails.ReturnsAccepted container that is returned in GeteBayDetails.

This required field indicates whether or not the seller accepts returns.

Whether the seller allows the buyer to return the item.

Specified whether returns are accepted.

This enum defines the different options that are available for specifying the available return durations.

If the seller attempts to use ProductListingDetails in an Add/Revise/Relist call to find an eBay catalog product match, and multiple matches are found, the call will actually fail.

This enum defines the different options that are available for specifying the available refund methods.

This enum defines the different options that are available for specifying the return shipment payee.

This field gives the status of a buyer's return request.

Enumerated type that defines the possible states of an eBay return request.

This container consists of the supported time periods within which the buyer can return the item, starting from the day they receive the item.

Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers.

Type defining the ReturnPolicyDetails.ReturnsWithin container that is returned in GeteBayDetails.

Specifies the amount of time the buyer has to return an item.

Value indicates the number of days that a buyer has to return an item from the day they receive the item.

This enumerated type contains the list of values that can be used by the seller in an Add/Revise/Relist call to set the number of days (after the purchase date) that a buyer has to return an item (if the return policy states that items can be returned) for a refund or an exchange.

This field is deprecated.

This type is deprecated.

Enables a seller to update the payment details, the shipping details, and the status of an order.

The response of a ReviseCheckoutStatus call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Enables a seller to revise a fixed-price listing on a specified eBay site.

The base response type for the ReviseFixedPriceItem call.

Enables a seller to change the price and/or quantity of one to four active, fixed-price listings.

The base response type for the ReviseInventoryStatus call.

Enables a seller to revise a listing on a specified eBay site.

The base response type for the ReviseItem call.

This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder.

This call can be used to add, remove, or rename a custom folder in My eBay Messages.

The response of a ReviseMyMessagesFolders call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder.

The response of a ReviseMyMessages call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

Indicates if the category allows the seller to revise the price of a fixed-price listing.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the price of a listing to be revised during the life of the listing.

Defines if price can be revised while a listing is in semi or fully restricted mode.

If the field is present, the corresponding feature applies to the category.

Indicates if the category allows the seller to revise the quantity of a multi-quantity, active listing.

This field is returned as an empty element (a boolean value is not returned) if one or more eBay API-enabled sites allow the quantity of a listing to be revised during the life of the listing.

Defines if quantity can be revised while a listing is in semi or fully restricted mode.

If the field is present, the corresponding feature applies to the category.

This container is returned if a listing has been revised in any way since it first became active.

Contains data indicating whether an item has been revised since the listing became active and, if so, which among a subset of properties have been changed by the revision.

Token revocation time, if the token has been revoked.

Revokes a token before it would otherwise expire.

The response of a RevokeToken call only includes the standard response fields for Trading API calls, such as the Ack field (to indicate the success or failure of the call), the timestamp, and an Errors container (if there were any errors and/or warnings).

User ID of the VeRO member reporting the items.

Indicates whether the recipient of the Feedback entry is the buyer or the seller for the corresponding order line item.

Indicates whether the eBay user is in the Buyer or Seller role for the corresponding Best Offer.

The unique identifier of an eBay Store category.

The number of reminders requesting the buyer to process request time extension submitted by the seller.

This enumeration value will only be returned if a hourly, daily, or periodic hard or soft call limit is exceeded by the application, or if call limits do not apply to the call.

This enumeration value will indicate whether the access rule is on or off, or if the application is currently being blocked due to exceeding a hard call limit.

The eBay Registered URL must be specified in this field.