Update a product relationship on a product group
patch
/crmRestApi/resources/11.13.18.05/productGroupProducts/{ProdGroupItemsId}
Request
Path Parameters
-
ProdGroupItemsId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the item is active in the group. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
Manually set display order for items in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date until which the item is active in the group. -
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 product group item.
-
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the item is active in the group.
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.
Root Schema : productGroupProducts-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the item is active in the group. -
Description: string
Title:
Product
Read Only:true
Maximum Length:240
The description of the product. -
DisplayOrderNum: integer
(int64)
Title:
Display Sequence
Manually set display order for items in a product group. -
EndDate: string
(date-time)
Title:
Effective to Date
The date until which the item is active in the group. -
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 reference number of the parent product group. -
ProdGroupId: integer
(int64)
The unique identifier of the product group.
-
ProdGroupItemsId: integer
(int64)
The unique identifier of the product group item.
-
ProductNumber: string
Title:
Product Number
Read Only:true
Maximum Length:300
The unique alternate identifier of the product. -
StartDate: string
(date-time)
Title:
Effective from Date
The date from which the item is active in the group.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.