Jump to

• Request
• Response

Update a product relationship on a product group

patch

/crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}

Request

Path Parameters

• ProdGroupId(required): integer(int64)
  The unique identifier of the product group.
• ProdGroupItemsId(required): integer(int64)
  The unique identifier of the membership of the product group item.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• DisplayOrderNum: integer (int64)
  Title: Display Sequence

  Manually set display order for items in a product group.
• EligibilityRules: array EligibilityRules
  Title: EligibilityRules

  The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.
• EndDate: string (date-time)
  Title: Effective to Date

  The date after which the item is not active.
• InventoryItemId: integer (int64)
  Title: Inventory Item ID

  The unique identifier of an inventory item.
• InvOrgId: integer (int64)
  The unique identifier of an inventory organization for an item.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• ProdGroupItemsId: integer (int64)
  The unique identifier of the membership of the product group item.
• StartDate: string (date-time)
  Title: Effective from Date

  The date from which the item is active in the group.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the item is active in the group.",
            "format":"date-time",
            "nullable":false
        },
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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-patch-request"
            }
        },
        "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"
            }
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of an inventory organization for an item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of an inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProdGroupItemsId":{
            "type":"integer",
            "description":"The unique identifier of the membership of the product group item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date after which the item is not active.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CountryName: string
  Title: Country

  The name of the country corresponding to each geography identifier.
• EndDate: string (date-time)
  Title: Effective to Date

  The date when the rule ends.
• GeographyCode: string
  Title: Country Code

  Maximum Length: 30

  Default Value: All

  The geography code.
• GeographyId: integer (int64)
  Title: Geography ID

  The unique identifier of the geography of a country.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• InvOrgId: integer (int64)
  Title: Inventory Organization ID

  The unique identifier of the inventory organization.
• ProdGroupId: integer (int64)
  The unique identifier of the product group.
• RuleType: string
  Title: Rule Type

  Maximum Length: 30

  The type of eligibility rule. For example, AVAILABLE or NOTAVAILABLE.
• StartDate: string (date-time)
  Title: Effective from Date

  The date when the rule becomes active.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date when the rule becomes active.",
            "format":"date-time",
            "nullable":false
        },
        "GeographyCode":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"The geography code.",
            "nullable":true,
            "default":"All",
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            }
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GeographyId":{
            "title":"Geography ID",
            "type":"integer",
            "description":"The unique identifier of the geography of a country.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date when the rule ends.",
            "format":"date-time",
            "nullable":false
        }
    }
}

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-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 : 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."
        }
    }
}

Links

EligibilityRules

Operation: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules

Parameters:

• ProdGroupId: $request.path.ProdGroupId
• ProdGroupItemsId: $request.path.ProdGroupItemsId

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.

Back to Top