Update a product item - Not Supported
patch
/crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}
Request
Path Parameters
-
catalogProductItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- ProductGroupDenormId, InventoryItemId and OrganizationId ---for the Catalog Products Items resource and used to uniquely identify an instance of Catalog Products Items. The client should not generate the hash key value. Instead, the client should query on the Catalog Products Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Catalog Products Items.
For example: catalogProductItems?q=ProductGroupDenormId=<value1>;InventoryItemId=<value2>;OrganizationId=<value3>
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
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item. -
CountryCodeForEligibilityCheck: string
The country code for which product eligibility is defined.
-
CurrencyCode: string
The currency code associated with the product like USD or EUR.
-
FilterByTM: string
Maximum Length:
1
The Filter by TM. -
GeographyId: string
The unique identifier of the geography of the product.
-
ItemTranslation: array
Item Translation
Title:
Item Translation
The product item resource is used to view the language code, the translated product group name and description, and the product group ID. -
ListPrice: number
Title:
List Price
The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine. -
OverrideEligYN: string
Maximum Length:
1
Indicate whether the eligibility is overrode. -
UsageCode: string
Maximum Length:
255
The usage code of the product. -
UsageModeCode: string
Maximum Length:
255
The usage mode code of the product. -
YourPrice: number
Title:
Your Price
The your price of the product shown in the catalog.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.
Show Source
Nested Schema : Item Translation
Type:
array
Title:
Item Translation
The product item resource is used to view the language code, the translated product group name and description, and the product group ID.
Show Source
Nested Schema : catalogProductItems-Attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the attachment file. -
DmVersionNumber: string
Maximum Length:
255
The version number of the document. -
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 type of 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 expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attachment file. -
FileUrl: string
Title:
File Url
The file URL of the attachment. -
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 file. -
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 file. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment.
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 : catalogProductItems-item-response
Type:
Show Source
object
-
AttachmentEntityName: string
Read Only:
true
The name of the attachment entity. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item. -
CountryCodeForEligibilityCheck: string
The country code for which product eligibility is defined.
-
CSSEnabled: string
Title:
Enable for Customer Self Service
Read Only:true
Maximum Length:1
Indicated whether CSS is enabled. -
CurrencyCode: string
The currency code associated with the product like USD or EUR.
-
CustomerOrderEnabledFlag: string
Title:
Customer Orders Enabled
Read Only:true
Maximum Length:1
Indicates whether the product can be ordered by customer. -
Depth: integer
(int64)
Read Only:
true
The difference between the level of the first and the last product group in the path. -
Description: string
Title:
Item Description
Read Only:true
Maximum Length:240
The description of the product. -
FilterByTM: string
Maximum Length:
1
The Filter by TM. -
FirstProdGrpId: integer
(int64)
Read Only:
true
The unique identifier of the first product on the list. -
GeographyId: string
The unique identifier of the geography of the product.
-
InventoryItemId: integer
(int64)
Title:
Item Number
Read Only:true
The unique identifier of the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
The inventory item number of the item. -
ItemTranslation: array
Item Translation
Title:
Item Translation
The product item resource is used to view the language code, the translated product group name and description, and the product group ID. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
The long description of the product. -
OrganizationId: integer
(int64)
Title:
Organization
Read Only:true
The unique identifier of the organization. -
OverrideEligYN: string
Maximum Length:
1
Indicate whether the eligibility is overrode. -
ParentProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the parent product group for the penultimate node in the path. -
PathId: integer
(int64)
Read Only:
true
The unique identifier of the path. -
PrimaryUOMCode: string
Title:
Primary UOM
Read Only:true
Maximum Length:3
The code indicating the product unit of measure. -
ProductGroupDenormId: integer
(int64)
Read Only:
true
The unique identifier of the product group denorm. -
ProductGroupId: integer
(int64)
Read Only:
true
The unique identifier of the product group. -
SalesProductType: string
Title:
Sales Product Type
Read Only:true
Maximum Length:30
The type of the sales product. -
ServReqEnabledCode: string
Title:
Service Request
Read Only:true
Maximum Length:30
The code indicating whether server request is enabled. -
UsageCode: string
Maximum Length:
255
The usage code of the product. -
UsageModeCode: string
Maximum Length:
255
The usage mode code of the product. -
YourPrice: number
Title:
Your Price
The your price of the product shown in the catalog.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.
Show Source
Nested Schema : Item Translation
Type:
array
Title:
Item Translation
The product item resource is used to view the language code, the translated product group name and description, and the product group ID.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : catalogProductItems-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The category name of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who created the 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 that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The path of the attachment file. -
DmVersionNumber: string
Maximum Length:
255
The version number of the document. -
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 type of 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 expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The name of the attachment file. -
FileUrl: string
Title:
File Url
The file 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 and time when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the 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 file. -
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 file. -
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 user name of the person who created the attachment.
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.
Nested Schema : catalogProductItems-ItemTranslation-item-response
Type:
Show Source
object
-
Description: string
Title:
Item Description
Read Only:true
Maximum Length:240
The translated description of the item. -
InventoryItemId: integer
(int64)
Title:
Item Number
Read Only:true
The unique identifier of the inventory item. -
ISOLanguage: string
Read Only:
true
Maximum Length:2
The ISO language associated with the product item like English or Danish. -
ISOTerritory: string
Title:
Territory
Read Only:true
Maximum Length:2
The ISO territory associated with the product item. -
Language: string
Read Only:
true
Maximum Length:4
The translation language of the item. -
LanguageCode: string
Title:
Language Code
Read Only:true
Maximum Length:4
The language code associated with the product item like 639-1en (English) or 639-1da (Danish). -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
The long translated description of the item. -
OrganizationId: integer
(int64)
Title:
Organization
Read Only:true
The unique identifier of the organization to which the item belongs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/AttachmentsParameters:
- catalogProductItemsUniqID:
$request.path.catalogProductItemsUniqID
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item. - catalogProductItemsUniqID:
- ItemTranslation
-
Parameters:
- catalogProductItemsUniqID:
$request.path.catalogProductItemsUniqID
The product item resource is used to view the language code, the translated product group name and description, and the product group ID. - catalogProductItemsUniqID: