POST/offer/{offerId}/publish
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.
This call is used to convert an unpublished offer into a published offer, or live eBay listing. The unique identifier of the offer (offerId) is passed in at the end of the call URI.
Important!Publish offer note: Fields may be optional or conditionally required when calling the create or update methods, but become required when publishing the offer to create active listings. For this method, see Offer fields for a list of fields required to publish an offer.
For those who prefer to publish multiple offers (up to 25 at a time) with one call, the bulkPublishOffer method can be used. In the case of a multiple-variation listing, the publishOfferByInventoryItemGroup call should be used instead, as this call will convert all unpublished offers associated with an inventory item group into a multiple-variation listing.
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.
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
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
listingId | string | The unique identifier of the newly created eBay listing. This field is returned if the single offer (if publishOffer call was used) or group of offers in an inventory item group (if publishOfferByInventoryItemGroup call was used) was successfully converted into an eBay listing. Occurrence: Conditional |
warnings | array of ErrorDetailV3 | This container will contain an array of errors and/or warnings if any occur when a publishOffer or publishOfferByInventoryItemGroup call is made. 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 |
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 | 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 |
25041 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). |
25042 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, free shipping must be provided. |
25043 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, returns must be accepted. |
25044 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, refund must be provided as Money Back. |
25045 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. |
25046 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, seller must pay the cost for return shipping. |
25047 | API_INVENTORY | REQUEST | Seller is not eligible to use Refurbished Item Condition |
25048 | API_INVENTORY | REQUEST | Seller is not eligible to use Refurbished Item Condition in this Category |
25049 | API_INVENTORY | REQUEST | Seller is not eligible to use Refurbished Item Condition for the selected Brand |
25050 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. |
25051 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle |
25052 | API_INVENTORY | REQUEST | When listing an item with Refurbished condition, at least {replaceable_value} images must be provided |
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. |
25086 | API_INVENTORY | REQUEST | The URL provided must be an eBay Picture Service URL. |
25088 | API_INVENTORY | REQUEST | The email address provided is formatted incorrectly. |
25089 | API_INVENTORY | REQUEST | No more than {replaceable_value} global compliance policies allowed. Excess policies ignored. |
25090 | API_INVENTORY | REQUEST | No more than {replaceable_value} compliance policies per region allowed. Excess policies ignored. |
25091 | API_INVENTORY | REQUEST | No more than a total of {replaceable_value} compliance policies allowed. Excess policies ignored. |
25092 | API_INVENTORY | REQUEST | No more than {replaceable_value} global takeback policy allowed. |
25093 | API_INVENTORY | REQUEST | No more than {replaceable_value} takeback policy per region allowed. Excess policies ignored. |
25094 | API_INVENTORY | REQUEST | No more than a total of {replaceable_value} takeback policies allowed. |
25095 | API_INVENTORY | REQUEST | Region invalid for regional custom policy. Regions allowed are {replaceable_value}. |
25104 | API_INVENTORY | REQUEST | Regulatory document ID(s) {replaceable_value} not found. Please use valid ID(s). |
25106 | API_INVENTORY | REQUEST | Regulatory document structure incorrect. Max allowed number of entries is {replaceable_value}. |
25107 | API_INVENTORY | REQUEST | Invalid document state for ID(s) {replaceable_value}. Documents must be in the SUBMITTED or ACCEPTED state. |
25108 | API_INVENTORY | REQUEST | Product Safety structure incorrect for {replaceable_value}. Max allowed number of entries is {replaceable_value}. |
25109 | API_INVENTORY | REQUEST | Product Safety information incomplete. Your listing must include product safety pictograms & statements. |
25110 | API_INVENTORY | REQUEST | Manufacturer address information is incomplete. When providing the address, please provide the street, city, postal code and country |
25111 | API_INVENTORY | REQUEST | Manufacturer information is incomplete. Please provide the company name. |
25112 | API_INVENTORY | REQUEST | Responsible Person structure incorrect for {replaceable_value}. Max allowed number of entries is {replaceable_value}. |
25113 | API_INVENTORY | REQUEST | Responsible Person address information is incomplete. When providing the address, please provide the street, city, postal code and country |
25114 | API_INVENTORY | REQUEST | Responsible Person information is incomplete. Please provide the company name. |
25115 | API_INVENTORY | REQUEST | Either the Manufacturer or at least one of the Responsible Persons must be located in the EU. |
25116 | API_INVENTORY | REQUEST | Please provide a minimum of {replaceable_value} and a maximum of {replaceable_value} types for a Responsible Person. |
25118 | API_INVENTORY | REQUEST | Seller must provide at least one form of contact info for Manufacturer - either phone, email or address. |
25119 | API_INVENTORY | REQUEST | Seller must provide at least one form of contact info for Responsible Person - either phone, email or address. |
25601 | API_INVENTORY | REQUEST | {fieldName} is an invalid attribute. |
25604 | API_INVENTORY | REQUEST | Input error. {additionalInfo} |
25713 | API_INVENTORY | REQUEST | This Offer is not available : {additionalInfo}. |
25752 | API_INVENTORY | REQUEST | listingStartDate provided is invalid. |
25760 | API_INVENTORY | REQUEST | shipToLocationAvailability quantity insufficient to create auction listings. |
25766 | API_INVENTORY | REQUEST | The takeBackPolicyId field must be a long value type. Please correct the error. |
25767 | API_INVENTORY | REQUEST | The productCompliancePolicyId field must be a long value type. Please correct the error. |
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 | REQUEST | Invalid listing format removed {additionalInfo} |
25402 | API_INVENTORY | REQUEST | 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: Publishing an Offer for an Inventory Item
This call will publish an offer on an eBay marketplace
Input
The offerId path parameter is required in order to specify the order that is being published. This call has no request payload.
POSThttps://api.ebay.com/sell/inventory/v1/offer/2*********1/publish
Output
Upon a successful publishing of an offer, the listingId value is returned in the call response. This listingId value is the eBay Item ID for successfully created listing.