openapi: 3.0.0 info: title: eBay Account Advertising_eligibility Offer API description: The Account API gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information.

For details on the availability of the methods in this API, see Account API requirements and restrictions. contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1.9.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /sell/account/v1 tags: - name: Offer paths: /bulk_create_offer: post: tags: - Offer description: '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 details) right from the start, eBay recommends that the seller provide all necessary details with this call since there is currently no bulk operation available to update multiple offers with one call. The following fields are always required in the request payload: sku, marketplaceId, and (listing) format.

Other information that will be required before a offer can be published are highlighted below:

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.
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.

If the call is successful, unique offerId values are returned in the response for each successfully created offer. The offerId value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run either the publishOffer, bulkPublishOffer, or publishOfferByInventoryItemGroup call to convert offer(s) into an active single- or multiple-variation listing.

For those who prefer to create a single offer per call, the createOffer method can be used instead.

' operationId: bulkCreateOffer parameters: - name: Content-Language in: header description: 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. required: true schema: type: string - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: Details of the offer for the channel content: application/json: schema: description: Details of the offer for the channel $ref: '#/components/schemas/BulkEbayOfferDetailsWithKeys' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BulkOfferResponse' '207': description: Multi-Status '400': description: Bad Request x-response-codes: errors: '25702': domain: API_INVENTORY category: REQUEST description: SKU {additionalInfo} is not available in the system '25709': domain: API_INVENTORY category: REQUEST description: Invalid request. Invalid value for field {additionalInfo} '25729': domain: API_INVENTORY category: REQUEST description: The combination of SKU, marketplaceId and format should be unique. '25730': domain: API_INVENTORY category: REQUEST description: The number of offers in the request cannot exceed {additionalInfo} '25735': domain: API_INVENTORY category: REQUEST description: Invalid SKU, marketplaceId or format. '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '25755': domain: API_INVENTORY category: REQUEST description: listingDuration is required for auction offer. '25756': domain: API_INVENTORY category: REQUEST description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. '25757': domain: API_INVENTORY category: REQUEST description: auctionStartPrice is required for auction offer. '25758': domain: API_INVENTORY category: REQUEST description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. '25761': domain: API_INVENTORY category: REQUEST description: Discount pricing is not applicable for auction offer. '25762': domain: API_INVENTORY category: REQUEST description: availableQuantity is not applicable for auction offer. '25763': domain: API_INVENTORY category: REQUEST description: quantityLimitPerBuyer is not applicable for auction offer. '25764': domain: API_INVENTORY category: REQUEST description: eBayPlusIfEligible is not applicable for auction offer. '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: Any System error. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /bulk_publish_offer: post: tags: - Offer description: 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 unpublished offers (up to 25) into published offers, or live eBay listings. The unique identifier (offerId) of each offer to publish is passed into the request payload. It is possible that some unpublished offers will be successfully created into eBay listings, but others may fail. The response payload will show the results for each offerId value that is passed into the request payload. The errors and warnings containers will be returned for an offer that had one or more issues being published.

For those who prefer to publish one offer per call, the publishOffer method can be used instead. 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. operationId: bulkPublishOffer parameters: - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: The base request of the bulkPublishOffer method. content: application/json: schema: description: The base request of the bulkPublishOffer method. $ref: '#/components/schemas/BulkOffer' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BulkPublishResponse' x-response-codes: errors: '25028': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable and has been dropped' '25030': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable for the condition and has been dropped' '25033': domain: API_INVENTORY category: REQUEST description: Duplicate policy IDs found '25037': domain: API_INVENTORY category: REQUEST description: Item level Eco Participation Fee will be ignored '25401': domain: API_INVENTORY category: APPLICATION description: Invalid listing options removed. {additionalInfo} '25402': domain: API_INVENTORY category: APPLICATION description: System warning. {additionalInfo} '25753': domain: API_INVENTORY category: REQUEST description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. '207': description: Multi-Status '400': description: Bad Request x-response-codes: errors: '25002': domain: API_INVENTORY category: REQUEST description: Any User error. {additionalInfo} '25003': domain: API_INVENTORY category: REQUEST description: Invalid price. {additionalInfo} '25004': domain: API_INVENTORY category: REQUEST description: Invalid quantity. {additionalInfo} '25005': domain: API_INVENTORY category: REQUEST description: Invalid category. {additionalInfo} '25006': domain: API_INVENTORY category: REQUEST description: Invalid listing option. {additionalInfo} '25007': domain: API_INVENTORY category: REQUEST description: Invalid Shipping policy information. {additionalInfo} '25008': domain: API_INVENTORY category: REQUEST description: Invalid Payment policy information. {additionalInfo} '25009': domain: API_INVENTORY category: REQUEST description: Invalid Return policy information. {additionalInfo} '25011': domain: API_INVENTORY category: REQUEST description: Invalid tax information. {additionalInfo} '25012': domain: API_INVENTORY category: REQUEST description: Invalid location. {additionalInfo} '25013': domain: API_INVENTORY category: REQUEST description: Invalid InventoryItemGroup information. {additionalInfo} '25014': domain: API_INVENTORY category: REQUEST description: Invalid pictures. {additionalInfo} '25015': domain: API_INVENTORY category: REQUEST description: Invalid picture URL. {additionalInfo} '25016': domain: API_INVENTORY category: REQUEST description: Invalid {fieldName}. {additionalInfo} '25017': domain: API_INVENTORY category: REQUEST description: Missing field {fieldName}. {additionalInfo} '25018': domain: API_INVENTORY category: REQUEST description: Incomplete account information. {additionalInfo} '25019': domain: API_INVENTORY category: REQUEST description: Cannot revise listing. {additionalInfo} '25020': domain: API_INVENTORY category: REQUEST description: Invalid package details. {additionalInfo} '25021': domain: API_INVENTORY category: REQUEST description: Invalid condition information. {additionalInfo} '25022': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25023': domain: API_INVENTORY category: REQUEST description: Invalid compatibility information. {additionalInfo} '25026': domain: API_INVENTORY category: REQUEST description: Selling limits exceeded. {additionalInfo} '25029': domain: API_INVENTORY category: REQUEST description: '{field} is required for this category.' '25031': domain: API_INVENTORY category: REQUEST description: '{field} is not valid and needs to be a number between {min} and {max}' '25032': domain: API_INVENTORY category: REQUEST description: '{field} is not valid' '25034': domain: API_INVENTORY category: REQUEST description: Only {max value} policies can be specified '25035': domain: API_INVENTORY category: REQUEST description: The specified policy is not found for the market place '25036': domain: API_INVENTORY category: REQUEST description: The policy(ies) {PolicyId} is not of type {PolicyEnum} '25038': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' '25039': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25040': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25041': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). '25042': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, free shipping must be provided. '25043': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, returns must be accepted. '25044': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, refund must be provided as Money Back. '25045': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. '25046': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. '25047': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition '25048': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition in this Category '25049': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition for the selected Brand '25050': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. '25051': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle '25052': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided '25076': domain: API_INVENTORY category: REQUEST description: '{replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s).' '25077': domain: API_INVENTORY category: REQUEST description: Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored. '25078': domain: API_INVENTORY category: REQUEST description: Hazmat structure incorrect for {replaceable_value}. '25079': domain: API_INVENTORY category: REQUEST description: Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place. '25080': domain: API_INVENTORY category: REQUEST description: The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters. '25081': domain: API_INVENTORY category: REQUEST description: Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word. '25083': domain: API_INVENTORY category: REQUEST description: Energy efficiency image is missing. Image is required with image description. '25084': domain: API_INVENTORY category: REQUEST description: The listing must have both an energy efficiency label and a product information sheet. '25085': domain: API_INVENTORY category: REQUEST description: Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, state, postal code and country. '25086': domain: API_INVENTORY category: REQUEST description: The URL provided must be an eBay Picture Service URL. '25087': domain: API_INVENTORY category: REQUEST description: Economic Operator information is incomplete. Please provide the company name. '25088': domain: API_INVENTORY category: REQUEST description: The email address provided is formatted incorrectly. '25601': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25604': domain: API_INVENTORY category: REQUEST description: Input error. {additionalInfo} '25709': domain: API_INVENTORY category: REQUEST description: Invalid offerId '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '25730': domain: API_INVENTORY category: REQUEST description: The number of offers in the request cannot exceed {additionalInfo}. '25731': domain: API_INVENTORY category: REQUEST description: OfferId should be unique in the request. '25732': domain: API_INVENTORY category: REQUEST description: Offers associated with SKUs that are part of a variation group cannot be published using this endpoint. '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '25760': domain: API_INVENTORY category: REQUEST description: shipToLocationAvailability quantity insufficient to create auction listings. '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: Any System error. {additionalInfo} '25025': domain: API_INVENTORY category: APPLICATION description: Concurrent access of Inventory or InventoryItemGroup. Please try again later security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer: get: tags: - Offer description: 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: At this time, the same SKU value can not be offered across multiple eBay marketplaces, so the marketplace_id query parameter currently does not have any practical use for this call.
Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers. Otherwise, only one offer will be returned.
The authorization header is the only required HTTP header for this call. See the HTTP request headers section for more information. operationId: getOffers parameters: - name: format in: query description: This enumeration value sets the listing format for the offers being retrieved. This query parameter will be passed in if the seller only wants to see offers in a specified listing format, such as FIXED_PRICE. required: false schema: type: string - name: limit in: query description: The value passed in this query parameter sets the maximum number of records to return per page of data. Although this field is a string, the value passed in this field should be a positive integer value. If this query parameter is not set, up to 100 records will be returned on each page of results. required: false schema: type: string - name: marketplace_id in: query description: The unique identifier of the eBay marketplace. This query parameter will be passed in if the seller only wants to see the product's offers on a specific eBay marketplace.

