Update a product group
patch
/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Request
Path Parameters
-
ProdGroupId(required): integer(int64)
The unique identifier of the product group.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: string
Title:
Active
Maximum Length:1
Default Value:Y
Indicates whether the product group is active or not. The default value is true. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is true. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:QSC_PROD_GROUPS_B
The name of the attachment entity type. -
EndDate: string
(date-time)
Title:
Effective to Date
The date and time when the product group becomes inactive. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configurations of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The model name of the product group. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The translated product group description used for runtime display. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Display
Maximum Length:250
The translated name of the product group used for runtime display. -
ProductGroupAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog. -
ProductGroupAttributeSetup: array
Filter Attributes
Title:
Filter Attributes
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties. -
ProductGroupProductSetup: array
Products
Title:
Products
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management. -
ProductGroupRelationSetup: array
Related Groups
Title:
Related Groups
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource. -
ProductGroupSubgroupAdministration: array
Subgroups
Title:
Subgroups
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built. -
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member. -
StartDate: string
(date-time)
Title:
Effective from Date
The date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog.
Show Source
Nested Schema : Filter Attributes
Type:
array
Title:
Filter Attributes
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management.
Show Source
Nested Schema : Related Groups
Type:
array
Title:
Related Groups
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource.
Show Source
Nested Schema : Subgroups
Type:
array
Title:
Subgroups
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data included in the attachment. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document ID of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents of the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
AttributeOptionId: integer
(int64)
Title:
Option ID
The unique identifier of the product group attribute option. -
AttrName: string
Title:
Display
Maximum Length:250
The name of the product group attribute. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attributes of a product group. -
ProdGroupId(required): integer
(int64)
The unique identifier of the product group.
-
ProdGrpAttrId: integer
(int64)
The unique identifier of the product group attribute value.
-
ProductGroupAttributeValueSetup: array
Filter Attribute Values
Title:
Filter Attribute Values
The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.
Nested Schema : Filter Attribute Values
Type:
array
Title:
Filter Attribute Values
The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttrValueName: string
Title:
Display
Maximum Length:150
The name of the attribute value. -
AttrValueText: string
Title:
Internal Value
Maximum Length:150
The text corresponding to attribute value. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the product's registered price and amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attribute domain. -
MaxValueNum: number
Title:
Maximum Value
The maximum numeric value in a range. -
MinValueNum: number
Title:
Minimum Value
The minimum numeric value in a range. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGrpAtvalId: integer
(int64)
The unique identifier of the product group attribute value.
-
ValueId: integer
(int64)
Title:
Value
The unique identifier of the value.
Nested Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the item is active in the group. The default value is true. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
Manually set display order for items in a product group. -
EligibilityRules: array
EligibilityRules
Title:
EligibilityRules
The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the item is not active. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of an inventory item. -
InvOrgId: integer
(int64)
The unique identifier of an inventory organization for an item.
-
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupItemsId: integer
(int64)
The unique identifier of the membership of the product group item.
-
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the item is active in the group.
Nested Schema : EligibilityRules
Type:
array
Title:
EligibilityRules
The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CountryName: string
Title:
Country
The name of the country corresponding to each geography identifier. -
EndDate: string
(date-time)
Title:
Effective to Date
The date when the rule ends. -
GeographyCode: string
Title:
Country Code
Maximum Length:30
Default Value:All
The geography code. -
GeographyId: integer
(int64)
Title:
Geography ID
The unique identifier of the geography of a country. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
RuleType: string
Title:
Rule Type
Maximum Length:30
The type of eligibility rule. For example, AVAILABLE or NOTAVAILABLE. -
StartDate: string
(date-time)
Title:
Effective from Date
The date when the rule becomes active.
Nested Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the related group relationship is active. The default value is true. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for related groups in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the related group relationship is inactive. -
ProdGroupId: integer
(int64)
The unique identifier of the parent product group.
-
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RelProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the related child product group. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the related group relationship is active.
Nested Schema : schema
Type:
Show Source
object
-
ActiveFlag: string
Title:
Active
Maximum Length:1
Default Value:Y
Indicates whether the product group is active or not. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y. -
BatchKeyText: string
Maximum Length:
50
The transient information about the batch process that is updating denormalization data based on this value in a group. This column is for internal use. -
EndDate: string
(date-time)
Title:
Effective to Date
The date and time when the product group becomes inactive. -
GroupAssociationActiveStatus: string
Title:
Active
Maximum Length:1
Default Value:Y
The status of the relationship between parent and child product group. -
GroupAssociationDisplaySequence: integer
(int64)
Title:
Display Sequence
The display order in which the sub-product group appears in the user interface. -
GroupAssociationEffectiveFromDate: string
(date-time)
Title:
Effective from Date
The date from which the relationship between parent and child product group is effective. -
GroupAssociationEffectiveToDate: string
(date-time)
Title:
Effective to Date
The date till which the relationship between parent and child product group is effective. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configurations of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The model name of the product group. -
ParentProductGroupId: integer
(int64)
The unique identifier of the parent of the product group.
-
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The description of the sub-product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Display
Maximum Length:250
The name of the sub-product group. -
ProdGroupRelationDescription: string
The description of the relationship between parent and child product group.
-
ProdGroupRelationName: string
Title:
Display
Maximum Length:250
The name of the relationship between parent and child product group. -
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member. -
RuntimeRevisionNumber: integer
(int64)
Default Value:
1
The version number used during runtime. -
StartDate: string
(date-time)
Title:
Effective from Date
The date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false. -
UserLastUpdateDate: string
(date-time)
The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : setupSalesCatalogs-item-response
Type:
Show Source
object
-
ActiveFlag: string
Title:
Active
Maximum Length:1
Default Value:Y
Indicates whether the product group is active or not. The default value is true. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is true. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y. -
AttachmentEntityName: string
Maximum Length:
255
Default Value:QSC_PROD_GROUPS_B
The name of the attachment entity type. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product group record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the sales catalog can be deleted. The default value is true. -
EndDate: string
(date-time)
Title:
Effective to Date
The date and time when the product group becomes inactive. -
InternalName: string
Title:
Name
Maximum Length:150
The internal name of the product group. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the product group record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configurations of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The model name of the product group. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The translated product group description used for runtime display. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Display
Maximum Length:250
The translated name of the product group used for runtime display. -
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog. -
ProductGroupAttributeSetup: array
Filter Attributes
Title:
Filter Attributes
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties. -
ProductGroupLockedBy: string
Read Only:
true
The name or ID of the user who locked the product group. -
ProductGroupLockedDate: string
Read Only:
true
The date when the product group was locked. -
ProductGroupLockedFlag: boolean
Read Only:
true
Indicates whether the product group is locked or not. The default value is true. -
ProductGroupProductSetup: array
Products
Title:
Products
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management. -
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The unique identifier used for integration with external systems. -
ProductGroupRelationSetup: array
Related Groups
Title:
Related Groups
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource. -
ProductGroupSubgroupAdministration: array
Subgroups
Title:
Subgroups
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built. -
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member. -
StartDate: string
(date-time)
Title:
Effective from Date
The date and time when the product group becomes active. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the sales catalog can be updated. The default value is true. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog.
Show Source
Nested Schema : Filter Attributes
Type:
array
Title:
Filter Attributes
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties.
Show Source
Nested Schema : Products
Type:
array
Title:
Products
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management.
Show Source
Nested Schema : Related Groups
Type:
array
Title:
Related Groups
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource.
Show Source
Nested Schema : Subgroups
Type:
array
Title:
Subgroups
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : setupSalesCatalogs-ProductGroupAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the picture attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data included in the attachment. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document ID of the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents of the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the picture attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-item-response
Type:
Show Source
object
-
AttributeOptionId: integer
(int64)
Title:
Option ID
The unique identifier of the product group attribute option. -
AttrName: string
Title:
Display
Maximum Length:250
The name of the product group attribute. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attributes of a product group. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGrpAttrId: integer
(int64)
The unique identifier of the product group attribute value.
-
ProductGroupAttributeValueSetup: array
Filter Attribute Values
Title:
Filter Attribute Values
The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute. -
ValueSetId: integer
(int64)
Read Only:
true
The unique identifier of the value set used for mapping to get the AttrValueText from TranslatableIndependentValueSetValuePVO.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Filter Attribute Values
Type:
array
Title:
Filter Attribute Values
The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response
Type:
Show Source
object
-
AttrValueName: string
Title:
Display
Maximum Length:150
The name of the attribute value. -
AttrValueText: string
Title:
Internal Value
Maximum Length:150
The text corresponding to attribute value. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code of the product's registered price and amount. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for attribute domain. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaxValueNum: number
Title:
Maximum Value
The maximum numeric value in a range. -
MinValueNum: number
Title:
Minimum Value
The minimum numeric value in a range. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGrpAtvalId: integer
(int64)
The unique identifier of the product group attribute value.
-
ValueId: integer
(int64)
Title:
Value
The unique identifier of the value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupProductSetup-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the item is active in the group. The default value is true. -
Description: string
Title:
Product
Read Only:true
Maximum Length:240
The description of the item. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
Manually set display order for items in a product group. -
EligibilityRules: array
EligibilityRules
Title:
EligibilityRules
The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the item is not active. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of an inventory item. -
InvOrgId: integer
(int64)
The unique identifier of an inventory organization for an item.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Description
Read Only:true
Maximum Length:4000
The detailed description of the item. -
ParPGReferenceNumber: string
Title:
Parent Product Group Reference Number
Maximum Length:50
The par pgreferenceurations of the product. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupItemsId: integer
(int64)
The unique identifier of the membership of the product group item.
-
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The name of the item. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the item is active in the group.
Nested Schema : EligibilityRules
Type:
array
Title:
EligibilityRules
The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response
Type:
Show Source
object
-
CountryName: string
Title:
Country
The name of the country corresponding to each geography identifier. -
EligibilityRuleId: integer
(int64)
The unique identifier corresponding to each eligibility rule.
-
EndDate: string
(date-time)
Title:
Effective to Date
The date when the rule ends. -
GeographyCode: string
Title:
Country Code
Maximum Length:30
Default Value:All
The geography code. -
GeographyId: integer
(int64)
Title:
Geography ID
The unique identifier of the geography of a country. -
InventoryItemId: integer
(int64)
The unique identifier of the inventory item.
-
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
The unique identifier of the inventory organization. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParPGReferenceNumber: string
Title:
Parent Product Group Reference Number
Maximum Length:50
The alternate reference number. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProductNumber: string
Read Only:
true
Maximum Length:300
The product number. -
RuleType: string
Title:
Rule Type
Maximum Length:30
The type of eligibility rule. For example, AVAILABLE or NOTAVAILABLE. -
StartDate: string
(date-time)
Title:
Effective from Date
The date when the rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupRelationSetup-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the related group relationship is active. The default value is true. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
The manually set display order for related groups in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date after which the related group relationship is inactive. -
InternalName: string
Title:
Name
Read Only:true
Maximum Length:150
The internal name of the product group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParPGReferenceNumber: string
Title:
Parent Product Group Reference Number
Maximum Length:50
The par pgreferenceurations of the product. -
PGDetailsReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The pgdetails referenceurations of the product. -
ProdGroupId: integer
(int64)
The unique identifier of the parent product group.
-
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
RelProdGroupId: integer
(int64)
Title:
Product Group
The unique identifier of the related child product group. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the related group relationship is active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response
Type:
Show Source
object
-
ActiveFlag: string
Title:
Active
Maximum Length:1
Default Value:Y
Indicates whether the product group is active or not. -
AllowDuplicateContentFlag: string
Title:
Allow Duplicate Children
Maximum Length:1
Default Value:Y
Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false. -
AllowSelectionFlag: string
Title:
Allow Selection
Maximum Length:1
Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y. -
BatchKeyText: string
Maximum Length:
50
The transient information about the batch process that is updating denormalization data based on this value in a group. This column is for internal use. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product group record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date-time)
Title:
Effective to Date
The date and time when the product group becomes inactive. -
GroupAssociationActiveStatus: string
Title:
Active
Maximum Length:1
Default Value:Y
The status of the relationship between parent and child product group. -
GroupAssociationDisplaySequence: integer
(int64)
Title:
Display Sequence
The display order in which the sub-product group appears in the user interface. -
GroupAssociationEffectiveFromDate: string
(date-time)
Title:
Effective from Date
The date from which the relationship between parent and child product group is effective. -
GroupAssociationEffectiveToDate: string
(date-time)
Title:
Effective to Date
The date till which the relationship between parent and child product group is effective. -
InternalName: string
Title:
Name
Maximum Length:150
The internal name of the product group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configurations of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The model name of the product group. -
ParentProductGroupId: integer
(int64)
The unique identifier of the parent of the product group.
-
ProdGroupDescription: string
Title:
Description
Maximum Length:1000
The description of the sub-product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupName: string
Title:
Display
Maximum Length:250
The name of the sub-product group. -
ProdGroupRelationDescription: string
The description of the relationship between parent and child product group.
-
ProdGroupRelationName: string
Title:
Display
Maximum Length:250
The name of the relationship between parent and child product group. -
ProdGroupRelationshipId: integer
(int64)
The unique identifier of the product group relationship.
-
ProdGrpDetailsId: integer
(int64)
The unique identifier of the product group details.
-
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
The unique identifier used for integration with external systems. -
RevenueCategoryCode: string
Title:
Revenue Category
Maximum Length:30
The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance. -
RevenueRoleCode: string
Title:
Revenue Role
Maximum Length:30
The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member. -
RuntimeRevisionNumber: integer
(int64)
Default Value:
1
The version number used during runtime. -
StartDate: string
(date-time)
Title:
Effective from Date
The date and time when the product group becomes active. -
UsageRootFlag: string
Title:
Root Catalog
Maximum Length:1
Default Value:N
Indicates whether the product group can be assigned and displayed as a root product group in the context of an application usage type. The default value is false. -
UserLastUpdateDate: string
(date-time)
The date and time when the row was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- LookupPVOForRevenueCategoryCode
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DMOO_REVN_CATEGORY
The list of values displayed for Revenue Category Code in setup sales catalogs.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueCategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LookupPVOForRevenueRoleCode
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DMOO_REVENUE_ROLE
The list of values displayed for revenue role code in setup sales catalogs.
The following properties are defined on the LOV link relation:- Source Attribute: RevenueRoleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ProductGroupAttachments
-
Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachmentsParameters:
- ProdGroupId:
$request.path.ProdGroupId
The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog. - ProdGroupId:
- ProductGroupAttributeSetup
-
Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetupParameters:
- ProdGroupId:
$request.path.ProdGroupId
The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties. - ProdGroupId:
- ProductGroupProductSetup
-
Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetupParameters:
- ProdGroupId:
$request.path.ProdGroupId
The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management. - ProdGroupId:
- ProductGroupRelationSetup
-
Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetupParameters:
- ProdGroupId:
$request.path.ProdGroupId
The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource. - ProdGroupId:
- ProductGroupSubgroupAdministration
-
Parameters:
- ProdGroupId:
$request.path.ProdGroupId
The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built. - ProdGroupId:
- unlockProductGroup
-
Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/action/unlockProductGroupParameters:
- ProdGroupId:
$request.path.ProdGroupId
The action releases the lock on a product group resource item. - ProdGroupId: