This doc page has moved! You should be automatically redirected to the resources page for the eBay Inventory API. If you are not redirected automatically, follow this link to the Inventory API.

eBay Inventory APIVersion 1.1.0

Create or Replace Inventory Item

PUT /inventory_item/{sku}

This call creates a new inventory item record or replaces an existing inventory item record. It is up to sellers whether they want to create a complete inventory item record right from the start, or sellers can provide only some information with the initial Create or Replace Inventory Item call, and then make one or more additional Create or Replace Inventory Item calls to complete the inventory item record. Upon first creating an inventory item record, only the SKU value in the call path is required.

In the case of replacing an existing inventory item record, the Create or Replace Inventory Item call will do a complete replacement of the existing inventory item record, 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 Inventory Item call to retrieve the full inventory item record and see all of its current values/settings before attempting to update the record. And if changes are made to an inventory item that is part of one or more active eBay listings, a successful call will automatically update these eBay listings.

The key information that is set with the Create or Replace Inventory Item call include:

In addition to the authorization header, which is required for all eBay REST API calls, the following table includes another request header that is mandatory for the Create Or Replace Inventory Item call, and another request header that is optional:


Header Description Required? Applicable Values
Content-Language Use this header to control the language that is used for any returned errors or warnings in the call response. Yes en-US
Content-Type The MIME type of the body of the request. Must be JSON. No application/json


Input

See also Samples.

Resource URI (production)

PUT https://api.ebay.com/sell/inventory/v1/inventory_item/{sku}

URI parameters

Parameter Type Required? Meaning
sku string Required The seller-defined SKU value for the inventory item is required whether the seller is creating a new inventory item, or updating an existing inventory item. This SKU value is passed in at the end of the call URI. SKU values must be unique across the seller's inventory.

Max length: 50.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

This request requires a user access token with the following scope:

https://api.ebay.com/oauth/api_scope/sell.inventory

See Getting Access Tokens for more information.



Payload model

The following lists all fields that could be included in the request.