Note: At this time, the same SKU value can not be offered across multiple eBay marketplaces, so the marketplace_id query parameter currently does not have any practical use for this call. required: false schema: type: string - name: offset in: query description: The value passed in this query parameter sets the page number to retrieve. Although this field is a string, the value passed in this field should be a integer value equal to or greater than 0. The first page of records has a value of 0, the second page of records has a value of 1, and so on. If this query parameter is not set, its value defaults to 0, and the first page of records is returned. required: false schema: type: string - name: sku in: query description: 'The seller-defined SKU value is passed in as a query parameter. All offers associated with this product are returned in the response.

Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers. Otherwise, only one offer will be returned.
Use the getInventoryItems method to retrieve SKU values.

Max length: 50.' required: false schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Offers' '400': description: Bad Request x-response-codes: errors: '25706': domain: API_INVENTORY category: REQUEST description: You have provided invalid pagination values. {additionalInfo}. '25709': domain: API_INVENTORY category: REQUEST description: Invalid value for {fieldName}. {additionalInfo} '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly - https://api.ebay.com/oauth/api_scope/sell.inventory post: tags: - Offer description: '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 the start, or sellers can provide only some information with the initial createOffer call, and then make one or more subsequent updateOffer calls to complete the offer and prepare to publish the offer. Upon first creating an offer, the following fields are required in the request payload: sku, marketplaceId, and (listing) format.

Other information that will be required before an offer can be published are highlighted below. These settings are either set with createOffer, or they can be set with a subsequent updateOffer call:

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.

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.

If the call is successful, a unique offerId value is returned in the response. This value will be required for many other offer-related calls. Note that this call only stages an offer for publishing. The seller must run the publishOffer call to convert the offer to an active eBay listing.

For those who prefer to create multiple offers (up to 25 at a time) with one call, the bulkCreateOffer method can be used.

' operationId: createOffer parameters: - name: Content-Language in: header description: 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. required: true schema: type: string - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: Details of the offer for the channel content: application/json: schema: description: Details of the offer for the channel $ref: '#/components/schemas/EbayOfferDetailsWithKeys' required: true responses: '201': description: Created headers: Content-Language: schema: type: string description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: $ref: '#/components/schemas/OfferResponse' '400': description: Bad Request x-response-codes: errors: '25702': domain: API_INVENTORY category: REQUEST description: '{skuValue} could not be found or is not available in the system.' '25709': domain: API_INVENTORY category: REQUEST description: Invalid value for {fieldName}. {additionalInfo} '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '25755': domain: API_INVENTORY category: REQUEST description: listingDuration is required for auction offer. '25756': domain: API_INVENTORY category: REQUEST description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. '25757': domain: API_INVENTORY category: REQUEST description: auctionStartPrice is required for auction offer. '25758': domain: API_INVENTORY category: REQUEST description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. '25761': domain: API_INVENTORY category: REQUEST description: Discount pricing is not applicable for auction offer. '25762': domain: API_INVENTORY category: REQUEST description: availableQuantity is not applicable for auction offer. '25763': domain: API_INVENTORY category: REQUEST description: quantityLimitPerBuyer is not applicable for auction offer. '25764': domain: API_INVENTORY category: REQUEST description: eBayPlusIfEligible is not applicable for auction offer. '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}: get: tags: - Offer description: 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 HTTP header for this call. See the HTTP request headers section for more information.

operationId: getOffer parameters: - name: offerId in: path description: This path parameter specifies the unique identifier of the offer that is to be retrieved.

Use the getOffers method to retrieve offer IDs. required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/EbayOfferDetailsWithAll' '400': description: Bad Request x-response-codes: errors: '25709': domain: API_INVENTORY category: REQUEST description: Invalid value for {fieldName}. {additionalInfo} '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly - https://api.ebay.com/oauth/api_scope/sell.inventory put: tags: - Offer description: '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.

Other information that is required before an unpublished offer can be published or before a published offer can be revised include:

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.

' operationId: updateOffer parameters: - name: Content-Language in: header description: 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. required: true schema: type: string - name: offerId in: path description: This path parameter specifies the unique identifier of the offer being updated.

Use the getOffers method to retrieve offer IDs. required: true schema: type: string - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: Details of the offer for the channel content: application/json: schema: description: Details of the offer for the channel $ref: '#/components/schemas/EbayOfferDetailsWithId' required: true responses: '200': description: Success headers: Content-Language: schema: type: string description: This response header sets the natural language that will be provided in the field values of the response payload. content: application/json: schema: $ref: '#/components/schemas/OfferResponse' x-response-codes: errors: '25028': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable and has been dropped' '25030': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable for the condition and has been dropped' '25033': domain: API_INVENTORY category: REQUEST description: Duplicate policy IDs found '25037': domain: API_INVENTORY category: REQUEST description: Item level Eco Participation Fee will be ignored '25401': domain: API_INVENTORY category: APPLICATION description: Invalid listing options removed. {additionalInfo} '25402': domain: API_INVENTORY category: APPLICATION description: System warning. {additionalInfo} '25753': domain: API_INVENTORY category: REQUEST description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. '204': description: No Content '400': description: Bad Request x-response-codes: errors: '25002': domain: API_INVENTORY category: REQUEST description: A user error has occurred. {additionalInfo} '25003': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} '25004': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} '25005': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} '25006': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} '25007': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} '25008': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} '25009': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} '25011': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo} '25012': domain: API_INVENTORY category: REQUEST description: Invalid inventory location. {additionalInfo} '25013': domain: API_INVENTORY category: REQUEST description: Invalid data in the Inventory Item Group. {additionalInfo} '25014': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} '25015': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} '25016': domain: API_INVENTORY category: REQUEST description: The {fieldName} value is invalid. {additionalInfo} '25017': domain: API_INVENTORY category: REQUEST description: '{fieldName} is missing. {additionalInfo}' '25018': domain: API_INVENTORY category: REQUEST description: Incomplete account information. {additionalInfo} '25019': domain: API_INVENTORY category: REQUEST description: Cannot revise listing. {additionalInfo} '25020': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} '25021': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} '25022': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25023': domain: API_INVENTORY category: REQUEST description: Invalid compatibility information. {additionalInfo} '25026': domain: API_INVENTORY category: REQUEST description: Selling limit exceeded. {additionalInfo} '25029': domain: API_INVENTORY category: REQUEST description: '{field} is required for this category.' '25031': domain: API_INVENTORY category: REQUEST description: '{field} is not valid and needs to be a number between {min} and {max}' '25032': domain: API_INVENTORY category: REQUEST description: '{field} is not valid' '25034': domain: API_INVENTORY category: REQUEST description: Only {max value} policies can be specified '25035': domain: API_INVENTORY category: REQUEST description: The specified policy is not found for the market place '25036': domain: API_INVENTORY category: REQUEST description: The policy(ies) {PolicyId} is not of type {PolicyEnum} '25038': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' '25039': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25040': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25076': domain: API_INVENTORY category: REQUEST description: '{replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s).' '25077': domain: API_INVENTORY category: REQUEST description: Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored. '25078': domain: API_INVENTORY category: REQUEST description: Hazmat structure incorrect for {replaceable_value}. '25079': domain: API_INVENTORY category: REQUEST description: Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place. '25080': domain: API_INVENTORY category: REQUEST description: The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters. '25081': domain: API_INVENTORY category: REQUEST description: Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word. '25083': domain: API_INVENTORY category: REQUEST description: Energy efficiency image is missing. Image is required with image description. '25084': domain: API_INVENTORY category: REQUEST description: The listing must have both an energy efficiency label and a product information sheet. '25085': domain: API_INVENTORY category: REQUEST description: Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, state, postal code and country. '25086': domain: API_INVENTORY category: REQUEST description: The URL provided must be an eBay Picture Service URL. '25087': domain: API_INVENTORY category: REQUEST description: Economic Operator information is incomplete. Please provide the company name. '25088': domain: API_INVENTORY category: REQUEST description: The email address provided is formatted incorrectly. '25601': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25604': domain: API_INVENTORY category: REQUEST description: Input error. {additionalInfo} '25710': domain: API_INVENTORY category: REQUEST description: We didn't find the resource/entity you are requesting. Please verify the request '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '25756': domain: API_INVENTORY category: REQUEST description: Auction format is not permitted with a SKU that is part of an InventoryItemGroup. '25757': domain: API_INVENTORY category: REQUEST description: auctionStartPrice is required for auction offer. '25758': domain: API_INVENTORY category: REQUEST description: auctionStartPrice and auctionReservePrice are not supported for fixed price offer. '25761': domain: API_INVENTORY category: REQUEST description: Discount pricing is not applicable for auction offer. '25762': domain: API_INVENTORY category: REQUEST description: availableQuantity is not applicable for auction offer. '25763': domain: API_INVENTORY category: REQUEST description: quantityLimitPerBuyer is not applicable for auction offer. '25764': domain: API_INVENTORY category: REQUEST description: eBayPlusIfEligible is not applicable for auction offer. '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} '25025': domain: API_INVENTORY category: APPLICATION description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory delete: tags: - Offer description: 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 listing associated with the offer, or it will remove that product variation from the eBay listing and also automatically remove that product variation from the inventory item group. In the case of a multiple-variation listing, the deleteOffer will not remove the product variation from the listing if that variation has one or more sales. If that product variation has one or more sales, the seller can alternately just set the available quantity of that product variation to 0, so it is not available in the eBay search or View Item page, and then the seller can remove that product variation from the inventory item group at a later time. operationId: deleteOffer parameters: - name: offerId in: path description: This path parameter specifies the unique identifier of the offer being deleted.

