getInventoryItemGroup
<p><strong>GET</strong> /inventory_item_group/{inventoryItemGroupKey}</p>
<p>此调用检索给定inventoryItemGroupKey值的库存项目组。inventoryItemGroupKey值在调用URI的末尾传递。</p>
<h5>Input</h5>
<h6>Resource URI (production)</h6>
<p><strong>GET</strong> <a href="https://api.ebay.com/sell/inventory/v1/inventory_item_group/{inventoryItemGroupKey">https://api.ebay.com/sell/inventory/v1/inventory_item_group/{inventoryItemGroupKey</a>}</p>
<h6>URI parameters</h6>
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>inventoryItemGroupKey</td>
<td>string</td>
<td>库存物料组的唯一标识符。创建库存物料组时，卖方会分配此值。要检索的库存项目组的inventoryItemGroupKey值在调用URI的末尾传入。发生：必需</td>
</tr>
</tbody>
</table>
<h6>HTTP request headers</h6>
<p>对eBay REST操作发出的所有请求都要求您提供授权 HTTP标头以进行身份验证授权。
此方法具有下面列出的其他请求标头要求。请参阅<a href="http://developer.ebay.com/devzone/rest/ebay-rest/content/rest-request-components.html#HTTP" title="HTTP请求标头">HTTP请求标头</a>- 打开其余请求组件页面以获取详细信息</p>
<table>
<thead>
<tr>
<th>Header</th>
<th>Type</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>Content-Language</td>
<td><a href="https://developer.ebay.com/api-docs/static/simple-types.html" title="string">string</a></td>
<td>此请求标头设置将在请求有效负载的字段值中提供的自然语言。发生：必需</td>
</tr>
</tbody>
</table>
<h6>OAuth范围</h6>
<p>此请求需要使用<a href="https://developer.ebay.com/api-docs/static/oauth-authorization-code-grant.html" title="授权代码授权">授权代码授权</a>流创建的访问令牌，使用以下列表中的一个范围：
<a href="https://api.ebay.com/oauth/api_scope/sell.inventory.readonly">https://api.ebay.com/oauth/api_scope/sell.inventory.readonly</a>
<a href="https://api.ebay.com/oauth/api_scope/sell.inventory">https://api.ebay.com/oauth/api_scope/sell.inventory</a></p>
<p>有关详细信息，请参阅<a href="https://developer.ebay.com/api-docs/static/oauth-tokens.html" title="OAuth访问令牌">OAuth访问令牌</a>。</p>
<h6>Request payload</h6>
<p>This call has no payload.</p>
<h6>Request fields</h6>
<p>This call has no field definitions.</p>
<h5>Output</h5>
<h6>HTTP response headers</h6>
<p>This call has no response headers.</p>
<h6>Response payload</h6>
<pre><code class="language-json">{
"aspects": [
"string"
],
"description": "string",
"inventoryItemGroupKey": "string",
"imageUrls": [
"string"
],
"subtitle": "string",
"title": "string",
"variantSKUs": [
"string"
],
"variesBy": {
"aspectsImageVariesBy": [
"string"
],
"specifications": [
{
"name": "string",
"values": [
"string"
]
}
]
}
}</code></pre>
<h6>Response fields</h6>
<table>
<thead>
<tr>
<th>Output container/field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>aspects</td>
<td>array of string</td>
<td>此容器由一系列方面组成，这些方面由库存项目组中的所有产品变体共享。在创建库存项目组时，不会立即要求库存项目组的常见方面，但在发布组的第一次要约之前，将需要这些方面。男士T恤的常见方面可能是图案和袖长。请参阅下面的示例，了解用于指定常见方面的JSON语法："aspects": {"pattern": ["solid"],"sleeves": ["short"]}如果已发布与库存物料组关联的一个或多个商品，则始终返回此容器，并且仅在库存物料组设置（如果该商品组尚未发布任何商品）时才返回此容器。发生：有条件的</td>
</tr>
<tr>
<td>description</td>
<td>string</td>
<td>库存项目组的说明。此描述应充分描述产品和库存项目组中可用产品的变体，因为一旦发布该组的第一个产品，该描述最终将成为列表描述。首次创建库存项目组时，最初不需要此字段，但在发布组的第一个商品之前将需要此字段。注意：由于此说明最终将成为多变体列表中的列表说明，因此卖方应在为每个变体创建商品时省略listingDescription字段。如果它们包含此listingDescription字段，则此字段中的文本将覆盖此处提供的文本库存物料组的说明字段。如果已发布与库存项目组关联的一个或多个商品，则始终返回此字段，并且仅在库存项目组设置（如果该组尚未发布任何商品）时才返回此字段。最大长度：500000;发生：有条件的</td>
</tr>
<tr>
<td>inventoryItemGroupKey</td>
<td>string</td>
<td>这是库存项目组的唯一标识符。在创建库存物料组时，卖方会创建此标识符。此字段仅适用于getInventoryItemGroup调用，而不适用于createOrReplaceInventoryItemGroup调用。在createOrReplaceInventoryItemGroup调用中，inventoryItemGroupKey值将传递到调用URI的末尾。发生：NA</td>
</tr>
<tr>
<td>imageUrls</td>
<td>array of string</td>
<td>一个或多个指向库存项目组图像的链接的数组。URL必须使用“HTTPS”协议。图像可以由卖家自行托管，或者卖家可以使用Trading API 的UploadSiteHostedPictures调用将图像上传到eBay图片服务器。如果成功，UploadSiteHostedPictures调用的响应将包含eBay图片服务器上图像的完整URL。这是将通过imageUrls数组传递的URL 。在发布任何报价之前，报价必须至少存在一个图像。图像链接可以通过此imageUrls容器传入，也可以通过product.imageUrls传入。在组中创建每个库存项目时的容器。如果varyBy.aspectsImageVariesBy字段用于指定变体变化的主要产品方面，则必须通过此imageUrls容器传递图像的链接，并且每个变体都应该有一张图片。因此，如果varyBy.aspectsImageVariesBy字段设置为Color，则应在图像中包含一个链接，以显示组中的每种可用颜色。大多数eBay网站免费支持多达12张图片，eBay Motors列表最多可支持24张图片。对于具有至少一个已发布商品的库存商品组，将始终返回此容器，因为已发布的商品始终至少有一张图片，但只有在尚未发布任何已发布商品的库存商品项目组定义时，才会返回此容器提供。发生：有条件的</td>
</tr>
<tr>
<td>subtitle</td>
<td>string</td>
<td>字幕是可选的列表功能，允许卖家提供有关产品的更多信息，可能包括可能有助于搜索结果的关键字。如果使用字幕，将向卖家收取额外的上市费用。有关在美国网站上使用列表字幕的详细信息，请参阅向列表帮助页面添加字幕。注意：由于此副标题最终将成为多变体列表中的副标题，因此在创建作为组成员的库存项目时，卖方不应包括字幕字段。如果它们确实在库存项目记录中包含字幕字段，则该字段中的文本将覆盖此副标题中提供的文本已发布组中每个库存项目的字段。仅当为库存项目设置时，才会返回此字段。最大长度：55;发生：有条件的</td>
</tr>
<tr>
<td>title</td>
<td>string</td>
<td>库存项目组的标题。一旦该集团的第一次出价发布，该标题最终将成为列表标题。首次创建库存项目组时，最初不需要此字段，但在发布组的第一个商品之前将需要此字段。注意：由于此标题最终将成为多变量列表中的列表标题，因此卖方应在创建作为该组成员的库存项目时省略标题字段。如果它们确实在库存项目记录中包含标题字段，则该字段中的文本将覆盖此标题字段中为已发布的组中的每个库存项目提供的文本。如果已发布与库存项目组关联的一个或多个商品，则始终返回此字段，并且仅在库存项目组设置（如果该组尚未发布任何商品）时才返回此字段。最大长度：80;发生：有条件的</td>
</tr>
<tr>
<td>variantSKUs</td>
<td>array of string</td>
<td>此必需容器用于将单个库存项目分配到库存项目组。多个SKU值将传递到此容器。如果更新现有库存项目组，卖方应确保传入所有成员SKU值，只要卖方希望该SKU保留在该组中。也可以使用createOrReplaceInventoryItemGroup添加或删除SKU呼叫。如果卖方想要从组中删除SKU，则该卖方将从该容器中省略该SKU值，以从库存项目组和任何已发布的多变量列表中删除该库存项目/ SKU。但是，如果该变体具有该列表的一个或多个销售额，则无法从该组中删除变体。解决方法是将变体的数量设置为，0并在“查看项目”页面中显示为“灰显”。始终返回此容器。发生：必需</td>
</tr>
<tr>
<td>variesBy</td>
<td>VariesBy</td>
<td>此容器用于指定库存项目组中变体的变化的产品方面，以及所有这些差异的完整列表。例如，库存物品组中的T恤可以有多种尺寸和颜色。如果是这种情况，Color并且Size都是specifications.name字段中的值，可用的颜色和大小将是相应的specifications.values数组下的值。如果卖家在列表中包含多个图像，以显示每个变体的差异，那么该卖家还会包含aspectsImageVariesBy字段，并调出列表图片不同的产品方面。在T恤衫的例子中，这个产品方面将是Color并且卖方可以通过库存项目组实体包括T恤图像的URL（可用颜色），或者卖方还可以通过该组的各个库存项目实体包括T恤图像的URL。 。首次创建库存项目组时，最初不需要此容器，但在发布组的第一个商品之前，将需要varyBy.specifications容器。如果已发布与库存物料组关联的一个或多个商品，则始终返回此容器，并且仅在库存物料组设置（如果该商品组尚未发布任何商品）时才返回此容器。发生：有条件的</td>
</tr>
<tr>
<td>variesBy.aspectsImageVariesBy</td>
<td>array of string</td>
<td>如果卖方想要包含多个图像以演示多变量列表中的变体如何不同，则使用此容器。在此字符串字段中，卖方将指定库存项目组的变体（例如颜色）变化的产品方面。如果Color在此字段中指定，则Color还必须是一个specifications.name值，并且所有可用颜色必须出现在相应的specifications.values数组中。如果使用aspectsImageVariesBy容器，则应通过imageUrls指定每个变体的图像的链接 库存项目组的容器，或卖方可以选择将这些链接包括在组中的库存项目的每个库存项目记录中的图像。发生：有条件的</td>
</tr>
<tr>
<td>variesBy.specifications</td>
<td>array of Specification</td>
<td>此容器包含一个或多个产品方面的数组，其中每个变体都有所不同，以及每个产品方面的值。此容器不是立即需要的，但在发布库存项目组的第一个要约之前将需要此容器。如果在aspectsImageVariesBy容器中指定了产品方面，则此产品方面（以及该产品方面的所有变体）必须包含在规范容器中。在发布与库存项目组相关的报价之前，通过规范容器指定的产品方面和值应与通过product.aspects指定的名称 - 值对同步。组中包含的库存物料的容器。例如，如果Color和Size在这个规范的容器中，该组中的每个存货项目也应该有Color，并Size在他们的库存项目记录方面的名称。如果已发布与库存项目组关联的一个或多个商品，则始终会返回此容器。对于尚未发布任何已发布商品的库存商品组，仅在设置时才返回此容器。发生：有条件的</td>
</tr>
<tr>
<td>variesBy.specifications.name</td>
<td>string</td>
<td>这是产品变体方面的名称。通常，对于服装，典型的方面名称是"Size"和"Color"。创建库存项目组时不需要立即进行产品变更方面，但在发布包含此库存项目组的多变量列表之前，将需要这些方面。对于通过规范容器指定的每个产品变体方面，需要一个名称值，并且通过值数组需要此方面的两个或更多变体。注意：当使用创建库存项目时，库存项目组的每个成员应具有通过product.aspects容器指定的相同方面名称。createOrReplaceInventoryItem或bulkCreateOrReplaceInventoryItem调用。最大长度：40;发生：有条件的</td>
</tr>
<tr>
<td>variesBy.specifications.values</td>
<td>array of string</td>
<td>这是与相应的产品变体方面有关的值数组（在名称字段中指定）。以下是这些值在规范容器下的显示方式示例："specifications": [{"name": "Size","values": ["Small","Medium","Large"]},{ "name": "Color","values": ["Blue","White","Red"] }] 注意：清单项目组的每个成员应具有这些相同的方面名称，并且当使用createOrReplaceInventoryItem或bulkCreateOrReplaceInventoryItem调用创建清单项时，每个单独的清单项应具有通过product.aspects容器指定的产品方面值的每个变体。最大长度：50;发生：有条件的</td>
</tr>
</tbody>
</table>
<p><strong>HTTP状态代码</strong>
此调用可以返回以下HTTP状态代码之一。状态代码的概述，请参阅<a href="https://developer.ebay.com/api-docs/static/rest-response-components.html#HTTP" title="HTTP状态代码">HTTP状态代码</a>在使用eBay RESTful API中。</p>
<table>
<thead>
<tr>
<th>状态码</th>
<th>含义</th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功</td>
</tr>
<tr>
<td>400</td>
<td>错误的请求</td>
</tr>
<tr>
<td>404</td>
<td>未找到资源</td>
</tr>
<tr>
<td>500</td>
<td>内部服务器错误</td>
</tr>
</tbody>
</table>
<p><strong>错误代码</strong>
有关错误的更多信息以及其他常见错误的代码，请参阅<a href="https://developer.ebay.com/api-docs/static/handling-error-messages.html" title="处理错误">处理错误</a>。</p>
<table>
<thead>
<tr>
<th>状态码</th>
<th>域</th>
<th>类别</th>
<th>含义</th>
</tr>
</thead>
<tbody>
<tr>
<td>25001</td>
<td>API_INVENTORY</td>
<td>应用</td>
<td>发生了系统错误。{附加信息}</td>
</tr>
<tr>
<td>25709</td>
<td>API_INVENTORY</td>
<td>请求</td>
<td>{fieldName}的值无效</td>
</tr>
<tr>
<td>25713</td>
<td>API_INVENTORY</td>
<td>请求</td>
<td>该提供不可用</td>
</tr>
</tbody>
</table>
<h6>示例</h6>
<p>新的API调用？请参阅<a href="https://developer.ebay.com/api-docs/static/make-a-call.html" title="拨打电话">拨打电话</a>。</p>
<p>注意：这些样本中的标识符（例如订单ID或用户ID）和个人数据可能是匿名的，或者在eBay上可能不再有效。如有必要，请在您的请求中替换当前相关的eBay数据。</p>
<h6>示例1：检索库存物料组</h6>
<p>此调用将检索卖方的帐户的特定库存项目组。</p>
<h6>Input</h6>
<p>与要检索的库存项目组关联 的inventoryItemGroupKey值将输入到调用URI的末尾。在这种情况下，库存项目组的inventoryItemGroupKey值为Mens_Solid_Polo_Shirts。</p>
<p><strong>GET</strong>
<a href="https://api.ebay.com/sell/inventory/inventory_item_group/Mens_Solid_Polo_Shirts">https://api.ebay.com/sell/inventory/inventory_item_group/Mens_Solid_Polo_Shirts</a></p>
<h6>Output</h6>
<p>这个特殊的库存项目组由五种不同颜色和四种不同尺寸的男士实心polo衫组成。组中每个库存项共享的常见产品方面是模式和套管大小，如方面容器中所指定。通过variantSKUs容器指定属于该组的库存项目的完整列表。衬衫变化的图像将有所不同的特定方面在aspectsImageVariesBy容器中说明。在这种特殊情况下，每种可用颜色的衬衫图像将成为列表的一部分。衬衫的可用颜色（和尺寸）在规格容器下指定。</p>
<pre><code class="language-json">{
"inventoryItemGroupKey": "Mens_Solid_Polo_Shirts",
"aspects": {
"pattern": ["solid"],
"sleeves": ["short"]
},
"title": "Men's Solid Polo Shirts",
"description": "Men's solid polo shirts in five colors (Green, Blue, Red, Black, and White), and sizes ranges from small to XL.",
"imageUrls": [
"http://i.ebayimg.com/images/i/152196556219-0-1/s-9005.jpg"
],
"variantSKUs": [
"MSPS-GrS",
"MSPS-GrM",
"MSPS-GrL",
"MSPS-GrXL",
"MSPS-BlS",
"MSPS-BlM",
"MSPS-BlL",
"MSPS-BlXL",
"MSPS-RdS",
"MSPS-RdM",
"MSPS-RdL",
"MSPS-RdXL",
"MSPS-BkS",
"MSPS-BkM",
"MSPS-BkL",
"MSPS-BkXL",
"MSPS-WhS",
"MSPS-WhM",
"MSPS-WhL",
"MSPS-WhXL",
],
"variesBy":
{
"aspectsImageVariesBy": [
"Color"
],
"specifications": [
{
"name": "Color",
"values": [
"Green",
"Blue",
"Red",
"Black",
"White"
]
},
{
"name": "Size",
"values": [
"Small",
"Medium",
"Large",
"Extra-Large"
]
}
]
}
}</code></pre>