Product Groups: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Product Groups resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Product Groups
Child Resource	Attachments
	Filter Attributes
	Filter Attributes > Filter Attributes Values
	Products
	Products > Eligibility Rules
	Related Groups
	Subgroups

The following table lists the attributes required for the POST method for Product Groups resource.

Resource	Attribute	Attribute Description
Product Groups	ProdGroupName	The translated name of the product group used for runtime display.
	ProdGroupDescription	The translated product group description used for runtime display.
	InternalName	The translated product group description used for runtime display.
	StartDate	The date and time when the product group becomes active.
	EndDate	The date and time when the product group becomes inactive.
	ActiveFlag	Indicates whether the product group is active or not.
	AllowDuplicateContentFlag	Indicates whether a duplicate product or product group can be allowed in this product group hierarchy.
	UsageRootFlag	Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type.

The following table lists the attributes required for the POST method for Product Groups child resources.

Resource	Attribute	Attribute Description
Product Groups > Attachments	DatatypeCode	A value that indicates the data type.
	Url	The URL of the attachment.
	CategoryName	The category of the attachment.
	Title	The title of the attachment.
Product Groups > Filter Attributes	AttrName	The name of the product group attribute.
	AttributeOptionId	The unique identifier of the product group attribute option.
	DisplayOrderNum	Manually set display order in which narrow by attributes are displayed at runtime.
Product Groups > Filter Attributes > Filter Attribute Values	AttrValueName	The translation of the attribute value.
	AttrValueText	The text corresponding to attribute value.
	CurrencyCode	The currency code of the product's registered price and amount.
	MaxValueNum	The maximum numeric value in a range.
	MinValueNum	The minimum numeric value in a range.
	ValueId	The unique identifier of the value.
	DisplayOrderNum	The manually set display order for attribute domain.
Product Groups > Products	InventoryItemId	The unique identifier of an inventory item.
	InvOrgId	The unique identifier of an inventory organization for an item.
Product Groups > Products > Eligibility Rules	ProdGroupName	The translated name of the product group used for runtime display.
	ProdGroupDescription	The translated product group description used for runtime display.
	ProductGroupReferenceNumber	The unique identifier used for integration with external systems.
Product Groups > Related Groups	RelProdGroupId	The unique identifier of the related child product group.
Product Groups > Subgroups	ProdGroupName	The name of the sub-product group.
	ProdGroupDescription	The description of the sub-product group.
	InternalName	The internal name of the product group.

The following table lists the path parameters required for the PATCH method for Product Groups resource.

Resources	Path	Path Parameters
Product Groups	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}	ProdGroupId

The following table lists the path parameters required for the PATCH method for Product Groups child resources.

Resources	Path	Path Parameters
Product Groups > Attachments	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}	ProdGroupId ProductGroupAttachmentsUniqID
Product Groups > Filter Attributes	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}	ProdGroupId ProdGrpAttrId
Product Groups > Filter Attribute Values	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}	ProdGroupId ProdGrpAttrId ProdGrpAtvalId
Product Groups > Products	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}	ProdGroupId ProdGroupItemsId
Product Groups > Products > Eligibility Rules	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}	ProdGroupId ProdGroupItemsId EligibilityRuleId
Product Groups > Related Groups	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}	ProdGroupId ProdGroupRelationshipId
Product Groups > Subgroups	/crmRestApi/resources/11.13.18.10/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}	ProdGroupId ProdGroupId2