Use the getOffers method to retrieve offer IDs. required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request x-response-codes: errors: '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/get_listing_fees: post: tags: - Offer description: This call is used to retrieve the expected listing fees for up to 250 unpublished offers. An array of one or more offerId values are passed in under the offers container.

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

Errors will occur if the seller passes in offerIds that represent published offers, so this call should be made before the seller publishes offers with the publishOffer. operationId: getListingFees parameters: - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: List of offers that needs fee information content: application/json: schema: description: List of offers that needs fee information $ref: '#/components/schemas/OfferKeysWithId' required: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FeesSummaryResponse' '400': description: Bad Request x-response-codes: errors: '25709': domain: API_INVENTORY category: REQUEST description: Invalid value for {fieldName}. {additionalInfo} '25754': domain: API_INVENTORY category: REQUEST description: One or more provided offerId(s) are invalid. All offerId(s) in the request should belong to an inventoryItem or inventoryItemGroup for a specific marketplaceId and format. '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory.readonly - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}/publish/: post: tags: - Offer description: 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. operationId: publishOffer parameters: - name: offerId in: path description: This path parameter specifies the unique identifier of the offer that is to be published.

Use the getOffers method to retrieve offer IDs. required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PublishResponse' x-response-codes: errors: '25028': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable and has been dropped' '25030': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable for the condition and has been dropped' '25033': domain: API_INVENTORY category: REQUEST description: Duplicate policy IDs found '25037': domain: API_INVENTORY category: REQUEST description: Item level Eco Participation Fee will be ignored '25401': domain: API_INVENTORY category: REQUEST description: Invalid listing format removed {additionalInfo} '25402': domain: API_INVENTORY category: REQUEST description: System warning. {additionalInfo} '25753': domain: API_INVENTORY category: REQUEST description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. '400': description: Bad Request x-response-codes: errors: '25002': domain: API_INVENTORY category: REQUEST description: A user error has occurred. {additionalInfo} '25003': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo} '25004': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo} '25005': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo} '25006': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo} '25007': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo} '25008': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo} '25009': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo} '25011': domain: API_INVENTORY category: REQUEST description: Invalid tax information. {additionalInfo} '25012': domain: API_INVENTORY category: REQUEST description: Invalid inventory location. {additionalInfo} '25013': domain: API_INVENTORY category: REQUEST description: Invalid data in the Inventory Item Group. {additionalInfo} '25014': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo} '25015': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo} '25016': domain: API_INVENTORY category: REQUEST description: The {fieldName} value is invalid. {additionalInfo} '25017': domain: API_INVENTORY category: REQUEST description: '{fieldName} is missing. {additionalInfo}' '25018': domain: API_INVENTORY category: REQUEST description: Incomplete account information. {additionalInfo} '25019': domain: API_INVENTORY category: REQUEST description: Cannot revise listing. {additionalInfo} '25020': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo} '25021': domain: API_INVENTORY category: REQUEST description: The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo} '25022': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25023': domain: API_INVENTORY category: REQUEST description: Invalid compatibility information. {additionalInfo} '25026': domain: API_INVENTORY category: REQUEST description: Selling limit exceeded. {additionalInfo} '25029': domain: API_INVENTORY category: REQUEST description: '{field} is required for this category.' '25031': domain: API_INVENTORY category: REQUEST description: '{field} is not valid and needs to be a number between {min} and {max}' '25032': domain: API_INVENTORY category: REQUEST description: '{field} is not valid' '25034': domain: API_INVENTORY category: REQUEST description: Only {max value} policies can be specified '25035': domain: API_INVENTORY category: REQUEST description: The specified policy is not found for the market place '25036': domain: API_INVENTORY category: REQUEST description: The policy(ies) {PolicyId} is not of type {PolicyEnum} '25038': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' '25039': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25040': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25041': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). '25042': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, free shipping must be provided. '25043': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, returns must be accepted. '25044': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, refund must be provided as Money Back. '25045': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. '25046': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. '25047': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition '25048': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition in this Category '25049': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition for the selected Brand '25050': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. '25051': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle '25052': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided '25076': domain: API_INVENTORY category: REQUEST description: '{replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s).' '25077': domain: API_INVENTORY category: REQUEST description: Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored. '25078': domain: API_INVENTORY category: REQUEST description: Hazmat structure incorrect for {replaceable_value}. '25079': domain: API_INVENTORY category: REQUEST description: Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place. '25080': domain: API_INVENTORY category: REQUEST description: The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters. '25081': domain: API_INVENTORY category: REQUEST description: Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word. '25083': domain: API_INVENTORY category: REQUEST description: Energy efficiency image is missing. Image is required with image description. '25084': domain: API_INVENTORY category: REQUEST description: The listing must have both an energy efficiency label and a product information sheet. '25085': domain: API_INVENTORY category: REQUEST description: Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, state, postal code and country. '25086': domain: API_INVENTORY category: REQUEST description: The URL provided must be an eBay Picture Service URL. '25087': domain: API_INVENTORY category: REQUEST description: Economic Operator information is incomplete. Please provide the company name. '25088': domain: API_INVENTORY category: REQUEST description: The email address provided is formatted incorrectly. '25601': domain: API_INVENTORY category: REQUEST description: '{fieldName} is an invalid attribute.' '25604': domain: API_INVENTORY category: REQUEST description: Input error. {additionalInfo} '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '25760': domain: API_INVENTORY category: REQUEST description: shipToLocationAvailability quantity insufficient to create auction listings. '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: A system error has occurred. {additionalInfo} '25025': domain: API_INVENTORY category: APPLICATION description: Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later. security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/publish_by_inventory_item_group/: post: tags: - Offer description: 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 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 all unpublished offers associated with an inventory item group into an active, multiple-variation listing.

