Jump to

• Request
• Response

Get all product groups

get

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a sales catalog by product group identifier.
    Finder Variables:
    • ProdGrpDetailsId; integer; The unique product group details identifier.
  • ProductGroupIdRowFinder: Finds a sales catalog by product group identifier.
    Finder Variables:
    • ProdGroupId; string; The unique product group identifier.
  • ReferenceNumberRowFinder: Finds a sales catalog by reference number.
    Finder Variables:
    • BindReferenceNumber; string; The unique identifier used for integration with external systems.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AllowSelectionFlag; string; Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y.
  • CreatedBy; string; The user who created the product group record.
  • CreationDate; string; The date and time when the record was created.
  • EndDate; string; The date and time when the product group becomes inactive.
  • InternalName; string; The internal name of the product group.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The session login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the product group record.
  • ModelConfigAttributes; string; The model configurations of the product.
  • ModelFamily; string; The name of the model family associated with the Product Group.
  • ModelLine; string; The name of the model line associated with the Product Group.
  • ModelName; string; The model name of the product group.
  • ObjectVersionNumber; integer; 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; The translated product group description used for runtime display.
  • ProdGroupId; integer; The unique identifier of the product group.
  • ProdGroupName; string; The translated name of the product group used for runtime display.
  • ProdGrpDetailsId; integer; The unique identifier of the product group details.
  • ProductGroupLockedBy; string; The name or ID of the user who locked the product group.
  • ProductGroupLockedDate; string; The date when the product group was locked.
  • ProductGroupLockedFlag; boolean; Indicates whether the product group is locked or not. The default value is true.
  • ProductGroupReferenceNumber; string; The unique identifier used for integration with external systems.
  • StartDate; string; The date and time when the product group becomes active.
  • UsageRootFlag; string; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : setupSalesCatalogs

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object setupSalesCatalogs-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The translated name of the product group used for runtime display.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttachments-item-response"
            },
            "x-cardinality":"1"
        },
        "ModelConfigAttributes":{
            "title":"Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configurations of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The translated product group description used for runtime display.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelLine":{
            "title":"Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model line associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "InternalName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupLockedBy":{
            "type":"string",
            "description":"The name or ID of the user who locked the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date and time when the product group becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the sales catalog can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "IsEditable"
                ]
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ProdGrpDetailsId":{
            "type":"integer",
            "description":"The unique identifier of the product group details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueRoleCode":{
            "title":"Revenue Role",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevenueCategoryCode":{
            "title":"Revenue Category",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "ProductGroupAttributeSetup":{
            "title":"Filter Attributes",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-item-response"
            }
        },
        "ModelFamily":{
            "title":"Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model family associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupLockedDate":{
            "type":"string",
            "description":"The date when the product group was locked.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the product group record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier used for integration with external systems.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProdGrpDetailsId"
                ]
            },
            "x-queryable":true
        },
        "ProductGroupProductSetup":{
            "title":"Products",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the product group record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelName":{
            "title":"Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The model name of the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupSubgroupAdministration":{
            "title":"Subgroups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response"
            }
        },
        "AllowDuplicateContentFlag":{
            "title":"Allow Duplicate Children",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "AllowSelectionFlag":{
            "title":"Allow Selection",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageRootFlag":{
            "title":"Root Catalog",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the product group is active or not. The default value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date and time when the product group becomes inactive.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the sales catalog can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "IsDelete"
                ]
            }
        },
        "ProductGroupLockedFlag":{
            "type":"boolean",
            "description":"Indicates whether the product group is locked or not. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupRelationSetup":{
            "title":"Related Groups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupRelationSetup-item-response"
            }
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attachment entity type.",
            "nullable":true,
            "default":"QSC_PROD_GROUPS_B",
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttachments-item-response"
    },
    "x-cardinality":"1"
}

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

• Array of: object setupSalesCatalogs-ProductGroupAttributeSetup-item-response