{ /* InventoryItem */
"availability":
    { /* Availability */
    "pickupAtLocationAvailability": [
        { /* PickupAtLocationAvailability */
        "availabilityType": string,
        "fulfillmentTime":
            { /* TimeDuration */
            "unit": string,
            "value": integer
            },
        "merchantLocationKey": string,
        "quantity": integer
        }
        /* More PickupAtLocationAvailability nodes here */
      ],
    "shipToLocationAvailability":
        { /* ShipToLocationAvailability */
        "quantity": integer
        }
    },
"condition": string,
"conditionDescription": string,
"packageWeightAndSize":
    { /* PackageWeightAndSize */
    "dimensions":
        { /* Dimension */
        "height": number,
        "length": number,
        "unit": string,
        "width": number
        },
    "packageType": string,
    "weight":
        { /* Weight */
        "unit": string,
        "value": number
        }
    },
"product":
    { /* Product */
    "aspects": [
        string
        /* More string nodes here */
      ],
    "brand": string,
    "description": string,
    "ean": [
        string
        /* More string nodes here */
      ],
    "imageUrls": [
        string
        /* More string nodes here */
      ],
    "isbn": [
        string
        /* More string nodes here */
      ],
    "mpn": string,
    "subtitle": string,
    "title": string,
    "upc": [
        string
        /* More string nodes here */
      ]
    }
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
availability Availability Conditional This container is used to specify the quantity of the inventory item that are available for purchase.

This container is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required. Availability data must also be passed if an inventory item is being updated and availability data already exists for that inventory item.

Since an inventory item must have specified quantity before being published in an offer, this container is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.
availability
  .pickupAtLocationAvailability
array of PickupAtLocationAvailability Optional This container consists of an array of one or more of the merchant's physical store locations where the inventory item is available for In-Store Pickup orders. The merchant's location, the quantity available, and the fulfillment time (how soon the item will be ready for pickup after the order takes place) are all in this container. In-Store Pickup is only available to large merchants selling on the US, UK, Germany, and Australia sites.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.
availability
  .pickupAtLocationAvailability
  .availabilityType
string Conditional The enumeration value in this field indicates the availability status of the inventory item at the merchant's physical store specified by the pickupAtLocationAvailability.merchantLocationKey field. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

See AvailabilityTypeEnum for more information about how/when you use each enumeration value.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.

Applicable values are from AvailabilityTypeEnum:

IN_STOCK
This enumeration value indicates that the inventory item has quantity available for purchase at the merchant's store indicated in the pickupAtLocationAvailability.merchantLocationKey field. The quantity available for purchase is shown in the pickupAtLocationAvailability.quantity field. If the product is "In Stock", the corresponding pickupAtLocationAvailability.Quantity value should be an integer value greater than 0.
OUT_OF_STOCK
This enumeration value indicates that the inventory item is out of stock at the merchant's store indicated in the pickupAtLocationAvailability.merchantLocationKey field. If the product is "Out of Stock", the corresponding pickupAtLocationAvailability.Quantity value should be 0.
SHIP_TO_STORE
This enumeration value indicates that the merchant's store (indicated in the pickupAtLocationAvailability.merchantLocationKey field) is temporarily out of stock of the product, but some inventory of the product is being shipped from a warehouse to that store. The quantity being shipped is shown in the pickupAtLocationAvailability.quantity field, and this value should be an integer value greater than 0.
availability
  .pickupAtLocationAvailability
  .fulfillmentTime
TimeDuration Conditional This container is used to indicate how soon an In-Store Pickup order will be available for pickup by the buyer after the order takes place. This container is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.
availability
  .pickupAtLocationAvailability
  .fulfillmentTime.unit
string Conditional This enumeration value indicates the time unit used to specify the fulfillment time, such as HOUR.

Applicable values are from TimeDurationUnitEnum:See unit.
availability
  .pickupAtLocationAvailability
  .fulfillmentTime.value
integer Conditional The integer value in this field, along with the time unit in the unit field, will indicate how soon after an In-Store Pickup purchase can the buyer pick up the item at the designated store location. If the value of this field is 4, and the value of the unit field is HOUR, then the fulfillment time for the In-Store Pickup order is four hours, which means that the buyer will be able to pick up the item at the store four hours after the transaction took place.
availability
  .pickupAtLocationAvailability
  .merchantLocationKey
string Conditional The unique identifier of a merchant's store where the In-Store Pickup inventory item is currently located, or where inventory will be sent to. If the merchant's store is currently awaiting for inventory, the availabilityType value should be SHIP_TO_STORE. This field is required if the pickupAtLocationAvailability container is used, and is always returned with the pickupAtLocationAvailability container.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.
Max length: 36
availability
  .pickupAtLocationAvailability
  .quantity
integer Conditional This integer value indicates the quantity of the inventory item that is available for In-Store Pickup at the store identified by the merchantLocationKey value. The value of quantity should be an integer value greater than 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.

Note: Although the pickupAtLocationAvailability container can be used to load inventory to one or more store locations, eBay listings created with the Inventory API are not yet enabled to support the In-Store Pickup capability.
availability
  .shipToLocationAvailability
ShipToLocationAvailability Optional This container specifies the quantity of the inventory item that are available for purchase across one or more eBay marketplaces.

Note: Although this container is technically optional, until the pickupAtLocationAvailability container and the In-Store Pickup capability is fully enabled, this container will be required before an offer can be created for the inventory item.
availability
  .shipToLocationAvailability
  .quantity
integer Conditional This container is used to set the total 'ship-to-home' quantity of the inventory item that will be available for purchase through one or more published offers. This container is not immediately required, but 'ship-to-home' quantity must be set before an offer of the inventory item can be published.

If an existing inventory item is being updated, and the 'ship-to-home' quantity already exists for the inventory item record, this container should be included again, even if the value is not changing, or the available quantity data will be lost.
condition string Conditional This enumeration value indicates the condition of the inventory item. See ConditionEnum for valid condition values for this field. This field is optional up until the seller is ready to publish an offer with the SKU, at which time it becomes required.

Since the condition of an inventory item must be specified before being published in an offer, this field is always returned in the 'Get' calls for SKUs that are part of a published offer. If a SKU is not part of a published offer, this container will only be returned if set for the inventory item.

Applicable values are from ConditionEnum:See condition.
conditionDescription string Optional This string field is used by the seller to more clearly describe the condition of a used inventory item, or an inventory item whose condition value is not NEW, LIKE_NEW, NEW_OTHER, or NEW_WITH_DEFECTS.

The conditionDescription field is available for all eBay categories. If the conditionDescription field is used with an item in one of the new conditions (mentioned in previous paragraph), eBay will simply ignore this field if included, and eBay will return a warning message to the user.

This field should only be used to further clarify the condition of the used item. It should not be used for branding, promotions, shipping, returns, payment or other information unrelated to the condition of the used item. Make sure that the condition value, condition description, listing description, and the item's pictures do not contradict one another.

This field is not always required, but is required if an inventory item is being updated and a condition description already exists for that inventory item.

This field is returned in the 'Get' calls if a condition description was provided for a used inventory item.
.
Max length: 1000.
packageWeightAndSize PackageWeightAndSize Conditional This container is used if the seller is offering one or more calculated shipping options for the inventory item, or if the seller is offering flat-rate shipping but is including a shipping surcharge based on the item's weight. This container is used to specify the dimensions and weight of a shipping package.

This container is not always required, but is required if an inventory item is being updated and shipping package data already exists for that inventory item.

This container is returned in the 'Get' calls if package type, package weight, and/or package dimensions are specified for an inventory item.
packageWeightAndSize
  .dimensions
Dimension Conditional This container is used to indicate the length, width, and height of the shipping package that will be used to ship the inventory item. The weight and dimensions of a shipping package are needed when calculated shipping is used.

This container will be returned if package dimensions are set for the inventory item.
packageWeightAndSize
  .dimensions.height
number Conditional The actual height (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.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows:
"dimensions": {
"length": 21.5,
"width": 15.0,
"height": 12.0,
"unit": "INCH"
}
packageWeightAndSize
  .dimensions.length
number Conditional 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.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows:
"dimensions": {
"length": 21.5,
"width": 15.0,
"height": 12.0,
"unit": "INCH"
}
packageWeightAndSize
  .dimensions.unit
string Conditional 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.

Applicable values are from LengthUnitOfMeasureEnum:

CENTIMETER
This enumeration value indicates that the dimensions of the shipping package is being measured in centimeters.
FEET
This enumeration value indicates that the dimensions of the shipping package is being measured in feet.
INCH
This enumeration value indicates that the dimensions of the shipping package is being measured in inches.
METER
This enumeration value indicates that the dimensions of the shipping package is being measured in meters.
packageWeightAndSize
  .dimensions.width
number Conditional 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.

If a shipping package measured 21.5 inches in length, 15.0 inches in width, and 12.0 inches in height, the dimensions container would look as follows:
"dimensions": {
"length": 21.5,
"width": 15.0,
"height": 12.0,
"unit": "INCH"
}
packageWeightAndSize
  .packageType
string Conditional This enumeration value indicates the type of shipping package used to ship the inventory item. The supported values for this field can be found in the PackageTypeEnum type.

This field will be returned if package weight/dimensions are set for the inventory item.

Applicable values are from PackageTypeEnum:See packageType.
packageWeightAndSize.weight Weight Conditional 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.
packageWeightAndSize.weight
  .unit
string Conditional The unit of measurement used to specify the weight of a shipping package. Both the unit and value fields are required if the weight container is used. If the English system of measurement is being used, the applicable values for weight units are 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.

Applicable values are from WeightUnitOfMeasureEnum:

GRAM
This enumeration value indicates that the unit of measurement used for measuring the weight of the shipping package is grams.
KILOGRAM
This enumeration value indicates that the unit of measurement used for measuring the weight of the shipping package is kilograms.
OUNCE
This enumeration value indicates that the unit of measurement used for measuring the weight of the shipping package is ounces.
POUND
This enumeration value indicates that the unit of measurement used for measuring the weight of the shipping package is pounds.
packageWeightAndSize.weight
  .value
number Conditional 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": {
"value": 20.5,
"unit": "OUNCE"
}
product Product Conditional This container is used to define the product details, such as a title, a product description, item specifics, and links to images for the product. Optionally, in a Create or Replace Inventory Item call, a seller can pass in a Global Trade Identification Number (GTIN) value such as an EAN, an ISBN, a UPC, or a Brand and Manufacturer Part Number (MPN) pair to identify a product to be matched with a product in the eBay catalog. If a match is found in the eBay product catalog, the inventory item is automatically populated with available product details, such as the title, the product description, item specifics, and a link to the stock image of the product.

This container is not always required, but is required if an inventory item is being updated and product data already exists for that inventory item. And an inventory item must have mandatory product data specified before an offer can be published.

This container is returned in the 'Get' calls if any product details have been defined for the inventory item.
product.aspects array of string Optional This is an array of item specific pairs that provide more information about the product and might make it easier for buyers to find. To view popular/recommended item specifics names (and corresponding values) for a specific eBay category, sellers can use the GetCategorySpecifics call of the Trading API. Alternatively, sellers can view similar items on eBay.com in the same category to get an idea of what other sellers are using for item specifics.

Sellers also have the option of specifying a Global Trade Item Number (GTIN) or Brand/MPN pair through the product container when creating an inventory item, and if a product match is found in the eBay product catalog, item specifics that are defined for the eBay catalog product will automatically get picked up by the newly created/updated inventory item. The item specifics that are picked up with include any GTIN values or Brand/MPN pairs that were passed in.

Below is an example of the proper JSON syntax to use when manually inputting item specifics:
"aspects": {
"Brand": ["GoPro"],
"Storage Type": ["Removable"]
}
Note that inventory items that will become part of an inventory item group and multiple-variation listing should have the same attributes that are defined for the inventory item group.

This container will be returned if one or more item specific pairs are defined for the inventory item.

Max length: 40.
product.brand string Conditional The brand of the product. This field is paired with the MPN field to identify a motor vehicle part or accessory. This field is conditionally required if a Manufacturer Part Number (MPN) value will be used to identify a motor vehicle part or accessory. eBay will search for the motor vehicle part or accessory in the eBay product catalog, and if a match is found, the inventory item is automatically populated with available product details such as a title, a product description, item specifics (including the brand and MPN values), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If a brand was passed in as an item specific name-value pair through the aspects array in a Create or Update Inventory Item call, this value is also picked up by the brand field.

Max length: 65.
product.description string Optional The description of the product. The description of an existing inventory item can be added or modified with a Create or Replace Inventory Item call. The description of an inventory item is automatically populated if the seller specifies a Global Trade Item Number (GTIN) or Brand/MPN pair and a matching product is found in the eBay product catalog.

Note that this field is optional but recommended. If a listingDescription field is omitted when creating and publishing an single-variation offer, the text in this field will be used instead. If neither the product.description field for the inventory item nor the listingDescription field for the offer exist, the Publish Offer call will fail. If the inventory item will be part of an inventory item group/multiple-variation listing, this field should definitely be used to specify how the corresponding product variation is different (e.g. This is the green, extra-large version of the shirt). However, in the case of an inventory item group, the text in the description field of the inventory item group will become the listing description of the actual eBay listing instead of the text in this field.

This field is returned if defined for an inventory item. If one of the GTIN types (e.g. UPC) was passed in when the inventory item was created/modified and a product match was found in the eBay catalog, product description is one of the details that gets picked up from the catalog product.

Max length: 4000.
product.ean array of string Optional The European Article Number/International Article Number (EAN) for the product. This field can be used to identify a product. Based on its specified EAN value, eBay will search for the product in the eBay product catalog, and if a match is found, the inventory item is automatically populated with available product details such as a title, a product description, item specifics (including the specified EAN value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If a EAN was passed in as an item specific name-value pair through the aspects array in a Create or Update Inventory Item call, this value is also picked up by the ean field.
product.imageUrls array of string Conditional An array of one or more links to images for the product. URLs can use the "HTTP" or "HTTPS" protocols. Images can be self-hosted by the seller, or sellers can use the UploadSiteHostedPictures call of the Trading API to upload images to an eBay Picture Server. If successful, the response of the UploadSiteHostedPictures call will contain a full URL to the image on an eBay Picture Server. This is the URL that will be passed in through the imageUrls array. Before an offer can be published, at least one image must exist for the inventory item. Most eBay sites support up to 12 pictures free of charge, and eBay Motors listings can have up to 24 pictures.

A link to a stock image for a product may automatically be populated for an inventory item if the seller specifies a Global Trade Item Number (GTIN) or Brand/MPN pair and a matching product is found in the eBay product catalog.

This container will always be returned for an inventory item that is part of a published offer since a published offer will always have at least one picture, but this container will only be returned if defined for inventory items that are not a part of a published offer.
product.isbn array of string Optional The International Standard Book Number (ISBN) value for the product. This field can be used to identify a product. Based on its specified ISBN value, eBay will search for the product in the eBay product catalog, and if a match is found, the inventory item is automatically populated with available product details such as a title, a product description, item specifics (including the specified ISBN value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If an ISBN was passed in as an item specific name-value pair through the aspects array in a Create or Update Inventory Item call, this value is also picked up by the isbn field.
product.mpn string Conditional The Manufacturer Part Number (MPN) of a motor vehicle part or accessory. This field is paired with the brand field to identify a motor vehicle part or accessory. This field is conditionally required if a Brand value will be used to identify a motor vehicle part or accessory. eBay will search for the motor vehicle part in the eBay product catalog, and if a match is found, the inventory item is automatically populated with available product details such as a title, a product description, item specifics (including the brand and MPN values), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If an MPN was passed in as an item specific name-value pair through the aspects array in a Create or Update Inventory Item call, this value is also picked up by the mpn field.

Max length: 65.
product.subtitle string Optional A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results. An additional listing fee will be charged to the seller if a subtitle is used. For more information on using listing subtitles on the US site, see the Adding a subtitle to your listings help page. The subtitle of an existing inventory item can added, modified, or removed with a Create or Replace Inventory Item call.

Note that the same subtitle text should be used for each inventory item that will be part of an inventory item group, and ultimately become one product variation within a multiple-variation listing.

This field will only be returned if set for an inventory item.

Max length: 55.
product.title string Conditional The title of an existing inventory item can be added or modified with a Create or Replace Inventory Item call. Although not immediately required, a listing title will be needed before an offer with the inventory item is published. The title of an inventory item is automatically populated if the seller specifies a Global Trade Item Number (GTIN) or Brand/MPN pair and a matching product is found in the eBay product catalog. If the inventory item will become part of a single-variation offer, the text in this field will become the actual listing title for the published offer. However, if the inventory item will become part of a multiple-variation offer, the text in title field of the inventory item group entity will actually become the listing title for the published offer instead, although a title can still be provided for the inventory item, and it will actually become the title of the variation.

This field will always be returned for an inventory item that is part of a published offer since a published offer will always have a listing title, but this field will only be returned if defined for inventory items that are not a part of a published offer.

Max length: 80.
product.upc array of string Optional The Universal Product Code (UPC) value for the product. This field can be used to identify a product. Based on its specified UPC value, eBay will search for the product in the eBay product catalog, and if a match is found, the inventory item is automatically populated with available product details such as a title, a product description, item specifics (including the specified UPC value), and a link to any stock image that exists for the catalog product.

This field is returned if defined for an inventory item. If a UPC was passed in as an item specific name-value pair through the aspects array in a Create or Update Inventory Item call, this value is also picked up by the upc field.

Output

See also Samples.

Response headers

Header Meaning
Content-Language This header control the language that is used for any returned errors or warnings in the call response.

HTTP status codes

This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Status Meaning
200 Success
201 Created
204 No Content
400 Bad Request
500 Internal Server Error

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

The following lists all fields that could be included in the response.

{ /* BaseResponse */
"warnings": [
    { /* ErrorDetailV3 */
    "category": string,
    "domain": string,
    "errorId": integer,
    "inputRefIds": [
        string
        /* More string nodes here */
      ],
    "longMessage": string,
    "message": string,
    "outputRefIds": [
        string
        /* More string nodes here */
      ],
    "parameters": [
        { /* ErrorParameterV3 */
        "name": string,
        "value": string
        }
        /* More ErrorParameterV3 nodes here */
      ],
    "subdomain": string
    }
    /* More ErrorDetailV3 nodes here */
  ]
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
warnings array of ErrorDetailV3 Conditionally This container will be returned in a call response payload if one or more warnings or errors are triggered when an Inventory API call is made. This container will contain detailed information about the error or warning.
warnings.category string Conditionally This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.
warnings.domain string Conditionally The name of the domain in which the error or warning occurred.
warnings.errorId integer Conditionally 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.
warnings.inputRefIds array of string Conditionally 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.
warnings.longMessage string Conditionally A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.
warnings.message string Conditionally A description of the condition that caused the error or warning.
warnings.outputRefIds array of string Conditionally 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.
warnings.parameters array of ErrorParameterV3 Conditionally Various warning and error messages return one or more variables that contain contextual information about the error or warning. This is often the field or value that triggered the error or warning.
warnings.parameters.name string Conditionally This is the name of input field that caused an issue with the call request.
warnings.parameters.value string Conditionally This is the actual value that was passed in for the element specified in the name field.
warnings.subdomain string Conditionally The name of the subdomain in which the error or warning occurred.



Error Codes

Code Domain Category Nature Meaning
25001 API_INVENTORY APPLICATION ERROR A system error has occurred. {additionalInfo}
25002 API_INVENTORY REQUEST ERROR A user error has occurred. {additionalInfo}
25003 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid price. {additionalInfo}
25004 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid quantity. {additionalInfo}
25005 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid category ID. {additionalInfo}
25006 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid listing option. {additionalInfo}
25007 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Fulfillment policy. {additionalInfo}
25008 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Payment policy. {additionalInfo}
25009 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid data in the associated Return policy. {additionalInfo}
25011 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid tax information. {additionalInfo}
25012 API_INVENTORY REQUEST ERROR Invalid inventory location. {additionalInfo}
25013 API_INVENTORY REQUEST ERROR Invalid data in the Inventory Item Group. {additionalInfo}
25014 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid pictures. {additionalInfo}
25015 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture URL. {additionalInfo}
25016 API_INVENTORY REQUEST ERROR The {fieldName} value is invalid. {additionalInfo}
25017 API_INVENTORY REQUEST ERROR {fieldName} is missing. {additionalInfo}
25018 API_INVENTORY REQUEST ERROR Incomplete account information. {additionalInfo}
25019 API_INVENTORY REQUEST ERROR Cannot revise listing. {additionalInfo}
25020 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid shipping package details. {additionalInfo}
25021 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid item condition information. {additionalInfo}
25022 API_INVENTORY REQUEST ERROR Invalid attribute. {fieldName}
25023 API_INVENTORY REQUEST ERROR Invalid compatibility information. {additionalInfo}
25025 API_INVENTORY APPLICATION ERROR Concurrent access of the same Inventory or Inventory Item Group object is not allowed. Please try again later.
25026 API_INVENTORY REQUEST ERROR Selling limit exceeded. {additionalInfo}
25401 API_INVENTORY APPLICATION WARNING Invalid listing format removed. {additionalInfo}
25402 API_INVENTORY APPLICATION WARNING System warning. {additionalInfo}
25501 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has an invalid picture. {additionalInfo}
25502 API_INVENTORY REQUEST ERROR Invalid attribute information. {additionalInfo}
25503 API_INVENTORY REQUEST ERROR The eBay listing associated with the inventory item, or the unpublished offer has invalid product information. {additionalInfo}
25504 API_INVENTORY APPLICATION ERROR service {additionalInfo}
25601 API_INVENTORY REQUEST ERROR {fieldName} is an invalid attribute.
25604 API_INVENTORY REQUEST ERROR Input error. {additionalInfo}
25701 API_INVENTORY REQUEST ERROR One or more of the supplied SKU(s) could not be found in the system.
25702 API_INVENTORY REQUEST ERROR {skuValue} could not be found or is not available in the system.
25707 API_INVENTORY REQUEST ERROR This is an invalid value for a SKU. Only alphanumeric characters can be used for SKUs, and their length must not exceed 50 characters.
25708 API_INVENTORY REQUEST ERROR Invalid SKU.
25709 API_INVENTORY REQUEST ERROR Invalid value for {fieldName}
25713 API_INVENTORY REQUEST ERROR This Offer is not available : {additionalInfo}.
25715 API_INVENTORY REQUEST ERROR Invalid values for dimensions and/or weight of shipping package.



Samples

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Creating an Inventory Item

This call creates an inventory item.

Description

This call will create an inventory item for the seller's acount.

Input

The SKU value associated with the inventory item to add is input into the end of the call URI. In this case, the SKU value for the inventory item is GP-Cam-01.

The total ship-to-home quantity for the product is 50.

The condition of the product is NEW and all product details of the inventory item are provided in the product container.

URL format. See also the non-wrapped version of this URL.

PUT https://api.ebay.com/sell/inventory/v1/inventory_item/GP-Cam-01
{ 
"availability":
    { 
    "shipToLocationAvailability":
        { 
        "quantity": 50
        }
    },
"condition": "NEW",
"product":
    { 
    "title": "GoPro Hero4 Helmet Cam",
    "description": "New GoPro Hero4 Helmet Cam. Unopened box.",
    "aspects": {
        "Brand" :["GoPro"],
        "Type" : ["Helmet/Action"],
        "Storage Type" : ["Removable"],
        "Recording Definition" : ["High Definition"],
        "Media Format" : ["Flash Drive (SSD)"],
        "Optical Zoom" : ["10x"]
      },
    "imageUrls": [
        "http://i.ebayimg.com/images/i/182196556219-0-1/s-l1000.jpg",
        "http://i.ebayimg.com/images/i/182196556219-0-1/s-l1001.jpg",
        "http://i.ebayimg.com/images/i/182196556219-0-1/s-l1002.jpg"
      ]
    }
}

Output

Unless one or more errors or warnings occur with this call, there is no output payload with this response. A successful call contains an HTTP status code of 204.

JSON format.



Change History

Change Date Description
1.0.0
2016-10-19
  • Call (added): New call.