The unique identifier of the inventory item group (inventoryItemGroupKey) is passed in the request payload. All inventory items and their corresponding offers in the inventory item group must be valid (meet all requirements) for the publishOfferByInventoryItemGroup call to be completely successful. For any inventory items in the group that are missing required data or have no corresponding offers, the publishOfferByInventoryItemGroup will create a new multiple-variation listing, but any inventory items with missing required data/offers will not be in the newly-created listing. If any inventory items in the group to be published have invalid data, or one or more of the inventory items have conflicting data with one another, the publishOfferByInventoryItemGroup call will fail. Be sure to check for any error or warning messages in the call response for any applicable information about one or more inventory items/offers having issues. operationId: publishOfferByInventoryItemGroup parameters: - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload. content: application/json: schema: description: The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload. $ref: '#/components/schemas/PublishByInventoryItemGroupRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PublishResponse' x-response-codes: errors: '25028': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable and has been dropped' '25030': domain: API_INVENTORY category: REQUEST description: '{field} is not applicable for the condition and has been dropped' '25033': domain: API_INVENTORY category: REQUEST description: Duplicate policy IDs found '25037': domain: API_INVENTORY category: REQUEST description: Item level Eco Participation Fee will be ignored '25401': domain: API_INVENTORY category: APPLICATION description: Invalid listing options removed. {additionalInfo} '25402': domain: API_INVENTORY category: APPLICATION description: System warning. {additionalInfo} '25753': domain: API_INVENTORY category: REQUEST description: listingStartDate is in the past or the offer is live. Value is not updated on the listing. '400': description: Bad Request x-response-codes: errors: '25002': domain: API_INVENTORY category: REQUEST description: Any User error. {additionalInfo} '25003': domain: API_INVENTORY category: REQUEST description: Invalid price. {additionalInfo} '25004': domain: API_INVENTORY category: REQUEST description: Invalid quantity. {additionalInfo} '25005': domain: API_INVENTORY category: REQUEST description: Invalid category. {additionalInfo} '25006': domain: API_INVENTORY category: REQUEST description: Invalid listing option. {additionalInfo} '25007': domain: API_INVENTORY category: REQUEST description: Invalid Shipping policy information. {additionalInfo} '25008': domain: API_INVENTORY category: REQUEST description: Invalid Payment policy information. {additionalInfo} '25009': domain: API_INVENTORY category: REQUEST description: Invalid Return policy information. {additionalInfo} '25011': domain: API_INVENTORY category: REQUEST description: Invalid tax information. {additionalInfo} '25012': domain: API_INVENTORY category: REQUEST description: Invalid location. {additionalInfo} '25013': domain: API_INVENTORY category: REQUEST description: Invalid InventoryItemGroup information. {additionalInfo} '25014': domain: API_INVENTORY category: REQUEST description: Invalid pictures. {additionalInfo} '25015': domain: API_INVENTORY category: REQUEST description: Invalid picture URL. {additionalInfo} '25016': domain: API_INVENTORY category: REQUEST description: Invalid {fieldName}. {additionalInfo} '25017': domain: API_INVENTORY category: REQUEST description: Missing field {fieldName}. {additionalInfo} '25018': domain: API_INVENTORY category: REQUEST description: Incomplete account information. {additionalInfo} '25019': domain: API_INVENTORY category: REQUEST description: Cannot revise listing. {additionalInfo} '25020': domain: API_INVENTORY category: REQUEST description: Invalid package details. {additionalInfo} '25021': domain: API_INVENTORY category: REQUEST description: Invalid condition information. {additionalInfo} '25022': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25023': domain: API_INVENTORY category: REQUEST description: Invalid compatibility information. {additionalInfo} '25026': domain: API_INVENTORY category: REQUEST description: Selling limits exceeded. {additionalInfo} '25029': domain: API_INVENTORY category: REQUEST description: '{field} is required for this category.' '25031': domain: API_INVENTORY category: REQUEST description: '{field} is not valid and needs to be a number between {min} and {max}' '25032': domain: API_INVENTORY category: REQUEST description: '{field} is not valid' '25034': domain: API_INVENTORY category: REQUEST description: Only {max value} policies can be specified '25035': domain: API_INVENTORY category: REQUEST description: The specified policy is not found for the market place '25036': domain: API_INVENTORY category: REQUEST description: The policy(ies) {PolicyId} is not of type {PolicyEnum} '25038': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer or is ending within 12 hours' '25039': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25040': domain: API_INVENTORY category: REQUEST description: '{ItemId} cannot be revised if the item has a bid or a best offer and is ending within 12 hours' '25041': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, maximum handling time must be {replaceable_value} business day(s). '25042': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, free shipping must be provided. '25043': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, returns must be accepted. '25044': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, refund must be provided as Money Back. '25045': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, the minimum time you'll accept returns must be {replaceable_value} days. '25046': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, seller must pay the cost for return shipping. '25047': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition '25048': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition in this Category '25049': domain: API_INVENTORY category: REQUEST description: Seller is not eligible to use Refurbished Item Condition for the selected Brand '25050': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Title. '25051': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, {replaceable_value} cannot be used in the Subtitle '25052': domain: API_INVENTORY category: REQUEST description: When listing an item with Refurbished condition, at least {replaceable_value} images must be provided '25076': domain: API_INVENTORY category: REQUEST description: '{replaceable_value} ID(s) {replaceable_value} not found. Please use valid ID(s).' '25077': domain: API_INVENTORY category: REQUEST description: Duplicate Regulatory ID(s) {replaceable_value} sent in the request. Duplicate ID(s) have been ignored. '25078': domain: API_INVENTORY category: REQUEST description: Hazmat structure incorrect for {replaceable_value}. '25079': domain: API_INVENTORY category: REQUEST description: Repair score invalid. Repair score must be in the range from {replaceable_value} to {replaceable_value} with one decimal place. '25080': domain: API_INVENTORY category: REQUEST description: The value of the {0} field is invalid. Field must not exceed {replaceable_value} characters. '25081': domain: API_INVENTORY category: REQUEST description: Hazardous material information incomplete. Your listing must include pictograms, hazardous statements and a signal word. '25083': domain: API_INVENTORY category: REQUEST description: Energy efficiency image is missing. Image is required with image description. '25084': domain: API_INVENTORY category: REQUEST description: The listing must have both an energy efficiency label and a product information sheet. '25085': domain: API_INVENTORY category: REQUEST description: Economic Operator address information is incomplete. When providing the address, please provide the company name, street, city, state, postal code and country. '25086': domain: API_INVENTORY category: REQUEST description: The URL provided must be an eBay Picture Service URL. '25087': domain: API_INVENTORY category: REQUEST description: Economic Operator information is incomplete. Please provide the company name. '25088': domain: API_INVENTORY category: REQUEST description: The email address provided is formatted incorrectly. '25601': domain: API_INVENTORY category: REQUEST description: Invalid attribute. {fieldName} '25604': domain: API_INVENTORY category: REQUEST description: Input error. {additionalInfo} '25705': domain: API_INVENTORY category: REQUEST description: The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. '25752': domain: API_INVENTORY category: REQUEST description: listingStartDate provided is invalid. '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: Any System error. {additionalInfo} '25025': domain: API_INVENTORY category: APPLICATION description: Concurrent access of Inventory or InventoryItemGroup. Please try again later security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/{offerId}/withdraw: post: tags: - Offer description: 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 associated with the offer but does not want to delete the offer object. With this call, the offer object remains, but it goes into the unpublished state, and will require a publishOffer call to relist the offer.

To end a multiple-variation listing that is associated with an inventory item group, the withdrawOfferByInventoryItemGroup method can be used. This call only ends the multiple-variation listing associated with an inventory item group but does not delete the inventory item group object, nor does it delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. operationId: withdrawOffer parameters: - name: offerId in: path description: This path parameter specifies the unique identifier of the offer that is to be withdrawn.

Use the getOffers method to retrieve offer IDs. required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WithdrawResponse' x-response-codes: errors: '25402': domain: API_INVENTORY category: APPLICATION description: System warning. {additionalInfo} '400': description: Bad Request x-response-codes: errors: '25002': domain: API_INVENTORY category: REQUEST description: Any User error. {additionalInfo} '25713': domain: API_INVENTORY category: REQUEST description: 'This Offer is not available : {additionalInfo}.' '404': description: Not Found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: Any System error. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory /offer/withdraw_by_inventory_item_group: post: tags: - Offer description: 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 inventory item group but does not delete the inventory item group object. Similarly, this call also does not delete any of the offers associated with the inventory item group, but instead all of these offers go into the unpublished state. If the seller wanted to relist the multiple-variation eBay listing, they could use the publishOfferByInventoryItemGroup method. operationId: withdrawOfferByInventoryItemGroup parameters: - name: Content-Type in: header description: 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. required: true schema: type: string requestBody: description: The base request of the withdrawOfferByInventoryItemGroup call. content: application/json: schema: description: The base request of the withdrawOfferByInventoryItemGroup call. $ref: '#/components/schemas/WithdrawByInventoryItemGroupRequest' required: true responses: '204': description: No Content '400': description: Bad Request x-response-codes: errors: '25725': domain: API_INVENTORY category: REQUEST description: No offer found '500': description: Internal Server Error x-response-codes: errors: '25001': domain: API_INVENTORY category: APPLICATION description: Any System error. {additionalInfo} security: - api_auth: - https://api.ebay.com/oauth/api_scope/sell.inventory components: schemas: Regulatory: type: object properties: economicOperator: description: 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? $ref: '#/components/schemas/EconomicOperator' energyEfficiencyLabel: description: This container provides information about the energy efficiency for certain durable goods. $ref: '#/components/schemas/EnergyEfficiencyLabel' hazmat: description: 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 listing:The fourth element, Component, is optional. $ref: '#/components/schemas/Hazmat' repairScore: type: number description: This field represents the repair index for the listing.

The repair index identifies the manufacturer's repair score for a product (i.e., how easy is it to repair the product.) This field is a floating point value between 0.0 (i.e., difficult to repair,) and 10.0 (i.e., easily repaired.)

Note: 0 should not be used as a default value, as it implies the product is not repairable.
The format for repairScore is limited to one decimal place. For example:
Note: Repair score is not applicable to all categories. Use the getExtendedProducerResponsibilityPolicies method of the Metadata API to see where repair score is applicable. description: Type defining regulatory information that the seller is required to disclose. EnergyEfficiencyLabel: type: object properties: imageDescription: type: string description: A brief verbal summary of the information included on the Energy Efficiency Label for an item.

For example, On a scale of A to G the rating is E. imageURL: type: string description: The URL to the Energy Efficiency Label image that is applicable to an item. productInformationSheet: type: string description: The URL to the Product Information Sheet that provides complete manufacturer-provided efficiency information about an item. description: This container provides information about the energy efficiency for certain durable goods. ListingPolicies: type: object properties: bestOfferTerms: description: 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 true, and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds.

Note: Best Offer is unavailable for multi-variation listings.
This container is only returned if Best Offer is enabled on listing. $ref: '#/components/schemas/BestOffer' eBayPlusIfEligible: type: boolean description: This field is included in an offer and set to true if a Top-Rated seller is opted in to the eBay Plus program. With the eBay Plus program, qualified sellers must commit to next-day delivery of the item, and the buyers must have an eBay Plus subscription to be eligible to receive the benefits of this program, which are free, next-day delivery, as well as free returns.

Note: Currently, this program is only available on the Germany and Australian sites.
This field will be returned in the getOffer and getOffers methods if set for the offer. fulfillmentPolicyId: type: string description: 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.

Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the fulfillment business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings. The seller may also want to review the shipping service costs in the fulfillment policy, and that seller might decide to override the shipping costs for one or more shipping service options by using the shippingCostOverrides container.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getFulfillmentPolicies method. There are also calls in the Account API to retrieve a fulfillment policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers methods if set for the offer. paymentPolicyId: type: string description: 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.

Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the payment business policy to make sure that it is compatible with the marketplace and listing category before assigning it to the offer.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all payment policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getPaymentPolicies method. There are also calls in the Account API to retrieve a payment policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers methods if set for the offer. productCompliancePolicyIds: type: array description: 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.

Product compliance policies provide buyers with important information and disclosures about products. For example, if you sell batteries and specific disclosures are required to be shared with all potential buyers, your global product compliance policy could contain the required disclosures.

A maximum of six (6) global product compliance policies may apply to each offer.Note: For countries that support country-specific policies, use regionalProductCompliancePolicies to apply them to an offer. items: type: string regionalProductCompliancePolicies: description: 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.

