Skip to main content

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.

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 (production)

POST https://api.ebay.com/sell/inventory/v1/offer/{offerId}/publish/

URI parameters

ParameterTypeDescription
offerIdstringThe unique identifier of the offer that is to be published.

Occurrence: Required

HTTP request headers

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

In addition, this method requires you to include the Content-Type header and its value should be set to "application/json". See HTTP request headers- opens rest request components page for details.

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/fieldTypeDescription
listingIdstring

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

warningsarray 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.categorystring

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

Occurrence: Conditional

warnings.domainstring

The name of the domain in which the error or warning occurred.

Occurrence: Conditional

warnings.errorIdinteger

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.inputRefIdsarray 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.longMessagestring

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.messagestring

A description of the condition that caused the error or warning.

Occurrence: Conditional

warnings.outputRefIdsarray 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.parametersarray 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.namestring

This type contains the name and value of an input parameter that contributed to a specific error or warning condition.

Occurrence: Conditional

warnings.parameters.valuestring

This is the actual value that was passed in for the element specified in the name field.

Occurrence: Conditional

warnings.subdomainstring

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.

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

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
25001API_INVENTORYAPPLICATIONA system error has occurred. {additionalInfo}
25002API_INVENTORYREQUESTA user error has occurred. {additionalInfo}
25003API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
25004API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
25005API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
25006API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
25007API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
25008API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
25009API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
25011API_INVENTORYREQUESTInvalid tax information. {additionalInfo}
25012API_INVENTORYREQUESTInvalid inventory location. {additionalInfo}
25013API_INVENTORYREQUESTInvalid data in the Inventory Item Group. {additionalInfo}
25014API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
25015API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
25016API_INVENTORYREQUESTThe {fieldName} value is invalid. {additionalInfo}
25017API_INVENTORYREQUEST{fieldName} is missing. {additionalInfo}
25018API_INVENTORYREQUESTIncomplete account information. {additionalInfo}
25019API_INVENTORYREQUESTCannot revise listing. {additionalInfo}
25020API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
25021API_INVENTORYREQUESTThe eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
25022API_INVENTORYREQUESTInvalid attribute. {fieldName}
25023API_INVENTORYREQUESTInvalid compatibility information. {additionalInfo}
25025API_INVENTORYAPPLICATIONConcurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
25026API_INVENTORYREQUESTSelling limit exceeded. {additionalInfo}
25029API_INVENTORYREQUEST{field} is required for this category.
25031API_INVENTORYREQUEST{field} is not valid and needs to be a number between {min} and {max}
25032API_INVENTORYREQUEST{field} is not valid
25034API_INVENTORYREQUESTOnly {max value} policies can be specified
25035API_INVENTORYREQUESTThe specified policy is not found for the market place
25036API_INVENTORYREQUESTThe policy(ies) {PolicyId} is not of type {PolicyEnum}
25038API_INVENTORYREQUEST{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours
25039API_INVENTORYREQUEST{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours
25040API_INVENTORYREQUEST{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours
25041API_INVENTORYREQUESTWhen listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s).
25042API_INVENTORYREQUESTWhen listing an item with Refurbished condition, free shipping must be provided.
25043API_INVENTORYREQUESTWhen listing an item with Refurbished condition, returns must be accepted.
25044API_INVENTORYREQUESTWhen listing an item with Refurbished condition, refund must be provided as Money Back.
25045API_INVENTORYREQUESTWhen listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days.
25046API_INVENTORYREQUESTWhen listing an item with Refurbished condition, seller must pay the cost for return shipping.
25047API_INVENTORYREQUESTSeller is not eligible to use Refurbished Item Condition
25048API_INVENTORYREQUESTSeller is not eligible to use Refurbished Item Condition in this Category
25049API_INVENTORYREQUESTSeller is not eligible to use Refurbished Item Condition for the selected Brand
25050API_INVENTORYREQUESTWhen listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title.
25051API_INVENTORYREQUESTWhen listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle
25052API_INVENTORYREQUESTWhen listing an item with Refurbished condition, at least {replaceable_value} images must be provided
25601API_INVENTORYREQUEST{fieldName} is an invalid attribute.
25604API_INVENTORYREQUESTInput error. {additionalInfo}
25713API_INVENTORYREQUESTThis Offer is not available : {additionalInfo}.
25752API_INVENTORYREQUESTlistingStartDate provided is invalid.
25760API_INVENTORYREQUESTshipToLocationAvailability quantity insufficient to create auction listings.

Warnings

For more on warnings, plus the codes of other common warnings, see Handling errors.

CodeDomainCategoryMeaning
25028API_INVENTORYREQUEST{field} is not applicable and has been dropped
25030API_INVENTORYREQUEST{field} is not applicable for the condition and has been dropped
25033API_INVENTORYREQUESTDuplicate policy IDs found
25037API_INVENTORYREQUESTItem level Eco Participation Fee will be ignored
25401API_INVENTORYREQUESTInvalid listing format removed {additionalInfo}
25402API_INVENTORYREQUESTSystem warning. {additionalInfo}
25753API_INVENTORYREQUESTlistingStartDate 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/publish/2*********1

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.