eBay · Schema

PublishByInventoryItemGroupRequest

This type is used by the request payload of the publishByInventoryItemGroup call. The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload.

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
inventoryItemGroupKey string This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the publishByIn
marketplaceId string This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The marketplaceId enumeration values are found in MarketplaceEnum
View JSON Schema on GitHub

JSON Schema

ebay-publishbyinventoryitemgrouprequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PublishByInventoryItemGroupRequest",
  "title": "PublishByInventoryItemGroupRequest",
  "type": "object",
  "properties": {
    "inventoryItemGroupKey": {
      "type": "string",
      "description": "This is the unique identifier of the inventory item group. All unpublished offers associated with this inventory item group will be published as a multiple-variation listing if the <strong>publishByInventoryItemGroup</strong> call is successful. The <strong>inventoryItemGroupKey</strong> identifier is automatically generated by eBay once an inventory item group is created.<br><br>To retrieve an <strong>inventoryItemGroupKey</strong> value, you can use the <a href=\"/api-docs/sell/inventory/resources/inventory_item/methods/getInventoryItem \" target=\"_blank\">getInventoryItem</a> method to retrieve an inventory item that is known to be in the inventory item group to publish, and then look for the inventory item group identifier under the <strong>groupIds</strong> container in the response of that call."
    },
    "marketplaceId": {
      "type": "string",
      "description": "This is the unique identifier of the eBay site on which the multiple-variation listing will be published. The <strong>marketplaceId</strong> enumeration values are found in <strong>MarketplaceEnum</strong>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/inventory/types/slr:MarketplaceEnum'>eBay API documentation</a>"
    }
  },
  "description": "This type is used by the request payload of the <strong>publishByInventoryItemGroup</strong> call. The identifier of the inventory item group to publish and the eBay marketplace where the listing will be published is needed in the request payload."
}