Product compliance policies provide buyers with important information and disclosures about products. For example, if you sell batteries in a country requiring disclosures that apply only to that country, a country-specific product compliance policy could contain this information.

Each offer may include up to six (6) product compliance policies for each of the following countries:
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. $ref: '#/components/schemas/RegionalProductCompliancePolicies' regionalTakeBackPolicies: description: 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.

Each offer may include one (1) country-specific take-back policy for each of the following countries:
Note: Take-back policies that apply to all countries to which a seller ships are specified using takeBackPolicyId. $ref: '#/components/schemas/RegionalTakeBackPolicies' returnPolicyId: type: string description: 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.

Note: As a part of Digital Services Act (DSA) requirements, as of April 3, 2023, buyers in the EU must be allowed to return an item within 14 days or more, unless the item is exempt. Where applicable, sellers should update their return policies to reflect this requirement of accepting returns from EU buyers.
Business policies are not immediately required for offers, but are required before an offer can be published. The seller should review the return business policy before assigning it to the offer to make sure it is compatible with the inventory item and the offer settings.

Business policies can be created and managed in My eBay or with the Account API. To get a list of all return policies associated with a seller's account on a specific eBay Marketplace, use the Account API's getReturnPolicies call. There are also calls in the Account API to retrieve a return policy by policy ID or policy name.

This field will be returned in the getOffer and getOffers methods if set for the offer. shippingCostOverrides: type: array description: 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 DOMESTIC to override a domestic shipping service option, or to INTERNATIONAL to override an international shipping service option.

A separate ShippingCostOverrides node is needed for each shipping service option whose costs are being overridden. All defined fields of the shippingCostOverrides container should be included, even if the shipping costs and surcharge values are not changing.

The shippingCostOverrides container is returned in the getOffer and getOffers calls if one or more shipping cost overrides are being applied to the fulfillment policy. items: $ref: '#/components/schemas/ShippingCostOverride' takeBackPolicyId: type: string description: 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.

One (1) global take-back policy may be specified per offer.
Note: For countries that support country-specific policies, use regionalTakeBackPolicies to apply them to an offer. description: This type is used to identify business policies including payment, return, and fulfillment policies, as well as to identify custom policies. These policies are, or will be, associated with the listing. Every published offer must have a payment, return, and fulfillment business policy associated with it. Additionally, depending on the country/countries in which sellers are offering products and/or services to consumers (e.g., residents of the European Union,) specifying additional polices may be required.

This type is also used to override the shipping costs of one or more shipping service options that are associated with the fulfillment policy, to enable eBay Plus eligibility for a listing, or to enable the Best Offer feature on the listing. CountryPolicy: type: object properties: country: type: string description: 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. For implementation help, refer to eBay API documentation policyIds: type: array description: An array of custom policy identifiers that apply to the country specified by listingPolicies.regionalTakeBackPolicies.countryPolicies.country.

Product compliance and take-back policy information may be returned using the following methods:For information about creating and managing custom policies, refer to the custom_policy resource in the Sell Account API. items: type: string description: This type specifies custom product compliance and/or take-back policies that apply to a specified country. OfferKeysWithId: type: object properties: offers: type: array description: This container is used to identify one or more (up to 250) unpublished offers for which expected listing fees will be retrieved. The user passes one or more offerId values (maximum of 250) in to this container to identify the unpublished offers in which to retrieve expected listing fees. This call is only applicable for offers in the unpublished state.

The call response gives aggregate fee amounts per eBay marketplace, and does not give fee information at the individual offer level. items: $ref: '#/components/schemas/OfferKeyWithId' description: This type is used by the base request payload of the getListingFees call. RegionalTakeBackPolicies: type: object properties: countryPolicies: type: array description: The array of country-specific take-back policies to be used by an offer when it is published and converted to a listing. items: $ref: '#/components/schemas/CountryPolicy' description: This type lists regional take-back policies to be used by an offer when it is published and converted to a listing. PricingSummary: type: object properties: auctionReservePrice: description: 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.

Important: This fee is charged regardless of whether or not the item is sold. $ref: '#/components/schemas/Amount' auctionStartPrice: description: This field indicates the minimum bidding price for the auction. The bidding starts at this price.

Note: If the auctionReservePrice is also specified, the value of auctionStartPrice must be lower than the value of auctionReservePrice. $ref: '#/components/schemas/Amount' minimumAdvertisedPrice: description: 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.

This container will be returned by getOffer and getOffers if set for the offer. $ref: '#/components/schemas/Amount' originallySoldForRetailPriceOn: type: string description: 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 ON_EBAY to indicate that the product was sold for the originalRetailPrice on an eBay site, or the seller will pass in a value of OFF_EBAY to indicate that the product was sold for the originalRetailPrice through a third-party retailer. This field and the originalRetailPrice 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.

This field will be returned by getOffer and getOffers if set for the offer. For implementation help, refer to eBay API documentation originalRetailPrice: description: 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.

This container will be returned by getOffer and getOffers if set for the offer. $ref: '#/components/schemas/Amount' price: description: 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.

For published offers, this container will always be returned, but for unpublished offers, this container will only be returned if set for the offer. $ref: '#/components/schemas/Amount' pricingVisibility: type: string description: 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 PRE_CHECKOUT. To show the MAP price after the buyer already commits to buy the item, the seller will set this value to DURING_CHECKOUT. This field will be ignored if the seller and/or the listing is not eligible for the MAP feature.

This field will be returned by getOffer and getOffers if set for the offer. For implementation help, refer to eBay API documentation description: 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 field must be supplied before an offer is published, but a seller may create an offer without supplying a price initially. 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. EbayOfferDetailsWithAll: type: object properties: availableQuantity: type: integer description: This integer value indicates the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field. format: int32 categoryId: type: string description: The unique identifier of the primary eBay category that the inventory item is listed under. This field is always returned for published offers, but is only returned if set for unpublished offers. charity: description: This container is returned if a charitable organization will receive a percentage of sale proceeds for each sale generated by the 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. $ref: '#/components/schemas/Charity' extendedProducerResponsibility: description: 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. $ref: '#/components/schemas/ExtendedProducerResponsibility' format: type: string description: This enumerated value indicates the listing format of the offer. For implementation help, refer to eBay API documentation hideBuyerDetails: type: boolean description: This field is returned as true if the private listing feature has been enabled for the offer. Sellers may want to use this feature when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users.

This field is always returned even if not explicitly set in the offer. It defaults to false, so will get returned as false if seller does not set this feature with a 'Create' or 'Update' offer method. includeCatalogProductDetails: type: boolean description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.

listing: description: For published offers, this container is always returned in the getOffer and getOffers calls, and includes the eBay listing ID associated with the offer, the status of the listing, and the quantity sold through the listing. The listing container is not returned at all for unpublished offers. $ref: '#/components/schemas/ListingDetails' listingDescription: type: string description: 'The description of the eBay listing that is part of the unpublished or published offer. This field is always returned for published offers, but is only returned if set for unpublished offers.

Max Length: 500000 (which includes HTML markup/tags)' listingDuration: type: string description: This field indicates the number of days that the listing will be active.

This field is returned for both auction and fixed-price listings; however, the value returned for fixed-price listings will always be GTC. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer, the listing then becomes available as a fixed-price offer and will be GTC. For implementation help, refer to eBay API documentation listingPolicies: description: This container indicates the listing policies that are applied to the offer. Listing policies include business policies, custom listing policies, and fields that override shipping costs, enable eBay Plus eligibility, or enable the Best Offer feature.

It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell Account API. The sell Account API can also be used to create and manage custom policies. For more information, see the sell Account API.

For unpublished offers where business policies have yet to be specified, this container will be returned as empty. $ref: '#/components/schemas/ListingPolicies' listingStartDate: type: string description: 'This timestamp is the date/time (in UTC format) that the seller set for the scheduled listing. With the scheduled listing feature, the seller can set a time in the future that the listing will become active, instead of the listing becoming active immediately after a publishOffer call.

For example: 2023-05-30T19:08:00Z.

Scheduled listings do not always start at the exact date/time specified by the seller, but the date/time of the timestamp returned in getOffer/getOffers will be the same as the timestamp passed into a ''Create'' or ''Update'' offer call.

This field is returned if set for an offer.' lotSize: type: integer description: This field is only applicable and returned if the listing is a lot listing. A lot listing is a listing that has multiple quantity of the same product. An example would be a set of four identical car tires. The integer value in this field is the number of identical items being sold through the lot listing. format: int32 marketplaceId: type: string description: This enumeration value is the unique identifier of the eBay site on which the offer is available, or will be made available. For implementation help, refer to eBay API documentation merchantLocationKey: type: string description: 'The unique identifier of the inventory location. This identifier is set up by the merchant when the inventory location is first created with the createInventoryLocation call. Once this value is set for an inventory location, it can not be modified. To get more information about this inventory location, the getInventoryLocation method can be used, passing in this value at the end of the call URI.

This field is always returned for published offers, but is only returned if set for unpublished offers.

Max length: 36' offerId: type: string description: The unique identifier of the offer. This identifier is used in many offer-related calls, and it is also used in the bulkUpdatePriceQuantity call. pricingSummary: description: 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.