{
    "title":"Filter Attributes",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-item-response"
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupProductSetup-item-response

{
    "title":"Products",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-item-response"
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupRelationSetup-item-response

{
    "title":"Related Groups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupRelationSetup-item-response"
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response

{
    "title":"Subgroups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupAttachments-item-response

Type: object

Show Source

• 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
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• 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.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• 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

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the document ID of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of data included in the attachment. For example, a file or a web page.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents of the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"The unique identifier of the value set used for mapping to get the AttrValueText from TranslatableIndependentValueSetValuePVO.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttrName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the product group attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProductGroupAttributeValueSetup":{
            "title":"Filter Attribute Values",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attributes of a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeOptionId":{
            "title":"Option ID",
            "type":"integer",
            "description":"The unique identifier of the product group attribute option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProdGrpAttrId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response

{
    "title":"Filter Attribute Values",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupAttributeSetup-ProductGroupAttributeValueSetup-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for attribute domain.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaxValueNum":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ProdGrpAtvalId":{
            "type":"integer",
            "description":"The unique identifier of the product group attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttrValueText":{
            "title":"Internal Value",
            "maxLength":"150",
            "type":"string",
            "description":"The text corresponding to attribute value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MinValueNum":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum numeric value in a range.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"7"
            },
            "x-queryable":true
        },
        "ValueId":{
            "title":"Value",
            "type":"integer",
            "description":"The unique identifier of the value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttrValueName":{
            "title":"Display",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the attribute value.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupProductSetup-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Product",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of an inventory organization for an item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of an inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The par pgreferenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductNumber":{
            "title":"Product Number",
            "maxLength":"300",
            "type":"string",
            "description":"The name of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupItemsId":{
            "type":"integer",
            "description":"The unique identifier of the membership of the product group item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the item is active in the group. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the item is not active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the item is active in the group.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityRules":{
            "title":"EligibilityRules",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response"
            }
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Manually set display order for items in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response

{
    "title":"EligibilityRules",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupProductSetup-EligibilityRules-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyCode":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"The geography code.",
            "nullable":true,
            "default":"All",
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier of the geography of a country.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CountryName":{
            "title":"Country",
            "type":"string",
            "description":"The name of the country corresponding to each geography identifier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleType":{
            "title":"Rule Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of eligibility rule. For example, AVAILABLE or NOTAVAILABLE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProductNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The product number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date when the rule ends.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date when the rule becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EligibilityRuleId":{
            "type":"integer",
            "description":"The unique identifier corresponding to each eligibility rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupRelationSetup-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the related group relationship is active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayOrderNum":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The manually set display order for related groups in a product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PGDetailsReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The pgdetails referenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParPGReferenceNumber":{
            "title":"Parent Product Group Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The par pgreferenceurations of the product.",
            "nullable":false,
            "x-queryable":true
        },
        "RelProdGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier of the related child product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InternalName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the related group relationship is inactive.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the related group relationship is active. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ProdGroupRelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the product group relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : setupSalesCatalogs-ProductGroupSubgroupAdministration-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProdGroupName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the sub-product group.",
            "nullable":false,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "title":"Model Attributes",
            "maxLength":"4000",
            "type":"string",
            "description":"The model configurations of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the sub-product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ModelLine":{
            "title":"Model Line",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model line associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ProdGroupRelationDescription":{
            "type":"string",
            "description":"The description of the relationship between parent and child product group.",
            "nullable":true,
            "x-queryable":false
        },
        "InternalName":{
            "title":"Name",
            "maxLength":"150",
            "type":"string",
            "description":"The internal name of the product group.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date and time when the product group becomes active.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "GroupAssociationEffectiveToDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date till which the relationship between parent and child product group is effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ProdGrpDetailsId":{
            "type":"integer",
            "description":"The unique identifier of the product group details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueRoleCode":{
            "title":"Revenue Role",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue role associated with the product group. For example, Sales revenue line set or Sales revenue line set member.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevenueCategoryCode":{
            "title":"Revenue Category",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the revenue category associated with the product group. For example, Software, Maintenance, Service, Training, Hardware, or Back Maintenance.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist"
            }
        },
        "ProdGroupRelationshipId":{
            "type":"integer",
            "description":"The unique identifier of the product group relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ModelFamily":{
            "title":"Model Family",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the model family associated with the Product Group.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier used for integration with external systems.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProdGrpDetailsId"
                ]
            },
            "x-queryable":true
        },
        "GroupAssociationActiveStatus":{
            "title":"Active",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the relationship between parent and child product group.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the product group record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelName":{
            "title":"Model",
            "maxLength":"1000",
            "type":"string",
            "description":"The model name of the product group.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowDuplicateContentFlag":{
            "title":"Allow Duplicate Children",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a duplicate product or product group can be allowed in this product group hierarchy. The default value is false.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "AllowSelectionFlag":{
            "title":"Allow Selection",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the product group can be selected. If enabled, the value is Y, else the value is N. The defalt is Y.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupAssociationEffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the relationship between parent and child product group is effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "UsageRootFlag":{
            "title":"Root Catalog",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the product group is active or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":false
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date and time when the product group becomes inactive.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ProdGroupRelationName":{
            "title":"Display",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the relationship between parent and child product group.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BatchKeyText":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupAssociationDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order in which the sub-product group appears in the user interface.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RuntimeRevisionNumber":{
            "type":"integer",
            "description":"The version number used during runtime.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

getPublishProductGroupsStatus

Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/getPublishProductGroupsStatus

This method lets you gets the status of the ESS Job associated to the publish product groups.

lockProductGroup

Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/lockProductGroup

The action locks a product group for editing, and sends the product group identifier in request body.

publishProductGroups

Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/publishProductGroups

The action publishes all product groups.

Back to Top