Jump to

• Request
• Response

Create a product item - Not Supported

post

/crmRestApi/resources/11.13.18.05/catalogProductItems

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code associated with the product like USD or EUR.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideEligYN":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicate whether the eligibility is overrode.",
            "nullable":true
        },
        "UsageCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The usage code of the product.",
            "nullable":true
        },
        "GeographyId":{
            "type":"string",
            "description":"The unique identifier of the geography of the product.",
            "nullable":true
        },
        "UsageModeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The usage mode code of the product.",
            "nullable":true
        },
        "ItemTranslation":{
            "title":"Item Translation",
            "type":"array",
            "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-post-request"
            }
        },
        "CountryCodeForEligibilityCheck":{
            "type":"string",
            "description":"The country code for which product eligibility is defined.",
            "nullable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine.",
            "nullable":true,
            "x-queryable":false
        },
        "YourPrice":{
            "title":"Your Price",
            "type":"number",
            "description":"The your price of the product shown in the catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-Attachments-item-post-request"
            }
        },
        "FilterByTM":{
            "maxLength":"1",
            "type":"string",
            "description":"The Filter by TM.",
            "nullable":true
        }
    }
}

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

• Array of: object catalogProductItems-Attachments-item-post-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-Attachments-item-post-request"
    }
}

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

• Array of: object catalogProductItems-ItemTranslation-item-post-request

{
    "title":"Item Translation",
    "type":"array",
    "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-post-request"
    }
}

Nested Schema : catalogProductItems-Attachments-item-post-request

Type: object

Show Source

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

  Indicates whether the content repository file is shared.
• 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.

{
    "type":"object",
    "properties":{
        "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 name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment file.",
            "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"
            }
        },
        "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 version number of the document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "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 file 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 content repository file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of 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 path of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : catalogProductItems-ItemTranslation-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : catalogProductItems-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The usage code of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesProductType":{
            "title":"Sales Product Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the sales product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the product.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "type":"string",
            "description":"The unique identifier of the geography of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerOrderEnabledFlag":{
            "title":"Customer Orders Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the product can be ordered by customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ListPrice":{
            "title":"List Price",
            "type":"number",
            "description":"The unitized list price for the product charge, after segment discount. This value is provided by the pricing engine.",
            "nullable":true,
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-Attachments-item-response"
            }
        },
        "Depth":{
            "type":"integer",
            "description":"The difference between the level of the first and the last product group in the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PathId":{
            "type":"integer",
            "description":"The unique identifier of the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "type":"string",
            "description":"The currency code associated with the product like USD or EUR.",
            "nullable":true,
            "x-queryable":false
        },
        "OverrideEligYN":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicate whether the eligibility is overrode.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupDenormId":{
            "type":"integer",
            "description":"The unique identifier of the product group denorm.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"The inventory item number of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ServReqEnabledCode":{
            "title":"Service Request",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether server request is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstProdGrpId":{
            "type":"integer",
            "description":"The unique identifier of the first product on the list.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "CountryCodeForEligibilityCheck":{
            "type":"string",
            "description":"The country code for which product eligibility is defined.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "title":"Primary UOM",
            "maxLength":"3",
            "type":"string",
            "description":"The code indicating the product unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemTranslation":{
            "title":"Item Translation",
            "type":"array",
            "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
            "items":{
                "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-item-response"
            }
        },
        "CSSEnabled":{
            "title":"Enable for Customer Self Service",
            "maxLength":"1",
            "type":"string",
            "description":"Indicated whether CSS is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The long description of the product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the parent product group for the penultimate node in the path.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UsageModeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The usage mode code of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "YourPrice":{
            "title":"Your Price",
            "type":"number",
            "description":"The your price of the product shown in the catalog.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FilterByTM":{
            "maxLength":"1",
            "type":"string",
            "description":"The Filter by TM.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object catalogProductItems-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-Attachments-item-response"
    }
}

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

• Array of: object catalogProductItems-ItemTranslation-item-response

{
    "title":"Item Translation",
    "type":"array",
    "description":"The product item resource is used to view the  language code, the translated product group name and description, and the product group ID.",
    "items":{
        "$ref":"#/components/schemas/catalogProductItems-ItemTranslation-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 : catalogProductItems-Attachments-item-response

Type: object

Show Source

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

  Indicates whether the content repository file is shared.
• 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.

{
    "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 name of the attachment file.",
            "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.",
            "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 attachment.",
            "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 file.",
            "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 created the 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 version number of the document.",
            "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 attachment.",
            "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 user name of the person who created 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 that indicates the data type.",
            "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 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 file 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 content repository file is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of 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 path of the attachment file.",
            "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 file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category name 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 and time when the attachment 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":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading 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 : 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 : catalogProductItems-ItemTranslation-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LanguageCode":{
            "title":"Language Code",
            "maxLength":"4",
            "type":"string",
            "description":"The language code associated with the product item like 639-1en (English) or 639-1da (Danish).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The long translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"The translated description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"The translation language of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ISOTerritory":{
            "title":"Territory",
            "maxLength":"2",
            "type":"string",
            "description":"The ISO territory associated with the product item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The unique identifier of the organization to which the item belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ISOLanguage":{
            "maxLength":"2",
            "type":"string",
            "description":"The ISO language associated with the product item like English or Danish.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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

Attachments

Operation: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/Attachments

Parameters:

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

ItemTranslation

Operation: /crmRestApi/resources/11.13.18.05/catalogProductItems/{catalogProductItemsUniqID}/child/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.

Back to Top