For unpublished offers where pricing information has yet to be specified, this container will be returned as empty. $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: type: integer description: This field is only applicable and set if the seller wishes to set a restriction on the purchase quantity of an inventory item per seller. If this field is set by the seller for the offer, then each distinct buyer may purchase up to, but not exceed the quantity in this field. So, if this field's value is 5, each buyer may purchase a quantity of the inventory item between one and five, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.
format: int32 regulatory: description: This container is used by the seller to provide regulatory information. $ref: '#/components/schemas/Regulatory' secondaryCategoryId: type: string description: 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.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. sku: type: string description: 'This is the seller-defined SKU value of the product in the offer.

Max Length: 50
' status: type: string description: The enumeration value in this field specifies the status of the offer - either PUBLISHED or UNPUBLISHED. For implementation help, refer to eBay API documentation storeCategoryNames: type: array description: 'This container is returned if the seller chose to place the inventory item into one or two eBay store categories that the seller has set up for their eBay store. The string value(s) in this container will be the full path(s) to the eBay store categories, as shown below:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
' items: type: string tax: description: This container is only returned if a sales tax table, a Value-Added Tax (VAT) rate, and/or a tax exception category code was 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 true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax.

See the Using a tax table help page for more information on setting up and using a sales tax table. $ref: '#/components/schemas/Tax' description: This type provides details of an offer, and is used by the response payloads of the getOffer and the getOffers calls. OfferSkuResponse: type: object properties: errors: type: array description: This container will be returned at the offer level, and will contain one or more errors if any occurred with the attempted creation of the corresponding offer. items: $ref: '#/components/schemas/Error' format: type: string description: This enumeration value indicates the listing format of the offer. For implementation help, refer to eBay API documentation marketplaceId: type: string description: This enumeration value is the unique identifier of the eBay marketplace for which the offer will be made available. This enumeration value should be the same for all offers since the bulkCreateOffer method can only be used to create offers for one eBay marketplace at a time. For implementation help, refer to eBay API documentation offerId: type: string description: The unique identifier of the newly-created offer. This identifier should be automatically created by eBay if the creation of the offer was successful. It is not returned if the creation of the offer was not successful. In which case, the user may want to scan the corresponding errors and/or warnings container to see what the issue may be. sku: type: string description: The seller-defined Stock-Keeping Unit (SKU) of the inventory item. The sku value is required for each product offer that the seller is trying to create, and it is always returned to identified the product that is associated with the offer. statusCode: type: integer description: The integer value returned in this field is the http status code. If an offer is created successfully, the value returned in this field should be 200. A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkCreateOffer method. format: int32 warnings: type: array description: This container will be returned at the offer level, and will contain one or more warnings if any occurred with the attempted creation of the corresponding offer. Note that it is possible that an offer can be created successfully even if one or more warnings are triggered. items: $ref: '#/components/schemas/Error' description: 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 each offer that is created successfully, the returned statusCode value should be 200, and a unique offerId should be created for each offer. If any issues occur with the creation of any offers, errors and/or warnings containers will be returned. Charity: type: object properties: charityId: type: string description: 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.

This field is conditionally required if a seller is planning on donating a percentage of the sale proceeds to a charitable organization.

The eBay-assigned unique identifier of a charitable organization can be found using the getCharityOrgs method of the Charity API. In the getCharityOrgs response, this unique identifier is shown in the charityOrgId field. donationPercentage: type: string description: 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. 10, 15, 20...95,... 100). The seller would pass in 10 for 10 percent, 15 for 15 percent, 20 for 20 percent, and so on, all the way to 100 for 100 percent. description: This type is used to identify the charitable organization associated with the listing, and the percentage of the sale proceeds that the charitable organization will receive for each sale generated by the listing.

In order to receive a percentage of the sales proceeds, the charitable organization must be registered with the PayPal Giving Fund, which is a partner of eBay for Charity. Amount: type: object properties: currency: type: string description: 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.

See the CurrencyCodeEnum type for the full list of currencies and their corresponding three-digit string values. value: type: string description: 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. description: This type is used to express a dollar value and the applicable currency. BulkOfferResponse: type: object properties: responses: type: array items: $ref: '#/components/schemas/OfferSkuResponse' description: This type is used by the base response of the bulkCreateOffer method. FeesSummaryResponse: type: object properties: feeSummaries: type: array description: This container consists of an array of one or more listing fees that the seller can expect to pay for unpublished offers specified in the call request. Many fee types will get returned even when they are 0.0. items: $ref: '#/components/schemas/FeeSummary' description: 'This type is used by the base response payload for the getListingFees call. ' RegionalProductCompliancePolicies: type: object properties: countryPolicies: type: array description: The array of country-specific product compliance policies to be used by an offer when it is published and converted to a listing. items: $ref: '#/components/schemas/CountryPolicy' description: This type lists regional product compliance policies to be used by an offer when it is published and converted to a listing. ShippingCostOverride: type: object properties: additionalShippingCost: description: 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.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. $ref: '#/components/schemas/Amount' priority: type: integer description: 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.

This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden. format: int32 shippingCost: description: 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.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. $ref: '#/components/schemas/Amount' shippingServiceType: type: string description: 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 DOMESTIC, and to override the shipping costs for each international shipping service, this field should be set to INTERNATIONAL. This value, along with priority value, sets which domestic or international shipping service option in the fulfillment policy that 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.

This field is always required when overriding the shipping costs of a shipping service option, and will be always be returned for each shipping service option whose costs are being overridden. For implementation help, refer to eBay API documentation surcharge: description: 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.

The dollar value passed into this field will override the shipping surcharge that is currently set for the applicable shipping service option. The shipping service option in the fulfillment policy to override is controlled by the shippingServiceType and priority values.

If using an updateOffer call, and this field is defined for the offer being updated, this field must be supplied again, even if its value is not changing.

This field is returned in the getOffer and getOffers calls if defined. $ref: '#/components/schemas/Amount' description: 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 defined in the fulfillment listing policy that is being applied toward the offer. The shipping-related costs that can be overridden include the shipping cost to ship one item, the shipping cost to ship each additional item (if multiple quantity are purchased), and the shipping surcharge applied to the shipping service option. OfferKeyWithId: type: object properties: offerId: type: string description: The unique identifier of an unpublished offer for which expected listing fees will be retrieved. One to 250 offerId values can be passed in to the offers container for one getListingFees call.

Use the getOffers method to retrieve offer IDs.

Note: Errors will occur if offerId values representing published offers are passed in. description: 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 more offerId values (a maximum of 250). See the Standard selling fees help page for more information on listing fees. OfferResponseWithListingId: type: object properties: errors: type: array description: This container will be returned if there were one or more errors associated with publishing the offer. items: $ref: '#/components/schemas/Error' listingId: type: string description: The unique identifier of the newly-created eBay listing. This field is only returned if the seller successfully published the offer and created the new eBay listing. offerId: type: string description: The unique identifier of the offer that the seller published (or attempted to publish). statusCode: type: integer description: The HTTP status code returned in this field indicates the success or failure of publishing the offer specified in the offerId field. See the HTTP status codes table to see which each status code indicates. format: int32 warnings: type: array description: This container will be returned if there were one or more warnings associated with publishing the offer. items: $ref: '#/components/schemas/Error' description: 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 known as an Item ID) is returned. If there is an issue publishing the offer and creating the new eBay listing, the information about why the listing failed should be returned in the errors and/or warnings containers. BulkEbayOfferDetailsWithKeys: type: object properties: requests: type: array description: The details of each offer that is being created is passed in under this container. Up to 25 offers can be created with one bulkCreateOffer call. items: $ref: '#/components/schemas/EbayOfferDetailsWithKeys' description: This type is used by the base request of the bulkCreateOffer method, which is used to create up to 25 new offers. BestOffer: type: object properties: autoAcceptPrice: description: 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 true.

The price set here must be lower than the current 'Buy it Now' price. This field is only returned by getOffer and getOffers if set. $ref: '#/components/schemas/Amount' autoDeclinePrice: description: 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 true.

The price set here must be lower than the current 'Buy it Now' price and the price set in the autoAcceptPrice field (if used). This field is only returned by getOffer and getOffers if set. $ref: '#/components/schemas/Amount' bestOfferEnabled: type: boolean description: 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.

The seller includes this field and sets its value to true to enable Best Offer feature.

Note: Best Offer is not available for multi-variation listings. description: 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. Error: type: object properties: category: type: string description: 'This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. ' domain: type: string description: The name of the domain in which the error or warning occurred. errorId: type: integer description: 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. format: int32 inputRefIds: type: array description: 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. items: type: string longMessage: type: string description: A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. message: type: string description: A description of the condition that caused the error or warning. outputRefIds: type: array description: 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. items: type: string parameters: type: array description: 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. items: $ref: '#/components/schemas/ErrorParameter' subdomain: type: string description: The name of the subdomain in which the error or warning occurred. description: This type is used to express detailed information on errors and warnings that may occur with a call request. OfferResponse: type: object properties: offerId: type: string description: 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.

warnings: type: array description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur. items: $ref: '#/components/schemas/Error' description: 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 is successfully created by the createOffer call. The warnings field contains any errors and/or warnings that may have been triggered by the call.

Note: The offerId value is only returned with a successful createOffer call. This field will not be returned in the updateOffer response.

ListingDetails: type: object properties: listingId: type: string description: 'The unique identifier of the eBay listing that is associated with the published offer. ' listingOnHold: type: boolean description: Indicates if a listing is on hold due to an eBay policy violation.

