eBay Offer API
The Offer API from eBay — 9 operation(s) for offer.
eBay Offer API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Offer. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes 12 operations across 9 paths, and defines 38 schemas. It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
12 operations
9 paths
38 schemas
1 DELETE2 GET8 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
eBay Offer API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth— The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 12
Across 9 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Offer 12
POST
/bulk_create_offer
This call creates multiple offers (up to 25) for specific inventory items on a specific eBay marketplace. Although it is not a requirement for the seller to create complete offers (with all necessary…
POST
/bulk_publish_offer
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…
GET
/offer
This call retrieves all existing offers for the specified SKU value. The seller has the option of limiting the offers that are retrieved to a specific eBay marketplace, or to a listing format. Note:…
POST
/offer
This call creates an offer for a specific inventory item on a specific eBay marketplace. It is up to the sellers whether they want to create a complete offer (with all necessary details) right from t…
GET
/offer/{offerId}
This call retrieves a specific published or unpublished offer. The unique identifier of the offer ( offerId ) is passed in at the end of the call URI. The authorization header is the only required HT…
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 ident…
DELETE
/offer/{offerId}
If used against an unpublished offer, this call will permanently delete that offer. In the case of a published offer (or live eBay listing), a successful call will either end the single-variation lis…
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…
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…
POST
/offer/publish_by_inventory_item_group/
Note: Please note that any eBay listing created using the Inventory API cannot be revised or relisted using the Trading API calls. Note: Each listing can be revised up to 250 times in one calendar da…
POST
/offer/{offerId}/withdraw
This call is used to end a single-variation listing that is associated with the specified offer. This call is used in place of the deleteOffer call if the seller only wants to end the listing associa…
POST
/offer/withdraw_by_inventory_item_group
This call is used to end a multiple-variation eBay listing that is associated with the specified inventory item group. This call only ends multiple-variation eBay listing associated with the inventor…
Schemas 38
The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are EbayOfferDetailsWithAll (24 properties), EbayOfferDetailsWithKeys (21 properties), EbayOfferDetailsWithId (18 properties), ListingPolicies (10 properties). Each schema is shown below with its type and property counts.
Regulatory
object
Type defining regulatory information that the seller is required to disclose.
4 properties
EnergyEfficiencyLabel
object
This container provides information about the energy efficiency for certain durable goods.
3 properties
ListingPolicies
object
This type is used to identify business policies including payment, return, and fulfillment policies, as well as to identify custom policies. These policies are…
10 properties
CountryPolicy
object
This type specifies custom product compliance and/or take-back policies that apply to a specified country.
2 properties
OfferKeysWithId
object
This type is used by the base request payload of the getListingFees call.
1 property
RegionalTakeBackPolicies
object
This type lists regional take-back policies to be used by an offer when it is published and converted to a listing.
1 property
PricingSummary
object
This type is used to specify the listing price for the product and settings for the Minimum Advertised Price and Strikethrough Pricing features. The price fiel…
7 properties
EbayOfferDetailsWithAll
object
This type provides details of an offer, and is used by the response payloads of the getOffer and the getOffers calls.
24 properties
OfferSkuResponse
object
This type is used by the bulkCreateOffer response to show the status of each offer that the seller attempted to create with the bulkCreateOffer method. For eac…
7 properties
Charity
object
This type is used to identify the charitable organization associated with the listing, and the percentage of the sale proceeds that the charitable organization…
2 properties
Amount
object
This type is used to express a dollar value and the applicable currency.
2 properties
BulkOfferResponse
object
This type is used by the base response of the bulkCreateOffer method.
1 property
FeesSummaryResponse
object
This type is used by the base response payload for the getListingFees call.
1 property
RegionalProductCompliancePolicies
object
This type lists regional product compliance policies to be used by an offer when it is published and converted to a listing.
1 property
ShippingCostOverride
object
This type is used if the seller wants to override the shipping costs or surcharge associated with a specific domestic or international shipping service option…
5 properties
OfferKeyWithId
object
This type is used by the getListingFees call to indicate the unpublished offer(s) for which expected listing fees will be retrieved. The user passes in one or…
1 property
OfferResponseWithListingId
object
This type is used to indicate the status of each offer that the user attempted to publish. If an offer is successfully published, an eBay listing ID (also know…
5 properties
BulkEbayOfferDetailsWithKeys
object
This type is used by the base request of the bulkCreateOffer method, which is used to create up to 25 new offers.
1 property
BestOffer
object
This type is used by the bestOfferTerms container, which is used if the seller would like to support the Best Offer feature on their listing.
3 properties
Error
object
This type is used to express detailed information on errors and warnings that may occur with a call request.
9 properties
OfferResponse
object
This type is used by the response payload of the createOffer and updateOffer calls. The offerId field contains the unique identifier for the offer if the offer…
2 properties
ListingDetails
object
This type is used by the listing container in the getOffer and getOffers calls to provide the eBay listing ID, the listing status, and quantity sold for the of…
4 properties
Fee
object
This type is used to express expected listing fees that the seller may incur for one or more unpublished offers, as well as any eBay-related promotional discou…
3 properties
EbayOfferDetailsWithId
object
updateOffer call. Every field that is currently set with the unpublished/published offer must also be passed into the updateOffer call, even those fields whose…
18 properties
BulkOffer
object
This type is used by the base request of the bulkPublishOffer method, which is used to publish up to 25 different offers.
1 property
EbayOfferDetailsWithKeys
object
This type provides details of an offer, and is used by the base request payload of the createOffer and bulkCreateOffer methods.
21 properties
Hazmat
object
This container is used by the seller to provide hazardous material information for the listing. Three elements are required to complete the Hazmat section of a…
4 properties
FeeSummary
object
This type is used to display the expected listing fees for each unpublished offer specified in the request of the getListingFees call.
3 properties
WithdrawByInventoryItemGroupRequest
object
This type is used by the base request of the WithdrawByInventoryItemGroup method, which is used to end a multiple-variation listing.
2 properties
ErrorParameter
object
This type is used to indicate the parameter field/value that caused an issue with the call request.
2 properties
Tax
object
This type is used to enable the use of a sales-tax table, to pass in a tax exception category code, or to specify a VAT percentage. Note: Sales-tax tables are…
3 properties
BulkPublishResponse
object
This type is used by the base response of the bulkPublishOffer method.
1 property
Offers
object
This type is used by the base response of the getOffers call, and it is an array of one or more of the seller's offers, along with pagination data.
7 properties
ExtendedProducerResponsibility
object
This type provides IDs for the producer or importer related to the new item, packaging, added documentation, or an eco-participation fee. In some markets, such…
5 properties
EconomicOperator
object
Type that provides required Economic Operator information about the manufacturer and/or supplier of the item. The EO is a corporate entity that is related to,…
9 properties
WithdrawResponse
object
The base response of the withdrawOffer call.
2 properties
PublishByInventoryItemGroupRequest
object
This type is used by the request payload of the publishByInventoryItemGroup call. The identifier of the inventory item group to publish and the eBay marketplac…
2 properties
PublishResponse
object
This type is used by the base response payload of the publishOffer and publishOfferByInventoryItemGroup calls.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from eBay 12
Other APIs eBay publishes across the network.
eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
#Offer