inventory APIv1.6.0

getListingFees

POST
/offer/get_listing_fees
This call is used to retrieve the expected listing fees for up to 250 unpublished offers. An array of one or more offerId values are passed in under the offers container.

In the response payload, all listing fees are grouped by eBay marketplace, and listing fees per offer are not shown. A fees container will be returned for each eBay marketplace where the seller is selling the products associated with the specified offers.

Errors will occur if the seller passes in offerIds that represent published offers, so this call should be made before the seller publishes offers with the publishOffer.

Input

Resource URI (production)

POST https://api.ebay.com/sell/inventory/v1/offer/get_listing_fees

URI parameters

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope/sell.inventory.readonly

https://api.ebay.com/oauth/api_scope/sell.inventory

See Oauth access tokens for more information.

{ /* OfferKeysWithId */
"offers" : []
}
Input container/fieldTypeDescription
offersarray of OfferKeyWithIdThis container is used to identify one or more (up to 250)unpublished offers for which expected listing fees will be retrieved. The user passes one or more offerId values (maximum of 250) in to this container to identify the unpublished offers in which to retrieve expected listing fees. This call is only applicable for offers in the unpublished state.

The call response gives aggregate fee amounts per eBay marketplace, and does not give fee information at the individual offer level.

Occurrence: Required

offers.offerIdstringThe unique identifier of an unpublished offer for which expected listing fees will be retrieved. One to 250 offerId values can be passed in to the offers container for one getListingFees call. Errors will occur if offerId values representing published offers are passed in.

Occurrence: Required

Output

HTTP response headers

Output container/fieldTypeDescription
feeSummariesarray of FeeSummaryThis container consists of an array of one or more listing fees that the seller can expect to pay for unpublished offers specified in the call request. Many fee types will get returned even when they are 0.0.

Occurrence: Always

feeSummaries.warningsarray of ErrorDetailV3This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur.

Occurrence: Conditional

feeSummaries.warnings.errorIdintegerA unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Conditional

feeSummaries.warnings.domainstringThe name of the domain in which the error or warning occurred.

Occurrence: Conditional

feeSummaries.warnings.subdomainstringThe name of the subdomain in which the error or warning occurred.

Occurrence: Conditional

feeSummaries.warnings.categorystringThis string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.

Occurrence: Conditional

feeSummaries.warnings.messagestringA description of the condition that caused the error or warning.

Occurrence: Conditional

feeSummaries.warnings.parametersarray of ErrorParameterV3Various warning and error messages return one or more variables that contain contextual information about the error or waring. This is often the field or value that triggered the error or warning.

Occurrence: Conditional

feeSummaries.warnings.parameters.valuestringThis is the actual value that was passed in for the element specified in the name field.

Occurrence: Conditional

feeSummaries.warnings.parameters.namestringThis is the name of input field that caused an issue with the call request.

Occurrence: Conditional

feeSummaries.warnings.longMessagestringA detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.

Occurrence: Conditional

feeSummaries.warnings.inputRefIdsarray of stringAn array of one or more reference IDs which identify the specific request element(s) most closely associated to the error or warning, if any.

Occurrence: Conditional

feeSummaries.warnings.outputRefIdsarray of stringAn array of one or more reference IDs which identify the specific response element(s) most closely associated to the error or warning, if any.

Occurrence: Conditional

feeSummaries.marketplaceIdMarketplaceEnumThis is the unique identifier of the eBay site for which listing fees for the offer are applicable.

Occurrence: Always

feeSummaries.feesarray of FeeThis container is an array of listing fees that can be expected to be applied to an offer on the specified eBay marketplace (marketplaceId value). Many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees.

Occurrence: Always

feeSummaries.fees.feeTypestringThe value returned in this field indicates the type of listing fee that the seller may incur if one or more unpublished offers (offers are specified in the call request) are published on the marketplace specified in the marketplaceId field. Applicable listing fees will often include things such as InsertionFee or SubtitleFee, but many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees.

Occurrence: Always

feeSummaries.fees.amountAmountThis dollar value in this container is the actual dollar value of the listing fee type specified in the feeType field.

Occurrence: Always

feeSummaries.fees.amount.valuestringA string representation of a dollar value expressed in the currency specified in the currency field. Both the value and currency fields are required/always returned when expressing prices.

Occurrence: Conditional

feeSummaries.fees.amount.currencystringA three-digit string value respresenting the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. See the CurrencyCodeEnum type for the full list of currencies and their corresponding three-digit string values.

Occurrence: Conditional

feeSummaries.fees.promotionalDiscountAmountThe dollar value in this container indicates any eBay promotional discount applied toward the listing fee type specified in the feeType field. If there was no discount applied toward the fee, this container is still returned but its value is 0.0.

Occurrence: Conditional

feeSummaries.fees.promotionalDiscount.valuestringA string representation of a dollar value expressed in the currency specified in the currency field. Both the value and currency fields are required/always returned when expressing prices.

Occurrence: Conditional

feeSummaries.fees.promotionalDiscount.currencystringA three-digit string value respresenting the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. See the CurrencyCodeEnum type for the full list of currencies and their corresponding three-digit string values.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
404Not Found
500Internal Server Error

Error codes

CodeDomainCategoryMeaning
25001API_INVENTORYAPPLICATIONA system error has occurred. {additionalInfo}
25709API_INVENTORYREQUESTInvalid value for {fieldName}. {additionalInfo}

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample 1: Retrieve Expected Listing Fees

This call retrieves expected listing fees per eBay marketplace for the unpublished offers that are specified in the request payload.

Input

Two offerId values are passed in under the offers container. The expected listing fees for these unpublished offers are returned in the response.
POST
https://api.ebay.com/sell/inventory/v1/offer/get_listing_fees

Output

As you can see from the output, one of the offers will be published to the eBay US site, and the other will be published to the eBay UK site. The seller can expect to have an insertion fee and a subtitle fee for both of these offers.