If a listing is put on hold, users are unable to view the listing details, the listing is hidden from search, and all attempted purchases, offers, and bids for the listing are blocked. eBay, however, gives sellers the opportunity to address violations and get listings fully reinstated. A listing will be ended if a seller does not address a violation, or if the violation can not be rectified.


If a listing is fixable, the seller should be able to view the listing details and this boolean will be returned as true.


Once a listing is fixed, this boolean will no longer be returned.

listingStatus: type: string description: The enumeration value returned in this field indicates the status of the listing that is associated with the published offer. For implementation help, refer to eBay API documentation soldQuantity: type: integer description: This integer value indicates the quantity of the product that has been sold for the published offer. format: int32 description: 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 offer. The listing container is only returned for published offers, and is not returned for unpublished offers. Fee: type: object properties: amount: description: This dollar value in this container is the actual dollar value of the listing fee type specified in the feeType field. $ref: '#/components/schemas/Amount' feeType: type: string description: The value returned in this field indicates the type of listing fee that the seller may incur if one or more unpublished offers (offers are specified in the call request) are published on the marketplace specified in the marketplaceId field. Applicable listing fees will often include things such as InsertionFee or SubtitleFee, but many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees. promotionalDiscount: description: The dollar value in this container indicates any eBay promotional discount applied toward the listing fee type specified in the feeType field. If there was no discount applied toward the fee, this container is still returned but its value is 0.0. $ref: '#/components/schemas/Amount' description: 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 discounts being applied toward a specific fee. These fees are the expected cumulative fees per eBay marketplace (which is indicated in the marketplaceId field). EbayOfferDetailsWithId: type: object properties: availableQuantity: type: integer description: This integer value sets the quantity of the inventory item that will be available through the offer. Quantity must be set to 1 or more in order for the inventory item to be purchasable. This value should not be more than the quantity that is specified for the inventory item record. For auction listings, this value must be 1.

If this field exists for the current unpublished or published offer, it should be provided again in the updateOffer call, even if the value is not changing. If this particular field is omitted in an updateOffer call, the general available quantity set for the inventory item record may be used instead, and this may not be accurate if the inventory item is being sold across multiple marketplaces. format: int32 categoryId: type: string description: 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.

If this field exists for the current unpublished offer, it should be provided again in the updateOffer call, even if the eBay category is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur. The eBay category of an active eBay listing cannot be changed once the listing has one or more sales, or if the listing is scheduled to end in less than 12 hours. charity: description: 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. $ref: '#/components/schemas/Charity' extendedProducerResponsibility: description: 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. $ref: '#/components/schemas/ExtendedProducerResponsibility' hideBuyerDetails: type: boolean description: This field is included and set to true if the seller wishes to update a published or unpublished offer with the private listing feature. Alternatively, the seller could also remove the private listing feature (if already set for a published or unpublished offer) by including this field and setting it to false.

Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. includeCatalogProductDetails: type: boolean description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to 'true' if omitted.

listingDescription: type: string description: '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.

HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.

Note: To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s View Item description summary feature when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.

Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.

If this field exists for the current unpublished offer, it should be provided again in the updateOffer call, even if the text is not changing. For a published offer (aka active eBay listing), this field must be provided or an error may occur.

Max length: 500000 (which includes HTML markup/tags)' listingDuration: type: string description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC, but auction listings support different listing durations.

The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be GTC. For implementation help, refer to eBay API documentation listingPolicies: description: 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.

This container is required for updating published offers, regardless of whether or not the business policies are being changed. For an unpublished offer, this field is not necessarily required, but will be required before an offer can be published.

It is required that the seller be opted in to Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Similarly, payment, return, and fulfillment business policies may be created/managed in My eBay or by using the business policy calls of the Account API. $ref: '#/components/schemas/ListingPolicies' listingStartDate: type: string description: '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.

For example: 2023-05-30T19:08:00Z.

This field is optional, and it doesn''t apply to offers where the corresponding listing is already active. If this field is not provided, the listing starts immediately after a successful publishOffer method.' lotSize: type: integer description: 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. format: int32 merchantLocationKey: type: string description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located).

To get more information about inventory locations, the getInventoryLocations method can be used.br>
Note: This field is not initially required upon first creating an offer, but will become required before an offer can be published.
Max length: 36' pricingSummary: description: 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.

This container is required for updating published offers, regardless of whether or not the pricing information is being changed or not. For an unpublished offer, this container is not necessarily required, but an offer price will be required before an offer can be published, and if a pricingSummary container already exists for an unpublished offer, it must be provided again, even if the values are not changing. $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: type: integer description: 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 5, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.

If this field currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if the value is not changing.
format: int32 regulatory: description: This container is used by the seller to provide regulatory information. $ref: '#/components/schemas/Regulatory' secondaryCategoryId: type: string description: 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.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. storeCategoryNames: type: array description: '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:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
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.' items: type: string tax: description: 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 true, but a buyer's purchase will not involve sales tax. A sales tax rate must be set up in the seller's sales tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the Account API.

If tax information currently exists for an unpublished or published offer, it should be provided again in an updateOffer call, even if none of the tax settings are changing.

See the Using a tax table help page for more information on setting up and using a sales tax table. $ref: '#/components/schemas/Tax' description: 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 values are not changing. Note that for published offers, a successful updateOffer call will actually update the active eBay listing with whatever changes were made. BulkOffer: type: object properties: requests: type: array description: This container is used to pass in an array of offers to publish. Up to 25 offers can be published with one bulkPublishOffer method. items: $ref: '#/components/schemas/OfferKeyWithId' description: This type is used by the base request of the bulkPublishOffer method, which is used to publish up to 25 different offers. EbayOfferDetailsWithKeys: type: object properties: availableQuantity: type: integer description: This integer value sets the quantity of the inventory item (specified by the sku value) that will be available for purchase by buyers shopping on the eBay site specified in the marketplaceId field. Quantity must be set to 1 or more in order for the inventory item to be purchasable, but this field is not necessarily required, even for published offers, if the general quantity of the inventory item has already been set in the inventory item record.

For auction listings, this value must be 1. format: int32 categoryId: type: string description: The unique identifier of the eBay category that the product will be listed under. This field is not immediately required upon creating an 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. charity: description: This container is used if the seller wishes to select 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. $ref: '#/components/schemas/Charity' extendedProducerResponsibility: description: 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. $ref: '#/components/schemas/ExtendedProducerResponsibility' format: type: string description: This enumerated value indicates the listing format of the offer.

Supported values are FIXED_PRICE and AUCTION. For implementation help, refer to eBay API documentation hideBuyerDetails: type: boolean description: This field is included and set to true if the seller wishes to create a private listing.

Sellers may want to use this option when they believe that a listing's potential bidders/buyers would not want their obfuscated user IDs (and feedback scores) exposed to other users. includeCatalogProductDetails: type: boolean description: This field indicates whether or not eBay product catalog details are applied to a listing. A value of true indicates the listing corresponds to the eBay product associated with the provided product identifier. The product identifier is provided in createOrReplaceInventoryItem.

Default: true

Note: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true if omitted.

listingDescription: type: string description: '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.

HTML tags and markup can be used in listing descriptions, but each character counts toward the max length limit.

Note: To ensure that their short listing description is optimized when viewed on mobile devices, sellers should strongly consider using eBay''s View Item description summary feature when listing their items. Keep in mind that the ''short'' listing description is what prospective buyers first see when they view the listing on a mobile device. The ''full'' listing description is also available to mobile users when they click on the short listing description, but the full description is not automatically optimized for viewing in mobile devices, and many users won''t even drill down to the full description.

Using HTML div and span tag attributes, this feature allows sellers to customize and fully control the short listing description that is displayed to prospective buyers when viewing the listing on a mobile device. The short listing description on mobile devices is limited to 800 characters, and whenever the full listing description (provided in this field, in UI, or seller tool) exceeds this limit, eBay uses a special algorithm to derive the best possible short listing description within the 800-character limit. However, due to some short listing description content being removed, it is definitely not ideal for the seller, and could lead to a bad buyer experience and possibly to a Significantly not as described (SNAD) case, since the buyer may not get complete details on the item when viewing the short listing description. See the eBay help page for more details on using the HTML div and span tags.

Max length: 500000 (which includes HTML markup/tags)' listingDuration: type: string description: This field indicates the number of days that the listing will be active. For fixed-price listings, this value must be set to GTC, but auction listings support different listing durations.

The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.

Note: If the listing duration expires for an auction offer without a winning bidder, the listing then becomes available as a fixed-price offer and listing duration will be GTC. For implementation help, refer to eBay API documentation listingPolicies: description: 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.

It is required that the seller be opted into Business Policies before being able to create live eBay listings through the Inventory API. Sellers can opt-in to Business Policies through My eBay or by using the Account API's optInToProgram call. Payment, return, and fulfillment listing policies may be created/managed in My eBay or by using the listing policy calls of the sell Account API. The sell Account API can also be used to create and manage custom policies. For more information, see the sell Account API. $ref: '#/components/schemas/ListingPolicies' listingStartDate: type: string description: 'This field can be used 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.

For example: 2023-05-30T19:08:00Z.

This field is optional. If this field is not provided, the listing starts immediately after a successful publishOffer method.' lotSize: type: integer description: 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. format: int32 marketplaceId: type: string description: This enumeration value is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for the list of supported enumeration values. This field is required. For implementation help, refer to eBay API documentation merchantLocationKey: type: string description: 'The unique identifier of a merchant''s inventory location (where the inventory item in the offer is located).

