PUT/offer/{offerId}
This call updates an existing offer. An existing offer may be in published state (active eBay listing), or in an unpublished state and yet to be published with the publishOffer call. The unique identifier (offerId) for the offer to update is passed in at the end of the call URI.
The updateOffer call does a complete replacement of the existing offer object, so all fields that make up the current offer object are required, regardless of whether their values changed.
Important!Publish offer note: Fields may be optional or conditionally required when calling this method, but become required when publishing the offer to create an active listing. For this method, see Offer fields for a list of fields required to publish an offer.
Other information that is required before an unpublished offer can be published or before a published offer can be revised include:
- Inventory location
- Offer price
- Available quantity
- eBay listing category
- Referenced listing policy profiles to set payment, return, and fulfillment values/settings
Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true
if omitted from both the updateOffer and the createOffer calls. If a value is specified in the updateOffer call, this value will be used.
Note: In addition to the authorization
header, which is required for all Inventory API calls, this call also requires the Content-Type
and Content-Language
headers. See the HTTP request headers for more information.
Note: Each listing can be revised up to 250 times in one calendar day. If this revision threshold is reached, the seller will be blocked from revising the item until the next calendar day.
For published offers, the listingDescription field is also required to update the offer/eBay listing. For unpublished offers, this field is not necessarily required unless it is already set for the unpublished offer.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
Header | Type | Description |
---|---|---|
Content-Language | string | This header sets the natural language that will be used in the field values of the request payload. For example, the value passed in this header should be en-US for English or de-DE for German.For more information on the Content-Language header, refer to HTTP request headers. Occurrence: Required |
Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
Input container/field | Type | Description |
---|---|---|
availableQuantity | integer | This integer value sets the quantity of the inventory item that will be available through the offer. Quantity must be set to Occurrence: Conditional |
categoryId | string | The unique identifier of the eBay category that the inventory item is/will be listed under. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. The seller passes in a query string like "iPhone 6", and category ID values for suggested categories are returned in the response. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
charity | Charity | This container is used if the seller wishes to update a published or unpublished offer with a charitable organization that will receive a percentage of sale proceeds for each sale generated by the eBay listing. This container consists of the charityId field to identify the charitable organization, and the donationPercentage field that indicates the percentage of the sales proceeds that will be donated to the charitable organization for each sale. Both fields in this container are conditionally required for charitable listings. Occurrence: Optional |
charity.charityId | string | The eBay-assigned unique identifier of the charitable organization that will receive a percentage of the sales proceeds. The charitable organization must be reqistered with the PayPal Giving Fund in order to receive sales proceeds through eBay listings. Occurrence: Conditional |
charity.donationPercentage | string | This field is the percentage of the purchase price that the charitable organization (identified in the charityId field) will receive for each sale that the listing generates. This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization. This numeric value can range from 10 to 100, and in any 5 (percent) increments in between this range (e.g. Occurrence: Conditional |
extendedProducerResponsibility | ExtendedProducerResponsibility | This container is used to provide the eco-participation fee for a product. Use the getExtendedProducerResponsibilityPolicies method of the Sell Metadata API to retrieve categories that support eco-participation fee for a specified marketplace. Occurrence: Optional |
extendedProducerResponsibility.ecoParticipationFee | Amount | This is the fee paid for new items to the eco-organization (for example, "eco-organisme" in France). It is a contribution to the financing of the elimination of the item responsibly. Occurrence: Optional |
extendedProducerResponsibility.ecoParticipationFee.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
extendedProducerResponsibility.ecoParticipationFee.value | string | A 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 |
extendedProducerResponsibility.producerProductId | string | Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings./epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. Occurrence: Optional |
extendedProducerResponsibility.productDocumentationId | string | Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings./epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. Occurrence: Optional |
extendedProducerResponsibility.productPackageId | string | Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings./epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. Occurrence: Optional |
extendedProducerResponsibility.shipmentPackageId | string | Note: THIS FIELD IS DEPRECATED AND NO LONGER SUPPORTED. For sellers selling on the eBay France Marketplace, Extended Producer Responsibility ID fields are no longer set at the listing level. Instead, sellers must provide these IDs for each applicable category in their My eBay accounts. The URL will be based on the seller's home/registration site, and will use this pattern: https://accountsettings./epr-fr. Sellers based in the US will use https://accountsettings.ebay.com/epr-fr, sellers based in France will use https://accountsettings.ebay.fr/epr-fr, and so on. Occurrence: Optional |
hideBuyerDetails | boolean | This field is included and set to Occurrence: Optional |
includeCatalogProductDetails | boolean | This field indicates whether or not eBay product catalog details are applied to a listing. A value of Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted. Occurrence: Optional |
listingDescription | string | The text in this field is (published offers), or will become (unpublished offers) the description of the eBay listing. This field is not immediately required for an unpublished offer, but will be required before publishing the offer. Note that if the listingDescription field was omitted in the createOffer call for the offer, the offer entity should have picked up the text provided in the product.description field of the inventory item record, or if the inventory item is part of a group, the offer entity should have picked up the text provided in the description field of the inventory item group record. Occurrence: Conditional |
listingDuration | ListingDurationEnum | This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
listingPolicies | ListingPolicies | This container sets listing policies that will be used to construct the listing. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature. This container is not initially required when creating an offer but will become required before the offer can be published. Busines policies (payment, return, fulfillment policies) will always be required before publishing an offer. Other policies, including the seller created compliance policies and seller created take-back policy, will be required as needed by the marketplace, category, or product. Important!Publish offer note: This container and a few of its child fields (as noted below) are required before an offer can be published to create an active listing. Occurrence: Conditional |
listingPolicies.bestOfferTerms | BestOffer | This container is used if the seller would like to support the Best Offer feature on their listing. To enable the Best Offer feature, the seller will have to set the bestOfferEnabled field to Occurrence: Optional |
listingPolicies.bestOfferTerms.autoAcceptPrice | Amount | This is the price at which Best Offers are automatically accepted. If a buyer submits a Best Offer that is equal to or above this value, the offer is automatically accepted on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to Occurrence: Optional |
listingPolicies.bestOfferTerms.autoAcceptPrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
listingPolicies.bestOfferTerms.autoAcceptPrice.value | string | A 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 |
listingPolicies.bestOfferTerms.autoDeclinePrice | Amount | This is the price at which Best Offers are automatically declined. If a buyer submits a Best Offer that is equal to or below this value, the offer is automatically declined on behalf of the seller. This field is only applicable if the bestOfferEnabled value is set to Occurrence: Optional |
listingPolicies.bestOfferTerms.autoDeclinePrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
listingPolicies.bestOfferTerms.autoDeclinePrice.value | string | A 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 |
listingPolicies.bestOfferTerms.bestOfferEnabled | boolean | This field indicates whether or not the Best Offer feature is enabled for the listing. A seller can enable the Best Offer feature for a listing as long as the category supports the Best Offer feature. Occurrence: Optional |
listingPolicies.eBayPlusIfEligible | boolean | This field is included in an offer and set to Occurrence: Optional |
listingPolicies.fulfillmentPolicyId | string | This unique identifier indicates the fulfillment business policy that will be used once an offer is published and converted to an eBay listing. This fulfillment business policy will set all fulfillment-related settings for the eBay listing. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
listingPolicies.paymentPolicyId | string | This unique identifier indicates the payment business policy that will be used once an offer is published and converted to an eBay listing. This payment business policy will set all payment-related settings for the eBay listing. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
listingPolicies.productCompliancePolicyIds | array of string | This field contains the array of unique identifiers indicating the seller-created global product compliance policies that will be used once an offer is published and converted to a listing. Occurrence: Optional |
listingPolicies.regionalProductCompliancePolicies | RegionalProductCompliancePolicies | A comma-delimited list of unique identifiers indicating the seller-created country-specific product compliance policies that that will be used once an offer is published and converted to a listing.
For example, if a seller offers products in the UK, Germany, and Italy, each of which requires custom product compliance information, up to 18 policies (i.e., 6 policies x 3 countries,) may be included with each offer.Note: Product compliance policies that apply to all countries to which a seller ships are specified using productCompliancePolicyIds. Occurrence: Optional |
listingPolicies.regionalProductCompliancePolicies.countryPolicies | array of CountryPolicy | The array of country-specific product compliance policies to be used by an offer when it is published and converted to a listing. Occurrence: Conditional |
listingPolicies.regionalProductCompliancePolicies.countryPolicies.country | CountryCodeEnum | The two-letter ISO 3166-1 country code identifying the country to which the policy or policies specified in the corresponding policyIds array will apply. Occurrence: Conditional |
listingPolicies.regionalProductCompliancePolicies.countryPolicies.policyIds | array of string | An array of custom policy identifiers that apply to the country specified by listingPolicies.regionalTakeBackPolicies.countryPolicies.country.
Occurrence: Conditional |
listingPolicies.regionalTakeBackPolicies | RegionalTakeBackPolicies | The list of unique identifiers indicating the seller-created country-specific take-back policies that will be used once an offer is published and converted to a listing. The law in some countries may require sellers to take back a used product when the buyer buys a new product.
Note: Take-back policies that apply to all countries to which a seller ships are specified using takeBackPolicyId. Occurrence: Optional |
listingPolicies.regionalTakeBackPolicies.countryPolicies | array of CountryPolicy | The array of country-specific take-back policies to be used by an offer when it is published and converted to a listing. Occurrence: Conditional |
listingPolicies.regionalTakeBackPolicies.countryPolicies.country | CountryCodeEnum | The two-letter ISO 3166-1 country code identifying the country to which the policy or policies specified in the corresponding policyIds array will apply. Occurrence: Conditional |
listingPolicies.regionalTakeBackPolicies.countryPolicies.policyIds | array of string | An array of custom policy identifiers that apply to the country specified by listingPolicies.regionalTakeBackPolicies.countryPolicies.country.
Occurrence: Conditional |
listingPolicies.returnPolicyId | string | This unique identifier indicates the return business policy that will be used once an offer is published and converted to an eBay listing. This return business policy will set all return policy settings for the eBay listing. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
listingPolicies.shippingCostOverrides | array of ShippingCostOverride | This container is used if the seller wishes to override the shipping costs or surcharge for one or more domestic or international shipping service options defined in the fulfillment listing policy. To override the costs of a specific domestic or international shipping service option, the seller must know the priority/order of that shipping service in the fulfillment listing policy. The name of a shipping service option can be found in the shippingOptions.shippingServices.shippingServiceCode field of the fulfillment policy, and the priority/order of that shipping service option is found in the shippingOptions.shippingServices.sortOrderId field. Both of these values can be retrieved by searching for that fulfillment policy with the getFulfillmentPolicies or getFulfillmentPolicyByName calls of the Account API. The shippingCostOverrides.priority value should match the shippingOptions.shippingServices.sortOrderId in order to override the shipping costs for that shipping service option. The seller must also ensure that the shippingServiceType value is set to Occurrence: Optional |
listingPolicies.shippingCostOverrides.additionalShippingCost | Amount | The dollar value passed into this field will override the additional shipping cost that is currently set for the applicable shipping service option. The "Additional shipping cost" is the cost to ship each additional identical product to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.additionalShippingCost.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.additionalShippingCost.value | string | A 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 |
listingPolicies.shippingCostOverrides.priority | integer | The integer value input into this field, along with the shippingServiceType value, sets which domestic or international shipping service option in the fulfillment policy will be modified with updated shipping costs. Specifically, the shippingCostOverrides.shippingServiceType value in a createOffer or updateOffer call must match the shippingOptions.optionType value in a fulfillment listing policy, and the shippingCostOverrides.priority value in a createOffer or updateOffer call must match the shippingOptions.shippingServices.sortOrderId value in a fulfillment listing policy. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.shippingCost | Amount | The dollar value passed into this field will override the shipping cost that is currently set for the applicable shipping service option. This value will be the cost to ship one item to the buyer using the corresponding shipping service. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.shippingCost.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.shippingCost.value | string | A 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 |
listingPolicies.shippingCostOverrides.shippingServiceType | ShippingServiceTypeEnum | This enumerated value indicates whether the shipping service specified in the priority field is a domestic or an international shipping service option. To override the shipping costs for a specific domestic shipping service in the fulfillment listing policy, this field should be set to Occurrence: Conditional |
listingPolicies.shippingCostOverrides.surcharge | Amount | Note: DO NOT USE THIS FIELD. Shipping surcharges for shipping service options can no longer be set with fulfillment business policies. To set a shipping surcharge for a shipping service option, only the Shipping rate tables tool in My eBay can be used. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.surcharge.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
listingPolicies.shippingCostOverrides.surcharge.value | string | A 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 |
listingPolicies.takeBackPolicyId | string | This unique identifier indicates the seller-created global take-back policy that will be used once an offer is published and converted to a listing. Occurrence: Optional |
listingStartDate | string | This field can be used with an unpublished offer if the seller wants to specify a time in the future that the listing will become active on eBay. The timestamp supplied in this field should be in UTC format, and it should be far enough in the future so that the seller will have enough time to publish the listing with the publishOffer method. Occurrence: Optional |
lotSize | integer | This field is only applicable if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same item, such as four identical tires being sold as a single offer, or it can be a mixed lot of similar items, such as used clothing items or an assortment of baseball cards. Whether the lot listing involved identical items or a mixed lot, the integer value passed into this field is the total number of items in the lot. Lots can be used for auction and fixed-price listings. Occurrence: Conditional |
merchantLocationKey | string | The unique identifier of a merchant's inventory location (where the inventory item in the offer is located). Occurrence: Conditional |
pricingSummary | PricingSummary | This container shows the listing price for the product offer, and if applicable, the settings for the Minimum Advertised Price and Strikethrough Pricing features. The Minimum Advertised Price feature is only available on the US site. Strikethrough Pricing is available on the US, eBay Motors, UK, Germany, Canada (English and French), France, Italy, and Spain sites. Important!Publish offer note: This container and its child container, price, are required before an offer can be published to create an active listing. Occurrence: Conditional |
pricingSummary.auctionReservePrice | Amount | This field indicates the lowest price at which the seller is willing to sell an item through an auction listing. Note that setting a Reserve Price will incur a listing fee of $5 or 7.5% of the Reserve Price, whichever is greater. The minimum fee is $5. Occurrence: Optional |
pricingSummary.auctionReservePrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
pricingSummary.auctionReservePrice.value | string | A 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 |
pricingSummary.auctionStartPrice | Amount | This field indicates the minimum bidding price for the auction. The bidding starts at this price. Occurrence: Optional |
pricingSummary.auctionStartPrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
pricingSummary.auctionStartPrice.value | string | A 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 |
pricingSummary.minimumAdvertisedPrice | Amount | This container is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can only offer prices below this price through the use of other discounts. The MAP feature is only available to eligible US sellers. This field will be ignored if the seller and or the listing is not eligible for the MAP feature. Occurrence: Conditional |
pricingSummary.minimumAdvertisedPrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
pricingSummary.minimumAdvertisedPrice.value | string | A 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 |
pricingSummary.originallySoldForRetailPriceOn | SoldOnEnum | This field is needed if the Strikethrough Pricing (STP) feature will be used in the offer. This field indicates that the product was sold for the price in the originalRetailPrice field on an eBay site, or sold for that price by a third-party retailer. When using the createOffer or updateOffer calls, the seller will pass in a value of Occurrence: Conditional |
pricingSummary.originalRetailPrice | Amount | This container is needed if the Strikethrough Pricing (STP) feature will be used in the offer. The dollar value passed into this field indicates the original retail price set by the manufacturer (OEM). eBay does not maintain or validate the value supplied here by the seller. The dollar value in this field should always be more than the dollar value in the price container. This field and the originallySoldForRetailPriceOn field are only applicable if the seller and listing are eligible to use the Strikethrough Pricing feature, a feature which is limited to the US (core site and Motors), UK, Germany, Canada (English and French versions), France, Italy, and Spain sites. Compare the originalRetailPrice and the dollar value in the price field to determine the amount of savings to the buyer. This Original Retail Price will have a strikethrough line through for a marketing affect. Occurrence: Conditional |
pricingSummary.originalRetailPrice.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
pricingSummary.originalRetailPrice.value | string | A 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 |
pricingSummary.price | Amount | This is the listing price of the product. A listing price must be specified before publishing an offer, but it is possible to create an offer without a price. Important!Publish offer note: This container and its two child fields (currency and value) are required before an offer can be published to create an active listing. Occurrence: Conditional |
pricingSummary.price.currency | string | A three-digit string value representing the type of currency being used. Both the value and currency fields are required/always returned when expressing prices. Occurrence: Conditional |
pricingSummary.price.value | string | A 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 |
pricingSummary.pricingVisibility | MinimumAdvertisedPriceHandlingEnum | This field is needed if the Minimum Advertised Price (MAP) feature will be used in the offer. This field is only applicable if an eligible US seller is using the Minimum Advertised Price (MAP) feature and a minimumAdvertisedPrice has been specified. The value set in this field will determine whether the MAP price is shown to a prospective buyer prior to checkout through a pop-up window accessed from the View Item page, or if the MAP price is not shown until the checkout flow after the buyer has already committed to buying the item. To show the MAP price prior to checkout, the seller will set this value to Occurrence: Conditional |
quantityLimitPerBuyer | integer | This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceeding the quantity specified for this field. So, if this field's value is Occurrence: Conditional |
regulatory | Regulatory | This container is used by the seller to provide regulatory information. Occurrence: Optional |
regulatory.documents | array of Document | This container provides a collection of regulatory documents associated with the listing. Occurrence: Optional |
regulatory.documents.documentId | string | The unique identifier of a regulatory document associated with the listing. Occurrence: Conditional |
regulatory.economicOperator | EconomicOperator | Important! Economic Operator is being decommissioned and being replaced by the manufacturer and responsiblePersons containers. Economic Operator related fields should no longer be used for the create or update methods. As it is currently still supported, Economic Operator-related fields will be returned if applicable for the getOffer method. Economic Operator and its related fields will be decommissioned on October 21, 2024. This container provides Economic Operator (EO) information about the manufacturer and/or supplier of the item. The EO is a corporate entity that is related to, has some responsibility for, the product being listed for sale. For additional information, see What is an economic operator? Occurrence: Optional |
regulatory.economicOperator.addressLine1 | string | The first line of the registered Economic Operator's street address. Occurrence: Conditional |
regulatory.economicOperator.addressLine2 | string | The second line, if any, of the registered Economic Operator's street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'. Occurrence: Optional |
regulatory.economicOperator.city | string | The city of the registered Economic Operator's street address. Occurrence: Conditional |
regulatory.economicOperator.companyName | string | The company name of the registered Economic Operator. Occurrence: Conditional |
regulatory.economicOperator.country | CountryCodeEnum | The two-letter ISO 3166-1 standard abbreviation of the country of the registered Economic Operator's address. Occurrence: Conditional |
regulatory.economicOperator.email | string | The registered Economic Operator's business email address. Occurrence: Optional |
regulatory.economicOperator.phone | string | The registered Economic Operator's business phone number. Occurrence: Optional |
regulatory.economicOperator.postalCode | string | The postal code of the registered Economic Operator's street address. Occurrence: Conditional |
regulatory.economicOperator.stateOrProvince | string | The state or province of the registered Economic Operator's street address. Occurrence: Conditional |
regulatory.energyEfficiencyLabel | EnergyEfficiencyLabel | This container provides information about the energy efficiency for certain durable goods. Occurrence: Optional |
regulatory.energyEfficiencyLabel.imageDescription | string | A brief verbal summary of the information included on the Energy Efficiency Label for an item. Occurrence: Conditional |
regulatory.energyEfficiencyLabel.imageURL | string | The URL to the Energy Efficiency Label image that is applicable to an item. Occurrence: Conditional |
regulatory.energyEfficiencyLabel.productInformationSheet | string | The URL to the Product Information Sheet that provides complete manufacturer-provided efficiency information about an item. Occurrence: Conditional |
regulatory.hazmat | Hazmat | This container is used by the seller to provide hazardous material information for the listing.
Note: Hazmat information is not required for all categories. Use the getRegulatoryPolicies method of the Metadata API to return metadata on the eBay categories that recommend or require Hazmat-related fields. Occurrence: Optional |
regulatory.hazmat.component | string | This field is used by the seller to provide component information for the listing. For example, component information can provide the specific material of Hazmat concern. Occurrence: Optional |
regulatory.hazmat.pictograms | array of string | An array of comma-separated string values listing applicable pictogram code(s) for Hazard Pictogram(s). Occurrence: Conditional |
regulatory.hazmat.signalWord | string | This field sets the signal word for hazardous materials in the listing. Occurrence: Conditional |
regulatory.hazmat.statements | array of string | An array of comma-separated string values specifying applicable statement code(s) for hazard statement(s) for the listing. Occurrence: Conditional |
regulatory.manufacturer | Manufacturer | This container provides information about the manufacturer of the item. Occurrence: Optional |
regulatory.manufacturer.addressLine1 | string | The first line of the product manufacturer's street address. Occurrence: Conditional |
regulatory.manufacturer.addressLine2 | string | The second line of the product manufacturer's street address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Occurrence: Optional |
regulatory.manufacturer.city | string | The city of the product manufacturer's street address. Occurrence: Conditional |
regulatory.manufacturer.companyName | string | The company name of the the product manufacturer. Occurrence: Conditional |
regulatory.manufacturer.country | CountryCodeEnum | This defines the list of valid country codes, adapted from http://www.iso.org/iso/country_codes, ISO 3166-1 country code. List elements take the following form to identify a two-letter code with a short name in English, a three-digit code, and a three-letter code: For example, the entry for Japan includes Japan, 392, JPN. Short codes provide uniform recognition, avoiding language-dependent country names. The number code is helpful where Latin script may be problematic. Not all listed codes are universally recognized as countries, for example: code AQ is Antarctica, 010, ATA Occurrence: Conditional |
regulatory.manufacturer.email | string | The product manufacturer's business email address. Occurrence: Conditional |
regulatory.manufacturer.phone | string | The product manufacturer's business phone number. Occurrence: Conditional |
regulatory.manufacturer.postalCode | string | The postal code of the product manufacturer's street address. Occurrence: Conditional |
regulatory.manufacturer.stateOrProvince | string | The state or province of the product manufacturer's street address. Occurrence: Conditional |
regulatory.productSafety | ProductSafety | This container is used to provide product safety information for the listing. Two elements are required to complete the Product Safety section for a listing: pictograms and statements. The component element is optional. Occurrence: Optional |
regulatory.productSafety.component | string | This field is used by the seller to provide product safety component information for the listing. For example, component information can include specific warnings related to product safety, such as 'Tipping hazard'. Occurrence: Optional |
regulatory.productSafety.pictograms | array of string | An array of comma-separated string values used to provide product safety pictogram(s) for the listing. Occurrence: Conditional |
regulatory.productSafety.statements | array of string | An array of comma-separated string values used to provide product safety statement(s) for the listing. Occurrence: Conditional |
regulatory.repairScore | number | This field represents the repair index for the listing.
Note: Repair score is not applicable to all categories. Use the getExtendedProducerResponsibilityPolicies method of the Metadata API to see where repair score is applicable. Occurrence: Optional |
regulatory.responsiblePersons | array of ResponsiblePerson | This container provides information about the EU-based Responsible Persons or entities associated with the listing. Occurrence: Optional |
regulatory.responsiblePersons.addressLine1 | string | The first line of the Responsible Person's street address. Occurrence: Conditional |
regulatory.responsiblePersons.addressLine2 | string | The second line of the Responsible Person's address. This field is not always used, but can be used for secondary address information such as 'Suite Number' or 'Apt Number'. Occurrence: Optional |
regulatory.responsiblePersons.city | string | The city of the Responsible Person's street address. Occurrence: Conditional |
regulatory.responsiblePersons.companyName | string | The name of the the Responsible Person or entity. Occurrence: Conditional |
regulatory.responsiblePersons.country | CountryCodeEnum | This defines the list of valid country codes, adapted from http://www.iso.org/iso/country_codes, ISO 3166-1 country code. List elements take the following form to identify a two-letter code with a short name in English, a three-digit code, and a three-letter code: For example, the entry for Japan includes Japan, 392, JPN. Short codes provide uniform recognition, avoiding language-dependent country names. The number code is helpful where Latin script may be problematic. Not all listed codes are universally recognized as countries, for example: code AQ is Antarctica, 010, ATA Occurrence: Conditional |
regulatory.responsiblePersons.email | string | The Responsible Person's email address. Occurrence: Conditional |
regulatory.responsiblePersons.phone | string | The Responsible Person's business phone number. Occurrence: Conditional |
regulatory.responsiblePersons.postalCode | string | The postal code of the Responsible Person's street address. Occurrence: Conditional |
regulatory.responsiblePersons.stateOrProvince | string | The state of province of the Responsible Person's street address. Occurrence: Conditional |
regulatory.responsiblePersons.types | array of ResponsiblePersonTypeEnum | The type(s) associated with the Responsible Person or entity. Occurrence: Conditional |
secondaryCategoryId | string | The unique identifier for a secondary category. This field is applicable if the seller decides to list the item under two categories. Sellers can use the getCategorySuggestions method of the Taxonomy API to retrieve suggested category ID values. A fee may be charged when adding a secondary category to a listing. Occurrence: Optional |
storeCategoryNames | array of string | This container is used if the seller would like to place the inventory item into one or two store categories that the seller has set up for their eBay store. The string value(s) passed in to this container will be the full path(s) to the store categories, as shown below: If this field currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if the eBay categories are not changing. Occurrence: Conditional |
tax | Tax | This container is only applicable and used if a sales tax table, a Value-Added Tax (VAT) rate, or a tax exception category code will be applied to the offer. Only Business Sellers can apply VAT to their listings. It is possible that the applyTax field will be included with a value of Occurrence: Conditional |
tax.applyTax | boolean | When set to Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.
For complete information about using sales-tax tables, refer to Establishing sales-tax tables. Note that a seller can enable the use of a sales-tax table, but if a sales-tax rate is not specified for the buyer's tax jurisdiction, sales tax will not be applied to the order. When a thirdPartyTaxCategory value is used, applyTax must also be set to true .This field will be returned by getOffer and getOffers if set for the offer. For additional information, refer to Taxes and import charges. Occurrence: Conditional |
tax.thirdPartyTaxCategory | string | The tax exception category code. If this field is used, sales tax will also apply to a service/fee, and not just the item price. This is to be used only by sellers who have opted into sales tax being calculated by a sales tax calculation vendor. If you are interested in becoming a tax calculation vendor partner with eBay, contact developer-relations@ebay.com. One supported value for this field is Occurrence: Optional |
tax.vatPercentage | number | This value is the Value Add Tax (VAT) rate for the item, if any. When a VAT percentage is specified, the item's VAT information appears on the listing's View Item page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. Occurrence: Optional |
Output
HTTP response headers
See HTTP response headers for details.
Header | Meaning |
---|---|
Content-Language | This response header sets the natural language that will be provided in the field values of the response payload. |
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
offerId | string | The unique identifier of the offer that was just created with a createOffer call. It is not returned if the createOffer call fails to create an offer. This identifier will be needed for many offer-related calls. Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response. Occurrence: Conditional |
warnings | array of ErrorDetailV3 | This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur. Occurrence: Conditional |
warnings.category | string | This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. Occurrence: Conditional |
warnings.domain | string | The name of the domain in which the error or warning occurred. Occurrence: Conditional |
warnings.errorId | integer | A 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 |
warnings.inputRefIds | array of string | An 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 |
warnings.longMessage | string | A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. Occurrence: Conditional |
warnings.message | string | A description of the condition that caused the error or warning. Occurrence: Conditional |
warnings.outputRefIds | array of string | An 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 |
warnings.parameters | array of ErrorParameterV3 | Various 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 |
warnings.parameters.name | string | This type contains the name and value of an input parameter that contributed to a specific error or warning condition. Occurrence: Conditional |
warnings.parameters.value | string | This is the actual value that was passed in for the element specified in the name field. Occurrence: Conditional |
warnings.subdomain | string | The name of the subdomain in which the error or warning occurred. 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.
Status | Meaning |
---|---|
200 | Success |
204 | No Content |
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
25001 | API_INVENTORY | APPLICATION | A system error has occurred. {additionalInfo} |
25002 | API_INVENTORY | REQUEST | A user error has occurred. {additionalInfo} |
25003 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} |
25004 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} |
25005 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} |
25006 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} |
25007 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} |
25008 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} |
25009 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} |
25011 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} |
25012 | API_INVENTORY | REQUEST | Invalid inventory location. {additionalInfo} |
25013 | API_INVENTORY | REQUEST | Invalid data in the Inventory Item Group. {additionalInfo} |
25014 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} |
25015 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} |
25016 | API_INVENTORY | REQUEST | The {fieldName} value is invalid. {additionalInfo} |
25017 | API_INVENTORY | REQUEST | {fieldName} is missing. {additionalInfo} |
25018 | API_INVENTORY | REQUEST | Incomplete account information. {additionalInfo} |
25019 | API_INVENTORY | REQUEST | Cannot revise listing. {additionalInfo} |
25020 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} |
25021 | API_INVENTORY | REQUEST | The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} |
25022 | API_INVENTORY | REQUEST | Invalid attribute. {fieldName} |
25023 | API_INVENTORY | REQUEST | Invalid compatibility information. {additionalInfo} |
25025 | API_INVENTORY | APPLICATION | Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. |
25026 | API_INVENTORY | REQUEST | Selling limit exceeded. {additionalInfo} |
25029 | API_INVENTORY | REQUEST | {field} is required for this category. |
25031 | API_INVENTORY | REQUEST | {field} is not valid and needs to be a number between {min} and {max} |
25032 | API_INVENTORY | REQUEST | {field} is not valid |
25034 | API_INVENTORY | REQUEST | Only {max value} policies can be specified |
25035 | API_INVENTORY | REQUEST | The specified policy is not found for the market place |
25036 | API_INVENTORY | REQUEST | The policy(ies) {PolicyId} is not of type {PolicyEnum} |
25038 | API_INVENTORY | REQUEST | {ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours |
25039 | API_INVENTORY | REQUEST | {ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours |
25040 | API_INVENTORY | REQUEST | {ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours |
25076 | API_INVENTORY | REQUEST | {replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s). |
25077 | API_INVENTORY | REQUEST | Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored. |
25078 | API_INVENTORY | REQUEST | Hazmat structure incorrect for {replaceable_value}. |
25079 | API_INVENTORY | REQUEST | Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place. |
25080 | API_INVENTORY | REQUEST | The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters. |
25081 | API_INVENTORY | REQUEST | Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word. |
25083 | API_INVENTORY | REQUEST | Energy efficiency image is missing. Image is required with image description. |
25084 | API_INVENTORY | REQUEST | The listing must have both an energy efficiency label and a product information sheet. |
25085 | API_INVENTORY | REQUEST | Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, state, postal code and country. |
25086 | API_INVENTORY | REQUEST | The URL provided must be an eBay Picture Service URL. |
25087 | API_INVENTORY | REQUEST | Economic Operator information is incomplete. Please provide the company name. |
25088 | API_INVENTORY | REQUEST | The email address provided is formatted incorrectly. |
25601 | API_INVENTORY | REQUEST | Invalid attribute. {fieldName} |
25604 | API_INVENTORY | REQUEST | Input error. {additionalInfo} |
25710 | API_INVENTORY | REQUEST | We didn't find the resource/entity you are requesting. Please verify the request |
25713 | API_INVENTORY | REQUEST | This Offer is not available : {additionalInfo}. |
25752 | API_INVENTORY | REQUEST | listingStartDate provided is invalid. |
25756 | API_INVENTORY | REQUEST | Auction format is not permitted with a SKU that is part of an InventoryItemGroup. |
25757 | API_INVENTORY | REQUEST | auctionStartPrice is required for auction offer. |
25758 | API_INVENTORY | REQUEST | auctionStartPrice and auctionReservePrice are not supported for fixed price offer. |
25761 | API_INVENTORY | REQUEST | Discount pricing is not applicable for auction offer. |
25762 | API_INVENTORY | REQUEST | availableQuantity is not applicable for auction offer. |
25763 | API_INVENTORY | REQUEST | quantityLimitPerBuyer is not applicable for auction offer. |
25764 | API_INVENTORY | REQUEST | eBayPlusIfEligible is not applicable for auction offer. |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
25028 | API_INVENTORY | REQUEST | {field} is not applicable and has been dropped |
25030 | API_INVENTORY | REQUEST | {field} is not applicable for the condition and has been dropped |
25033 | API_INVENTORY | REQUEST | Duplicate policy IDs found |
25037 | API_INVENTORY | REQUEST | Item level Eco Participation Fee will be ignored |
25401 | API_INVENTORY | APPLICATION | Invalid listing options removed. {additionalInfo} |
25402 | API_INVENTORY | APPLICATION | System warning. {additionalInfo} |
25753 | API_INVENTORY | REQUEST | listingStartDate is in the past or the offer is live. Value is not updated on the listing. |
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Update an Existing Offer for an Inventory Item
This call will update an existing offer for an inventory item associated with the seller's acount.
Input
The offerId path parameter is required in order to specify the existing order that is being updated.
The existing offer will be updated with the values passed into the request payload. With the exception of the sku, marketplaceId, and format fields, all the fields used for the existing offer are also required for an updateOffer call, even when their values have not changed.
For this particular updateOffer call, the seller decreased the total quantity available to 60, reduced the price to $260.00, and increased the quantity of the item that a specific buyer can purchase to 3.
The fulfillment, payment, and return listing policies used remained the same.
POSThttps://api.ebay.com/sell/inventory/v1/offer/1*********1
Output
A successful call returns an http status code of 204 No Content and no payload.