{
"openapi": "3.0.0",
"info": {
"title": "Inventory API",
"description": "The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.",
"contact": {
"name": "eBay Inc,"
},
"license": {
"name": "eBay API License Agreement",
"url": "https://go.developer.ebay.com/api-license-agreement"
},
"version": "1.17.4"
},
"servers": [
{
"url": "https://api.ebay.com{basePath}",
"description": "Production",
"variables": {
"basePath": {
"default": "/sell/inventory/v1"
}
}
}
],
"paths": {
"/bulk_create_or_replace_inventory_item": {
"post": {
"tags": [
"inventory_item"
],
"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 can be used to create and/or update up to 25 new inventory item records. It is up to sellers whether they want to create a complete inventory item records right from the start, or sellers can provide only some information with the initial bulkCreateOrReplaceInventoryItem call, and then make one or more additional bulkCreateOrReplaceInventoryItem calls to complete all required fields for the inventory item records and prepare for publishing. Upon first creating inventory item records, only the SKU values are required.
Note: In addition to the authorization
header, which is required for all eBay REST API calls, this call also requires the Content-Language
and Content-Type
headers. See the HTTP request headers section for more information.
In the case of updating existing inventory item records, the bulkCreateOrReplaceInventoryItem call will do a complete replacement of the existing inventory item records, so all fields that are currently defined for the inventory item record are required in that update action, regardless of whether their values changed. So, when replacing/updating an inventory item record, it is advised that the seller run a 'Get' call to retrieve the full details of the inventory item records and see all of its current values/settings before attempting to update the records. Any changes that are made to inventory item records that are part of one or more active eBay listings, a successful call will automatically update these active listings.
The key information that is set with the bulkCreateOrReplaceInventoryItem call include:
For those who prefer to create or update a single inventory item record, the createOrReplaceInventoryItem method can be used.
", "operationId": "bulkCreateOrReplaceInventoryItem", "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.en-US
for English or de-DE
for German.authorization
header, which is required for all Inventory API calls, this call also requires the Content-Type
header. See the HTTP request headers for more information.authorization
header, which is required for all Inventory API calls, this call also requires the Content-Type
header. See the HTTP request headers for more information.authorization
header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.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.In addition to the authorization
header, which is required for all eBay REST API calls, the createOrReplaceInventoryItem call also requires the Content-Language
header, that sets the natural language that will be used in the field values of the request payload. For US English, the code value passed in this header should be en-US
. To view other supported Content-Language
values, and to read more about all supported HTTP headers for eBay REST API calls, see the HTTP request headers topic in the Using eBay RESTful APIs document.
For those who prefer to create or update numerous inventory item records with one call (up to 25 at a time), the bulkCreateOrReplaceInventoryItem method can be used.
", "operationId": "createOrReplaceInventoryItem", "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 been-US
for English or de-DE
for German.The authorization
header is the only required HTTP header for this call. See the HTTP request headers section for more information.
authorization
header is the only required HTTP header for this call, and it is required for all Inventory API calls. See the HTTP request headers section for more information.1
to 200
.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"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InventoryItems"
}
}
}
},
"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}."
},
"25710": {
"domain": "API_INVENTORY",
"category": "REQUEST",
"description": "We didn't find the resource/entity you are requesting. Please verify the request"
}
}
}
},
"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"
]
}
]
}
},
"/inventory_item/{sku}/product_compatibility": {
"get": {
"tags": [
"product_compatibility"
],
"description": "This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call with return the compatible vehicle list associated with this inventory item. Product compatibility is currently only applicable to motor vehicle parts and accessory categories, but more categories may be supported in the future.",
"operationId": "getProductCompatibility",
"parameters": [
{
"name": "sku",
"in": "path",
"description": "This path parameter specifies the SKU (stock keeping unit) of the inventory item associated with the product compatibility list being retrieved.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.",
"operationId": "createOrReplaceProductCompatibility",
"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.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.en-US
for English or de-DE
for German.Note: Auction listings are supported by the Inventory API, but the bulkMigrateListing method cannot be used to migrate auction listings.
Content-Type
request header. See the HTTP request headers for more information. There are no path or query parameters for this 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, 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 been-US
for English or de-DE
for German.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.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: Though the includeCatalogProductDetails parameter is not required to be submitted in the request, the parameter defaults to true
if omitted.
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 been-US
for English or de-DE
for German.The authorization
header is the only required HTTP header for this call. See the HTTP request headers section for more information.
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 been-US
for English or de-DE
for German.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.The authorization
HTTP header is the only required request header for this call.
A successful call will return an HTTP status value of 200 OK.
", "operationId": "getInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is being retrieved.Use this call to create a new inventory location. In order to create and publish an offer (and create an eBay listing), a seller must have at least one inventory location, as every offer must be associated with a location.
Upon first creating an inventory location, only a seller-defined location identifier and a physical location is required, and once set, these values can not be changed. The unique identifier value (merchantLocationKey) is passed in at the end of the call URI. This merchantLocationKey value will be used in other Inventory Location calls to identify the inventory location to perform an action against.
At this time, location types are either warehouse or store. Warehouse locations are used for traditional shipping, and store locations are generally used by US merchants selling products through the In-Store Pickup program, or used by UK, Australian, and German merchants selling products through the Click and Collect program. A full address is required for store inventory locations. However, for warehouse inventory locations, a full street address is not needed, but the city, state/province, and country of the location must be provided.
Note that all inventory locations are \"enabled\" by default when they are created, and you must specifically disable them (by passing in a value of DISABLED
in the merchantLocationStatus field) if you want them to be set to the disabled state. The seller's inventory cannot be loaded to inventory locations in the disabled state.
Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of 204 No Content.
", "operationId": "createInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies the unique, seller-defined key (ID) for an inventory location.This call deletes the inventory location that is specified in the merchantLocationKey
path parameter. Note that deleting a location will not affect any active eBay listings associated with the deleted location, but the seller will not be able modify the offers associated with the inventory location once it is deleted.
The authorization
HTTP header is the only required request header for this call.
Unless one or more errors and/or warnings occur with the call, there is no response payload for this call. A successful call will return an HTTP status value of 200 OK.
", "operationId": "deleteInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for the inventory location that is to be deleted.This call disables the inventory location that is specified in the merchantLocationKey
path parameter. Sellers can not load/modify inventory to disabled inventory locations. Note that disabling an inventory location will not affect any active eBay listings associated with the disabled location, but the seller will not be able modify the offers associated with a disabled inventory location.
A successful call will return an HTTP status value of 200 OK.
", "operationId": "disableInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is to be disabled.This call enables a disabled inventory location that is specified in the merchantLocationKey
path parameter. Once a disabled inventory location is enabled, sellers can start loading/modifying inventory to that inventory location.
A successful call will return an HTTP status value of 200 OK.
", "operationId": "enableInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies unique merchant-defined key (ID) for adisabled
inventory location that is to be enabled.The authorization
HTTP header is the only required request header for this call.
A successful call will return an HTTP status value of 200 OK.
", "operationId": "getInventoryLocations", "parameters": [ { "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.Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0
and a limit of 10
, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10
and limit is 20
, the first page of the response contains items 11-30 from the complete result set.
Default: 0
", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationResponse" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error", "x-response-codes": { "errors": { "25001": { "domain": "API_INVENTORY", "category": "APPLICATION", "description": "System error. {additionalInfo}" } } } } }, "security": [ { "api_auth": [ "https://api.ebay.com/oauth/api_scope/sell.inventory.readonly", "https://api.ebay.com/oauth/api_scope/sell.inventory" ] } ] } }, "/location/{merchantLocationKey}/update_location_details": { "post": { "tags": [ "location" ], "description": "Use this call to update non-physical location details for an existing inventory location. Specify the inventory location you want to update using the merchantLocationKey path parameter.
You can update the following text-based fields: name, phone, locationWebUrl, locationInstructions and locationAdditionalInformation. Whatever text is passed in for these fields in an updateInventoryLocation call will replace the current text strings defined for these fields. For store inventory locations, the operating hours and/or the special hours can also be updated.
The merchant location key, the physical location of the store, and its geo-location coordinates can not be updated with an updateInventoryLocation call
Unless one or more errors and/or warnings occurs with the call, there is no response payload for this call. A successful call will return an HTTP status value of 204 No Content.
", "operationId": "updateInventoryLocation", "parameters": [ { "name": "merchantLocationKey", "in": "path", "description": "This path parameter specifies the unique merchant-defined key (ID) for an inventory location that is to be updated.US
represents the United States, and DE
represents Germany. For implementation help, refer to eBay API documentation"
},
"county": {
"type": "string",
"description": "The county in which the address resides.true
.true
.true
to enable Best Offer feature.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. "compatibilityProperties" : [
{
"name" : "make",
"value" : "Subaru"
},
{
"name" : "model",
"value" : "GL"
},
{
"name" : "year",
"value" : "1983"
},
{
"name" : "trim",
"value" : "Base Wagon 4-Door"
},
{
"name" : "engine",
"value" : "1.8L Turbocharged"
}
]
Important! The productFamilyProperties container is deprecated and should no longer be used. The compatibilityProperties container should be used instead.
policy_types
to:PRODUCT_COMPLIANCE
for product compliance policiesTAKE_BACK
for takeback policiescustom_policy_id = customPolicyId
\"dimensions\": {
\"length\": 21.5,
\"width\": 15.0,
\"height\": 12.0,
\"unit\": \"INCH\"
}
"
},
"length": {
"type": "number",
"description": "The actual length (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified. \"dimensions\": {
\"length\": 21.5,
\"width\": 15.0,
\"height\": 12.0,
\"unit\": \"INCH\"
}
"
},
"unit": {
"type": "string",
"description": "The unit of measurement used to specify the dimensions of a shipping package. All fields of the dimensions container are required if package dimensions are specified. If the English system of measurement is being used, the applicable values for dimension units are FEET
and INCH
. If the metric system of measurement is being used, the applicable values for weight units are METER
and CENTIMETER
. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation"
},
"width": {
"type": "number",
"description": "The actual width (in the measurement unit specified in the unit field) of the shipping package. All fields of the dimensions container are required if package dimensions are specified.\"dimensions\": {
\"length\": 21.5,
\"width\": 15.0,
\"height\": 12.0,
\"unit\": \"INCH\"
}
"
}
},
"description": "This type is used to specify the dimensions (and the unit used to measure those dimensions) of a shipping package. The dimensions container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost. See the Calculated shipping help page for more information on calculated shipping."
},
"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. 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.GTC
. The GTC (Good 'Til Cancelled) listings are automatically renewed each calendar month until the seller decides to end the listing.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.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.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
. 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
. 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.GTC
, but auction listings support different listing durations.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.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.\"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.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.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. 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. 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.
GTC
, but auction listings support different listing durations.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.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. \"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.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."
},
"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
.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)."
},
"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
.0.0
.",
"items": {
"$ref": "#/components/schemas/FeeSummary"
}
}
},
"description": "This type is used by the base response payload for the getListingFees call. "
},
"FormatAllocation": {
"type": "object",
"properties": {
"auction": {
"type": "integer",
"description": "This integer value indicates the quantity of the inventory item that is reserved for the published auction format offers of the SKU.",
"format": "int32"
},
"fixedPrice": {
"type": "integer",
"description": "This integer value indicates the quantity of the inventory item that is available for the fixed-price offers of the SKU.",
"format": "int32"
}
},
"description": "This type is used to indicate the quantities of the inventory items that are reserved for the different listing formats of the SKU offers."
},
"GeoCoordinates": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"description": "The latitude (North-South) component of the geographic coordinate. This field is required if a geoCoordinates container is used. 20:00:00
. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store. 09:00:00
. This field is conditionally required if the intervals container is used to specify working hours or special hours for a store. hh:mm:ss
."
},
"InventoryItem": {
"type": "object",
"properties": {
"availability": {
"description": "This container is used to specify the quantity of the inventory item that are available for purchase. MANUFACTURER_REFURBISHED
value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED
enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED
from this point forward. For the time being, if the MANUFACTURER_REFURBISHED
enum is used in a createOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED
. In the future, the MANUFACTURER_REFURBISHED
may start triggering an error if used.2500
('Seller Refurbished') can no longer be used in the Cell Phones & Smartphones category (category ID 9355
) for the following marketplaces: US, Canada, UK, Germany, and Australia. The 'Seller Refurbished' item condition will be replaced by one of three new refurbished values:2010
('Excellent - Refurbished')2020
('Very Good - Refurbished')2030
('Good - Refurbished')9355
, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in category 9355
will be blocked if they try to create a new listing or revise an existing listing with any of these three new item conditions. Any active listings in category 9355
that had condition ID 2500
('Seller Refurbished') as the item condition should have been administratively ended by eBay. Sellers will have to relist these items, and until they are eligible to list with the new refurbished item conditions, they will need to use another item condition supported in category 9355
, such as condition ID 3000
('Used').Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
NEW
, LIKE_NEW
, NEW_OTHER
, or NEW_WITH_DEFECTS
.Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
brand
, mpn
, upc
, ean
, isbn
) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails
. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable. \"aspects\": {
\"pattern\": [\"solid\"],
\"sleeves\": [\"short\"]
}
This container is always returned if one or more offers associated with the inventory item group have been published, and is only returned if set for an inventory item group if that group has yet to have any offers published.Color
, a link should be included to an image demonstrating each available color in the group.0
and it will be 'grayed out' in the View Item page.Color
and Size
would both be values in the specifications.name fields, and the available colors and sizes would be values under the corresponding specifications.values array. If the seller will be including multiple images in the listing that will demonstrate how each variation differs, that seller will also include the aspectsImageVariesBy field, and call out the product aspect where the listing images differ. In the t-shirts example, this product aspect would be Color
, and the seller could either include URLs to images of the t-shirt (in available colors) through the inventory item group entity, or the seller could also included URLs to images of the t-shirt through the individual inventory item entities of the group.MANUFACTURER_REFURBISHED
value is no longer applicable, and should not be used. With Version 1.13.0, the CERTIFIED_REFURBISHED
enumeration value has been introduced, and CR-eligible sellers should make a note to start using CERTIFIED_REFURBISHED
from this point forward. For the time being, if the MANUFACTURER_REFURBISHED
enum is used for any of the SKUs in a bulkCreateOrReplaceInventoryItem method, it will be accepted but automatically converted by eBay to CERTIFIED_REFURBISHED
. Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
NEW
, LIKE_NEW
, NEW_OTHER
, or NEW_WITH_DEFECTS
.Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
brand
, mpn
, upc
, ean
, isbn
) in the localizedAspectName fields, and then look for the correspondinng aspectRequired boolean fields as well as the corresponding aspectUsage field, which will indicate if the aspect is required, recommended, or optional. In some cases, a product identifier type may be required, but not known/applicable for a product. If this is the case, the seller must still include the corresponding field in the inventory item record, but pass in a default text string. This text string can vary by site, so the seller should use the GeteBayDetails call of the Trading API to get this string value. In the GeteBayDetails call, the seller should include a DetailName field with its value set to ProductDetails
. In the response of the call, the seller can see the default string value in the ProductDetails.ProductIdentifierUnavailableText field. The seller will use this value in one or more of the product identifier fields (ean, isbn, upc, or mpn) if a product ID isn't known or applicable. MANUFACTURER_REFURBISHED
value has essentially been replaced with the CERTIFIED_REFURBISHED
enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED
set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED
, so it is not necessary for the developer to update these inventory items with a 'create or replace' call. Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
MANUFACTURER_REFURBISHED
value has essentially been replaced with the CERTIFIED_REFURBISHED
enumeration value with Version 1.13.0. For any existing inventory items that have MANUFACTURER_REFURBISHED
set as their condition value, eBay will automatically convert the condition of these inventory items to CERTIFIED_REFURBISHED
, so it is not necessary for the developer to update these inventory items with a 'create or replace' call. Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs. See the conditionDescriptors field description for more information.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
Important!For trading card listings in Non-Sport Trading Card Singles (183050), CCG Individual Cards (183454), and Sports Trading Card Singles (261328) categories, LIKE_NEW (2750) can be used to specify the card as a Graded card and USED_VERY_GOOD (4000) can be used to specify the card as an Ungraded card. If either of these item conditions are used for the affected categories, the seller is then required to use the conditionDescriptors array to provide one or more applicable Condition Descriptor name-value pairs.
Beginning October 23, 2023, trading card listings in the affected categories must use either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition, and no other item conditions will be accepted. These item conditions and the conditionDescriptors array will be required for all new listings. If not provided after this date, the publishOffer, bulkPublishOffer, and publishOfferByInventoryItemGroup methods will fail when trying to create new listings.
By January 22 2024, all existing listings must be modified with either LIKE_NEW (2750) or USED_VERY_GOOD (4000) item condition and applicable conditionDescriptors name-value pairs. The updateOffer method will fail if the inventory item object does not have one of these two item conditions along with applicable conditionDescriptors name-value pairs.
STORE
.WAREHOUSE
. See StoreTypeEnum for the supported values.STORE
.WAREHOUSE
if a location type is not specified when a merchant creates an inventory location.",
"items": {
"type": "string",
"description": " For implementation help, refer to eBay API documentation"
}
},
"locationWebUrl": {
"type": "string",
"description": "This text field shows the Website address (URL) associated with the inventory location. This field is returned if defined for the inventory location. 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." }, "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 totrue
, and the seller also has the option of setting 'auto-accept' and 'auto-decline' price thresholds.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.DOMESTIC
to override a domestic shipping service option, or to INTERNATIONAL
to override an international shipping service option.Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0
.
0
.",
"format": "int32"
},
"locations": {
"type": "array",
"description": "An array of one or more of the merchant's inventory locations.",
"items": {
"$ref": "#/components/schemas/InventoryLocationResponse"
}
}
},
"description": "This type is used by the base response payload for the getInventoryLocations call."
},
"MigrateListing": {
"type": "object",
"properties": {
"listingId": {
"type": "string",
"description": "The unique identifier of the eBay listing to migrate to the new Inventory model. In the Trading API, this field is known as the ItemID.EBAY_US
. For implementation help, refer to eBay API documentation"
},
"statusCode": {
"type": "integer",
"description": "This field is returned for each listing that the seller attempted to migrate. See the HTTP status codes table to see which each status code indicates.",
"format": "int32"
},
"warnings": {
"type": "array",
"description": "If one or more warnings occur with the attempt to migrate the listing, this container will be returned with detailed information on each warning. It is possible that a listing can be successfully migrated even if a warning occurs.",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "This type is used to display the results of each listing that the seller attempted to migrate."
},
"NameValueList": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This string value identifies the motor vehicle aspect, such as 'make', 'model', 'year', 'trim', and 'engine'. Typically, the make, model, and year of the motor vehicle are always required, with the trim and engine being necessary sometimes, but it will be dependent on the part or accessory, and on the vehicle class.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.
" }, "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." }, "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 be200
. 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."
},
"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.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. 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."
},
"OperatingHours": {
"type": "object",
"properties": {
"dayOfWeekEnum": {
"type": "string",
"description": "A dayOfWeekEnum value is required for each day of the week that the store location has regular operating hours. true
indicates that the package is irregular and cannot go through the stamping machine at the shipping service office. This field applies to calculated shipping only. Irregular packages require special or fragile handling."
},
"weight": {
"description": "This container is used to specify the weight of the shipping package that will be used to ship the inventory item. The weight of a shipping package are needed when calculated shipping is used, or if flat-rate shipping rates are used, but with a weight surcharge.SHIP_TO_STORE
. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.0
, unless the inventory item is out of stock. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.",
"format": "int32"
}
},
"description": "This type is used to specify/indicate the quantity of the inventory item that is available for an In-Store Pickup order at the merchant's physical store (specified by the merchantLocationKey field)."
},
"PriceQuantity": {
"type": "object",
"properties": {
"offers": {
"type": "array",
"description": "This container is needed if the seller is updating the price and/or quantity of one or more published offers, and a successful call will actually update the active eBay listing with the revised price and/or available quantity.200
will appear in this field. A user can view the HTTP status codes section for information on other status codes that may be returned with the bulkUpdatePriceQuantity method.",
"format": "int32"
},
"warnings": {
"type": "array",
"description": "This array will be returned if there were one or more warnings associated with the update to the offer or inventory item record.",
"items": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "This type is used to display the result for each offer and/or inventory item that the seller attempted to update with a bulkUpdatePriceQuantity call. If any errors or warnings occur, the error/warning data is returned at the offer/inventory item level."
},
"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.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.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.\"aspects\": {
\"Brand\": [\"GoPro\"],
\"Storage Type\": [\"Removable\"]
}
Important! The productFamilyProperties container is no longer supported.
Important! The productFamilyProperties container is no longer supported.
Important! The productFamilyProperties container is no longer supported.
Important! The productFamilyProperties container is no longer supported.
Important! The productFamilyProperties container is no longer supported.
0
should not be used as a default value, as it implies the product is not repairable.7.9
and 0.0
are both valid scores5.645
and 2.10
are both invalid scoresDOMESTIC
, 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.[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
2018-08-04T07:09:00.000Z
\"Size\"
and \"Color\"
. Product variation aspects are not required immediately upon creating an inventory item group, but these aspects will be required before a multiple-variation listing containing this inventory item group is published. For each product variation aspect that is specified through the specifications container, one name value is required and two or more variations of this aspect are required through the values array.\"specifications\": [{
\"name\": \"Size\",
\"values\": [\"Small\",
\"Medium\",
\"Large\"]
},
{
\"name\": \"Color\",
\"values\": [\"Blue\",
\"White\",
\"Red\"]
}]
Note: Each member of the inventory item group should have these same aspect names, and each individual inventory item should have each variation of the product aspect values specified through the product.aspects container when the inventory item is created with the createOrReplaceInventoryItem or bulkCreateOrReplaceInventoryItem call. true
, the seller's account-level sales-tax table will be used to calculate sales tax for an order.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:
thirdPartyTaxCategory
value is used, applyTax
must also be set to true
.WASTE_RECYCLING_FEE
. If this field is used, the applyTax field must also be used and set to true
BUSINESS_DAY
. For implementation help, refer to eBay API documentation"
},
"value": {
"type": "integer",
"description": "The integer value in this field, along with the time unit in the unit field, will indicate the fulfillment time.4
, and the value of the unit field is BUSINESS_DAY
, then the estimated delivery date after purchase is 4 business days.",
"format": "int32"
}
},
"description": "This type is used to indicate the fulfillment time for an In-Store Pickup order, or for an order than will be shipped to the buyer."
},
"VariesBy": {
"type": "object",
"properties": {
"aspectsImageVariesBy": {
"type": "array",
"description": "This container is used if the seller wants to include multiple images to demonstrate how variations within a multiple-variation listing differ. In this string field, the seller will specify the product aspect where the variations of the inventory item group vary, such as color. If Color
is specified in this field, Color
must also be one of the specifications.name values, and all available colors must appear in the corresponding specifications.values array.Color
and Size
are in this specifications container, each inventory item of the group should also have Color
and Size
as aspect names in their inventory item records.POUND
and OUNCE
. If the metric system of measurement is being used, the applicable values for weight units are KILOGRAM
and GRAM
. The metric system is used by most countries outside of the US. For implementation help, refer to eBay API documentation"
},
"value": {
"type": "number",
"description": "The actual weight (in the measurement unit specified in the unit field) of the shipping package. Both the unit and value fields are required if the weight container is used. If a shipping package weighed 20.5 ounces, the container would look as follows: \"weight\": {" } }, "description": "This type is used to specify the weight (and the unit used to measure that weight) of a shipping package. The weight container is conditionally required if the seller will be offering calculated shipping rates to determine shipping cost, or is using flat-rate costs, but charging a weight surcharge. See the Calculated shipping help page for more information on calculated shipping." }, "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.
\"value\": 20.5,
\"unit\": \"OUNCE\"
}