To get more information about inventory locations, the getInventoryLocations method can be used.

Note: This field is not initially required upon first creating an offer, but will become required before an offer can be published.
Max length: 36' pricingSummary: description: 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.

This container is not initially required upon first creating an offer, but the price of the offer will become required before an offer can be published. $ref: '#/components/schemas/PricingSummary' quantityLimitPerBuyer: type: integer description: 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 exceed the quantity specified for this field. So, if this field's value is 5, each buyer may purchase between one to five of these products, and the purchases can occur in one multiple-quantity purchase, or over multiple transactions. If a buyer attempts to purchase one or more of these products, and the cumulative quantity will take the buyer beyond the quantity limit, that buyer will be blocked from that purchase.
format: int32 regulatory: description: This container is used by the seller to provide regulatory information. $ref: '#/components/schemas/Regulatory' secondaryCategoryId: type: string description: 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.

Note: You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. sku: type: string description: 'The seller-defined SKU value of the product that will be listed on the eBay site (specified in the marketplaceId field). Only one offer (in unpublished or published state) may exist for each sku/marketplaceId/format combination. This field is required.

Use the getInventoryItems method to retrieve SKU values.

Max Length: 50
' storeCategoryNames: type: array description: 'This container is used if the seller would like to place the inventory item into one or two eBay 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 eBay store categories, as shown below:
"storeCategoryNames": [
 "/Fashion/Men/Shirts", 
 "/Fashion/Men/Accessories" ],
' items: type: string tax: description: This container is applicable and used only 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 true, but a buyer's purchase will not involve sales tax.

A sales-tax rate must be set up in the seller's sales-tax table for the buyer's state/tax jurisdiction in order for that buyer to be subject to sales tax. Sales-tax rates for different jurisdictions can be added/modified in the Payment Preferences section of My eBay, or the seller can use the sales tax calls of the Account API.

Note: Sales-tax tables are available only for the US and Canada marketplaces.
Refer to Taxes and import charges for more information on setting up and using a sales tax table. $ref: '#/components/schemas/Tax' description: This type provides details of an offer, and is used by the base request payload of the createOffer and bulkCreateOffer methods. Hazmat: type: object properties: component: type: string description: 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.

Max length: 120 pictograms: type: array description: An array of comma-separated string values listing applicable pictogram code(s) for Hazard Pictogram(s).

If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard pictograms that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.

Note: Use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. Refer to Pictogram sample values for additional information. items: type: string signalWord: type: string description: This field sets the signal word for hazardous materials in the listing.

If your product contains hazardous substances or mixtures, please select a value corresponding to the signal word that is stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.

Note: Use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. Refer to Signal word information for additional information. statements: type: array description: An array of comma-separated string values specifying applicable statement code(s) for hazard statement(s) for the listing.

If your product contains hazardous substances or mixtures, please select the values corresponding to the hazard statements that are stated on your product's Safety Data Sheet. The selected hazard information will be displayed on your listing.

Note: Use the getHazardousMaterialsLabels method in the Metadata API to find supported values for a specific marketplace/site. Refer to Hazard statement sample values for additional information. items: type: string description: 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 listing:
A fourth element, Component, is optional. FeeSummary: type: object properties: fees: type: array description: This container is an array of listing fees that can be expected to be applied to an offer on the specified eBay marketplace (marketplaceId value). Many fee types will get returned even when they are 0.0.

See the Standard selling fees help page for more information on listing fees. items: $ref: '#/components/schemas/Fee' marketplaceId: type: string description: This is the unique identifier of the eBay site for which listing fees for the offer are applicable. For implementation help, refer to eBay API documentation warnings: type: array description: This container will contain an array of errors and/or warnings when a call is made, and errors and/or warnings occur. items: $ref: '#/components/schemas/Error' description: This type is used to display the expected listing fees for each unpublished offer specified in the request of the getListingFees call. WithdrawByInventoryItemGroupRequest: type: object properties: inventoryItemGroupKey: type: string description: This is the unique identifier of the inventory item group. This identifier is automatically generated by eBay once an inventory item group is created.

To retrieve an inventoryItemGroupKey value, you can use the getInventoryItem method to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the groupIds container in the response of that call. marketplaceId: type: string description: This is the unique identifier of the eBay site for which the offer will be made available. See MarketplaceEnum for supported values. For implementation help, refer to eBay API documentation description: This type is used by the base request of the WithdrawByInventoryItemGroup method, which is used to end a multiple-variation listing. ErrorParameter: type: object properties: name: type: string description: This type contains the name and value of an input parameter that contributed to a specific error or warning condition. value: type: string description: This is the actual value that was passed in for the element specified in the name field. description: This type is used to indicate the parameter field/value that caused an issue with the call request. Tax: type: object properties: applyTax: type: boolean description: 'When set to true, the seller''s account-level sales-tax table will be used to calculate sales tax for an order.

Note: Sales-tax tables are available only for the US and Canada marketplaces.

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.

However, sellers may continue to use a sales-tax table to set rates for the following US territories:


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.' thirdPartyTaxCategory: type: string description: 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 WASTE_RECYCLING_FEE. If this field is used, the applyTax field must also be used and set to true

This field will be returned by getOffer and getOffers if set for the offer. vatPercentage: type: number description: 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.

To use VAT, a seller must be a business seller with a VAT-ID registered with eBay, and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346).

This field will be returned by getOffer and getOffers if set for the offer. description: 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 available only for the US and Canada marketplaces. BulkPublishResponse: type: object properties: responses: type: array description: A node is returned under the responses container to indicate the success or failure of each offer that the seller was attempting to publish. items: $ref: '#/components/schemas/OfferResponseWithListingId' description: This type is used by the base response of the bulkPublishOffer method. Offers: type: object properties: href: type: string description: This is the URL to the current page of offers. limit: type: integer description: This integer value is the number of offers that will be displayed on each results page. format: int32 next: type: string description: This is the URL to the next page of offers. This field will only be returned if there are additional offers to view. offers: type: array description: This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required sku query parameter.

Note: Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces.
Max Occurs: 25 items: $ref: '#/components/schemas/EbayOfferDetailsWithAll' prev: type: string description: This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view. size: type: integer description: This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the limit value if there are additional pages of results to view.

Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers and this value will be 2. Otherwise, only one offer will be returned and this value will be 1. format: int32 total: type: integer description: This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the limit value, the seller may have to toggle through multiple pages to view all offers.

Note: The same SKU can be offered through an auction and a fixed-price listing concurrently. If this is the case, getOffers will return two offers, so this value would be 2. Otherwise, only one offer will be returned and this value will be 1. format: int32 description: 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. ExtendedProducerResponsibility: type: object properties: ecoParticipationFee: description: 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.

Note: 0 should not be used as a default value.
Minimum: 0.0 $ref: '#/components/schemas/Amount' producerProductId: type: string description: '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.' productDocumentationId: type: string description: '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.' productPackageId: type: string description: '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.' shipmentPackageId: type: string description: '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.' description: 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 as in France, this may be the importer of the item. EconomicOperator: type: object properties: addressLine1: type: string description: The first line of the registered Economic Operator's street address. addressLine2: type: string description: 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'. city: type: string description: The city of the registered Economic Operator's street address. companyName: type: string description: The company name of the registered Economic Operator. country: type: string description: The two-letter ISO 3166-1 standard abbreviation of the country of the registered Economic Operator's address. For implementation help, refer to eBay API documentation email: type: string description: The registered Economic Operator's business email address. phone: type: string description: The registered Economic Operator's business phone number. postalCode: type: string description: The postal code of the registered Economic Operator's street address. stateOrProvince: type: string description: The state or province of the registered Economic Operator's street address. description: 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, has some responsibility for, the product being listed for sale. For additional information, see What is an economic operator? WithdrawResponse: type: object properties: listingId: type: string description: The unique identifier of the eBay listing associated with the offer that was withdrawn. This field will not be returned if the eBay listing was not successfully ended. warnings: type: array description: This container will be returned if there were one or more warnings associated with the attempt to withdraw the offer. items: $ref: '#/components/schemas/Error' description: The base response of the withdrawOffer call. PublishByInventoryItemGroupRequest: type: object properties: inventoryItemGroupKey: type: string description: This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the publishByInventoryItemGroup call is successful. The inventoryItemGroupKey identifier is automatically generated by eBay once an inventory item group is created.

To retrieve an inventoryItemGroupKey value, you can use the getInventoryItem method to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the groupIds container in the response of that call. marketplaceId: type: string description: This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The marketplaceId enumeration values are found in MarketplaceEnum. For implementation help, refer to eBay API documentation description: This type is used by the request payload of the publishByInventoryItemGroup call. The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload. PublishResponse: type: object properties: listingId: type: string description: 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. warnings: type: array description: This container will contain an array of errors and/or warnings if any occur when a publishOffer or publishOfferByInventoryItemGroup call is made. items: $ref: '#/components/schemas/Error' description: This type is used by the base response payload of the publishOffer and publishOfferByInventoryItemGroup calls. securitySchemes: api_auth: type: oauth2 description: The security definitions for this API. Please check individual operations for applicable scopes. flows: authorizationCode: authorizationUrl: https://auth.ebay.com/oauth2/authorize tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/sell.account.readonly: View your account settings https://api.ebay.com/oauth/api_scope/sell.account: View and manage your account settings