GET/inventory_item_group/{inventoryItemGroupKey}
This call retrieves the inventory item group for a given inventoryItemGroupKey value. The inventoryItemGroupKey value is passed in at the end of the call URI.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
URI parameters
Parameter | Type | Description |
---|---|---|
inventoryItemGroupKey | string | This path parameter specifies the unique identifier of the inventory item group being retrieved. This value is assigned by the seller when an inventory item group is created. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization
HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory.readonly
https://api.ebay.com/oauth/api_scope/sell.inventory
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
Output container/field | Type | Description |
---|---|---|
aspects | string | This is a collection of item specifics (aka product aspects) name-value pairs that are shared by all product variations within the inventory item group. Common aspects for the inventory item group are not immediately required upon creating an inventory item group, but these aspects will be required before the first offer of the group is published. Common aspects for a men's t-shirt might be pattern and sleeve length. Below is an example of the proper JSON syntax to use when manually inputting item specifics. Note that one item specific name, such as 'Features', can have more than one value. If an item specific name has more than one value, each value is delimited with a comma. 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.Important!Publish offer note: This field is required before an offer can be published to create an active listing. Occurrence: Conditional |
description | string | The description of the inventory item group. This description should fully describe the product and the variations of the product that are available in the inventory item group, since this description will ultimately become the listing description once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Max Length: 500000 (which includes HTML markup/tags) Occurrence: Conditional |
imageUrls | array of string | An array of one or more links to images for the inventory item group. URLs must use the "HTTPS" protocol. 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. Occurrence: Conditional |
inventoryItemGroupKey | string | This is the unique identifier of the inventory item group. This identifier is created by the seller when an inventory item group is created. Occurrence: Always |
subtitle | string | 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. Occurrence: Conditional |
title | string | The title of the inventory item group. This title will ultimately become the listing title once the first offer of the group is published. This field is not initially required when first creating an inventory item group, but will be required before the first offer of the group is published. Important!Publish offer note: This field is required before an offer can be published to create an active listing. Max Length: 80 Occurrence: Conditional |
variantSKUs | array of string | This required container is used to assign individual inventory items to the inventory item group. Multiple SKU values are passed in to this container. If updating an existing inventory item group, the seller should make sure that all member SKU values are passed in, as long as the seller wants that SKU to remain in the group. Occurrence: Always |
variesBy | VariesBy | This container is used to specify product aspects for which variations within an inventory item group vary, and a complete list of all those variances. For example, t-shirts in an inventory item group may be available in multiple sizes and colors. If this is the case, Important!Publish offer note: This container and its child fields (as noted below) are required before an offer can be published to create an active listing. Occurrence: Conditional |
variesBy.aspectsImageVariesBy | array of string | 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 Important!Publish offer note: This array is required and at least one aspect (such as Occurrence: Conditional |
variesBy.specifications | array of Specification | This container consists of an array of one or more product aspects where each variation differs, and values for each of those product aspects. This container is not immediately required, but will be required before the first offer of the inventory item group is published. Important!Publish offer note: This array is required and at least one aspect with the available variations must be specified. Occurrence: Conditional |
variesBy.specifications.name | string | This is the name of product variation aspect. Typically, for clothing, typical aspect names are Important!Publish offer note: This field is required before an offer can be published to create an active listing. Max Length: 40 Occurrence: Conditional |
variesBy.specifications.values | array of string | This is an array of values pertaining to the corresponding product variation aspect (specified in the name field). Below is a sample of how these values will appear under a specifications container: 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. Important!Publish offer note: This array is required and at least one value that matches the corresponding aspect name must be specified. Max Length: 50 Occurrence: Conditional |
videoIds | array of string | An array of one or more videoId values for the inventory item group. A video ID is a unique identifier that is automatically created by eBay when a seller successfully uploads a video to eBay using the uploadVideo method of the Media API. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
Status | Meaning |
---|---|
200 | Success |
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
Code | Domain | Category | Meaning |
---|---|---|---|
25001 | API_INVENTORY | APPLICATION | A system error has occurred. {additionalInfo} |
25705 | API_INVENTORY | REQUEST | The Inventory Item Group named {inventoryItemGroupKey} could not be found or is not available in the system. |
25709 | API_INVENTORY | REQUEST | Invalid value for {fieldName}. {additionalInfo} |
25710 | API_INVENTORY | REQUEST | We didn't find the resource/entity you are requesting. Please verify the request |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieving an Inventory Item Group
This call will retrieve a specific inventory item group for the seller's acount.
Input
The inventoryItemGroupKey value associated with the inventory item group to retrieve is input into the end of the call URI. In this case, the inventoryItemGroupKey value for the inventory item group is Mens_Solid_Polo_Shirts
.
GEThttps://api.ebay.com/sell/inventory/inventory_item_group/M********s
Output
This particular inventory item group is composed of men's solid polo shirts in five different colors and four different sizes. The common product aspects that each inventory item of the group shares is the pattern and the sleeve size, as specified in the aspects container. The full list of inventory items that is part of this group is specified through the variantSKUs container. The particular aspect where images of the shirt variations will vary is stated in the aspectsImageVariesBy container. In this particular case, an image of a shirt in each available color will be part of the listing. The available colors (and sizes) of the shirts are specified under the specifications container.