Create a product
post
/crmRestApi/resources/11.13.18.05/products
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:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AllowSuspendFlag: boolean
Title:
Allow Suspend
Maximum Length:1
Default Value:false
Indicates whether a service can be suspended. -
AllowTerminateFlag: boolean
Title:
Allow Terminate
Maximum Length:1
Default Value:false
Indicates whether a service can be terminated. -
AssetTrackedFlag: boolean
Title:
Enable Asset Tracking
Maximum Length:1
Default Value:false
Indicates whether an item is tracked as an asset in installed base. -
ATPCode: string
Title:
Check ATP
Maximum Length:1
Default Value:N
Check available to promise and/or capable to promise information when placing demand. -
ATPComponentsCode: string
Title:
ATP Components
Maximum Length:1
Default Value:N
Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items. -
AttachmentEntityName: string
Default Value:
ITEM_ENTITY
The name of the attachment entity. -
AutoSerialAlphaPrefix: string
Title:
Starting Serial Prefix
Maximum Length:80
The starting alphabet prefix for all serial numbers which are being defined for the Item. -
BOMItemType: string
Title:
Structure Item Type
Maximum Length:30
Default Value:4
The type of bill of material the item can possess such as standard, model, planning, and other. -
CollateralFlag: boolean
Title:
Collateral
Maximum Length:1
Indicates whether the item is a collateral. -
ConfigurableFlag: boolean
Title:
Configurable
Maximum Length:1
Identifies whether the product is configurable at the time of quoting. -
ContainerItemFlag: boolean
Title:
Container
Maximum Length:1
Indicates whether containers are used for Shipping the items. -
ContainerTypeCode: string
Title:
Container Type
Maximum Length:30
Attribute indicating the type of the Container. -
CoverageName: string
Title:
Standard Coverage
Maximum Length:150
The name of template associated with the contract item type. -
CoverageScheduleId: integer
(int64)
Title:
Coverage Schedule ID
The template associated with the contract item type. -
CSSEnabled: string
Title:
Enable Customer Self-Service
Maximum Length:1
Default Value:N
Indicates if the product is enabled for customer self-service. The default value is No. -
CustomerOrderFlag: boolean
Title:
Customer Ordered
Maximum Length:1
Default Value:false
Indicates whether to allow an item to be ordered by external customers. -
CxAssetTrackedFlag: boolean
Title:
Enable Customer Asset Tracking
Maximum Length:1
Default Value:false
Indicates whether the products set to "Y" are to be displayed as customer owned assets. -
DefaultPeriodicity: string
Title:
Default Periodicity
Maximum Length:80
The default price periodicity such as monthly, for the product. -
DefaultPeriodicityCode: string
Title:
Default Periodicity Code
Maximum Length:30
The default price periodicity code such as monthly, for the product. -
DefaultPeriods: integer
(int32)
Title:
Default Periods
The default number of price periods for the product. -
DefaultPrices: array
Default Prices
Title:
Default Prices
The default prices resource is used to view, create, update, and delete default prices for products. -
DefaultPriceType: string
Title:
Default Price Type
Maximum Length:80
Identifies the default price type for the product, such as one-time or recurring. -
DefaultPriceTypeCode: string
Title:
Default Price Type Code
Maximum Length:30
Identifies the default price type code for the product, such as one-time or recurring. -
DefaultUOM(required): string
Title:
Default UOM
Maximum Length:25
The default unit of measure (UOM) for the product. -
DefaultUOMCode(required): string
Title:
Default UOM Code
Maximum Length:3
The default unit of measure (UOM) code for the product. -
Description: string
Title:
Description
Maximum Length:4000
The description of the product. -
DimensionUOMCode: string
Title:
Dimension Unit of Measure
Maximum Length:3
The unit of measure for the dimension of the item. -
EligibilityCompatibilityRuleFlag: boolean
Title:
Eligibility Rule
Maximum Length:1
A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer. -
EligibleForService: string
Title:
Eligible for Service
Default Value:Y
Indicates whether the product is eligible for service. -
EligibleToSell: string
Title:
Meaning
Maximum Length:80
Indicates whether the product is eligible to be sold. -
EligibleToSellFlag: boolean
Title:
Eligible to Sell
Maximum Length:1
Default Value:true
Indicates whether the item can be sold or not. -
EquipmentTypeFlag: boolean
Title:
Warehouse Equipment
Maximum Length:30
Default Value:false
Indicates whether the item is equipment. -
EventFlag: boolean
Title:
Event
Maximum Length:1
Indicates whether the item is event. -
ExtendedDescriptionOne: string
(byte)
Title:
Extended Description 1
The first additional description of the product. -
ExtendedDescriptionTwo: string
(byte)
Title:
Extended Description 2
The second additional description of the product. -
FinancingAllowedFlag: boolean
Title:
Financing Allowed
Maximum Length:1
Indicates whether a customer can finance this item. -
InternalVolume: number
Title:
Internal Volume
The internal volume of the container or vehicle. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. This value is generated when the product is created. -
InventoryItemStatusCode: string
Title:
Product Status Code
Maximum Length:10
Default Value:Active
The predefined code that indicates the status of the product. The default value is active. -
InvoiceableItemFlag: boolean
Title:
Invoiced
Maximum Length:1
Default Value:false
Indicates whether to include an item on an Oracle Receivables invoice. -
InvoiceEnabledFlag: boolean
Title:
Invoice Enabled
Maximum Length:1
Default Value:false
Indicates whether to activate an item for invoicing in Oracle Receivables. -
ItemCatalogGroupId: integer
(int64)
Title:
Item Catalog Group ID
The unique identifier of the catalog group that the product belongs to. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
ItemType: string
Title:
User Item Type
Maximum Length:30
Indicator or classification for an item, such as finished or purchased. -
MaximumLoadWeight: number
Title:
Maximum Load Weight
The maximum load weight of the container or vehicle. -
MinimumFillPercent: number
Title:
Minimum Fill Percent
The minimum fill of the container or vehicle to be used. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configuration of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The name of the model. -
Name(required): string
Title:
Name
Maximum Length:240
The name of the inventory item generated during product creation. -
OrganizationId(required): integer
(int64)
Title:
Organization ID
The unique identifier of the inventory organization associated with the product. -
PickComponentsFlag: boolean
Title:
Pick Components
Maximum Length:1
Default Value:false
Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory. -
ProcessingDays: number
Title:
Processing Days
The lead time for the order. -
ProductAttachments: array
Product Attachments
Title:
Product Attachments
The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product. -
ProductImageAttachments: array
Product Image Attachments
Title:
Product Image Attachments
The attachment resource is used to view, create, and update image attachments of a product. -
ProductLaunchFlag: boolean
Title:
Product Launch Indicator
Maximum Length:1
Default Value:false
Indicates whether the product is ready to be sold. -
ProductTranslations: array
Product Translations
Title:
Product Translations
The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product. -
ProductType: string
Title:
Sales Product Type
Maximum Length:80
The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription. -
ProductTypeCode: string
Title:
Sales Product Type Code
Maximum Length:30
The code indicating the type of the product. The accepted values are, COVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING. -
ReplenishToOrderFlag: boolean
Title:
Assemble to Order
Maximum Length:1
Default Value:false
The final assembly work order which is created based on sales order details. -
ReturnableFlag: boolean
Title:
Returnable
Maximum Length:1
Default Value:false
Indicates whether to allow customers to return an item. -
SalesProductLookupType: object
SalesProductLookupType
The lookup type for the sales product type.
-
SerialNumberControlCode: string
Title:
Serial Number Control
Maximum Length:30
Default Value:1
The number assigned to each unit of an item and used to track the item. -
ServiceDuration: number
Title:
Service Duration
The number to indicate the service duration. -
ServiceDurationPeriodCode: string
Title:
Service Duration Period
Maximum Length:10
The number to indicate the service duration period. -
ServiceDurationTypeCode: string
Title:
Service Duration Type
Maximum Length:3
Default Value:O
The type of duration applicable for a service item. -
ServiceStartDelay: number
Title:
Service Start Delay
Default Value:0
The attribute specifying the delay in starting a service after a milestone. -
ServiceStartTypeCode: string
Title:
Service Start Type
Maximum Length:3
Default Value:MS
The type of service start rule which should be used for a service item. -
ShippableItemFlag: boolean
Title:
Shippable
Maximum Length:1
Default Value:false
Indicates whether to ship an item to a customer. -
StartAutoSerialNumber: string
Title:
Starting Serial Number
Maximum Length:80
The starting number for all serial numbers for this item. -
TemplateName: string
Title:
Product Template
Maximum Length:960
The name of the template. -
UnitHeight: number
Title:
Height
The height of the item. -
UnitLength: number
Title:
Length
The length of the item. -
UnitVolume: number
Title:
Unit Volume
The volume of one unit of item. -
UnitWeight: number
Title:
Unit Weight
The weight of one unit of item. -
UnitWidth: number
Title:
Width
The width of the item. -
VehicleItemFlag: boolean
Title:
Vehicle
Maximum Length:1
Indicates whether vehicles are used for shipping the items. -
VolumeUOMCode: string
Title:
Volume Unit of Measure
Maximum Length:3
The volume unit of measure. -
WeightUOMCode: string
Title:
Weight Unit of Measure
Maximum Length:3
The weight unit of measure. -
WIPSupplyType: integer
(int64)
Title:
Supply Type
Default Value:1
The supply type for components.
Nested Schema : Default Prices
Type:
array
Title:
Default Prices
The default prices resource is used to view, create, update, and delete default prices for products.
Show Source
Nested Schema : Product Attachments
Type:
array
Title:
Product Attachments
The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.
Show Source
Nested Schema : Product Image Attachments
Type:
array
Title:
Product Image Attachments
The attachment resource is used to view, create, and update image attachments of a product.
Show Source
Nested Schema : Product Translations
Type:
array
Title:
Product Translations
The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.
Show Source
Nested Schema : SalesProductLookupType
Type:
object
The lookup type for the sales product type.
Nested Schema : products-DefaultPrices-item-post-request
Type:
Show Source
object
-
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code for the Currency of the default price. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
ListPrice: number
Title:
List Price
Default Value:0
The List Price for the combination of product, currency and UOM. -
PricebookId: integer
(int64)
The unique identifier of the price book associated with the default price
-
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement code of the default price.
Nested Schema : products-ProductAttachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the 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 contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the 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 contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : products-ProductTranslations-item-post-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:4000
The long description of the product. -
ExtendedDescriptionOne: string
(byte)
Title:
Extended Description 1
The first additional description of the product. -
ExtendedDescriptionTwo: string
(byte)
Title:
Extended Description 2
The second additional description of the product. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. This value is generated when the product is created. -
Language: string
Maximum Length:
4
The translated language for the translation record. -
Name: string
Title:
Name
Maximum Length:240
The description of the product. -
OrganizationId: integer
(int64)
Title:
Organization ID
The unique identifier of the inventory organization associated with the product. -
SourceLang: string
Maximum Length:
4
The source language for the translation record.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : products-item-response
Type:
Show Source
object
-
AllowSuspendFlag: boolean
Title:
Allow Suspend
Maximum Length:1
Default Value:false
Indicates whether a service can be suspended. -
AllowTerminateFlag: boolean
Title:
Allow Terminate
Maximum Length:1
Default Value:false
Indicates whether a service can be terminated. -
ApprovalStatus: string
Title:
Approval Status
Read Only:true
Maximum Length:30
Default Value:A
The approval status of the item. -
AssetTrackedFlag: boolean
Title:
Enable Asset Tracking
Maximum Length:1
Default Value:false
Indicates whether an item is tracked as an asset in installed base. -
ATPCode: string
Title:
Check ATP
Maximum Length:1
Default Value:N
Check available to promise and/or capable to promise information when placing demand. -
ATPComponentsCode: string
Title:
ATP Components
Maximum Length:1
Default Value:N
Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items. -
AttachmentEntityName: string
Default Value:
ITEM_ENTITY
The name of the attachment entity. -
AutoSerialAlphaPrefix: string
Title:
Starting Serial Prefix
Maximum Length:80
The starting alphabet prefix for all serial numbers which are being defined for the Item. -
BOMItemType: string
Title:
Structure Item Type
Maximum Length:30
Default Value:4
The type of bill of material the item can possess such as standard, model, planning, and other. -
CollateralFlag: boolean
Title:
Collateral
Maximum Length:1
Indicates whether the item is a collateral. -
ConfigurableFlag: boolean
Title:
Configurable
Maximum Length:1
Identifies whether the product is configurable at the time of quoting. -
ContainerItemFlag: boolean
Title:
Container
Maximum Length:1
Indicates whether containers are used for Shipping the items. -
ContainerTypeCode: string
Title:
Container Type
Maximum Length:30
Attribute indicating the type of the Container. -
CoverageName: string
Title:
Standard Coverage
Maximum Length:150
The name of template associated with the contract item type. -
CoverageScheduleId: integer
(int64)
Title:
Coverage Schedule ID
The template associated with the contract item type. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the product record was created. -
CSSEnabled: string
Title:
Enable Customer Self-Service
Maximum Length:1
Default Value:N
Indicates if the product is enabled for customer self-service. The default value is No. -
CustomerOrderFlag: boolean
Title:
Customer Ordered
Maximum Length:1
Default Value:false
Indicates whether to allow an item to be ordered by external customers. -
CxAssetTrackedFlag: boolean
Title:
Enable Customer Asset Tracking
Maximum Length:1
Default Value:false
Indicates whether the products set to "Y" are to be displayed as customer owned assets. -
DefaultPeriodicity: string
Title:
Default Periodicity
Maximum Length:80
The default price periodicity such as monthly, for the product. -
DefaultPeriodicityCode: string
Title:
Default Periodicity Code
Maximum Length:30
The default price periodicity code such as monthly, for the product. -
DefaultPeriods: integer
(int32)
Title:
Default Periods
The default number of price periods for the product. -
DefaultPrices: array
Default Prices
Title:
Default Prices
The default prices resource is used to view, create, update, and delete default prices for products. -
DefaultPriceType: string
Title:
Default Price Type
Maximum Length:80
Identifies the default price type for the product, such as one-time or recurring. -
DefaultPriceTypeCode: string
Title:
Default Price Type Code
Maximum Length:30
Identifies the default price type code for the product, such as one-time or recurring. -
DefaultUOM: string
Title:
Default UOM
Maximum Length:25
The default unit of measure (UOM) for the product. -
DefaultUOMCode: string
Title:
Default UOM Code
Maximum Length:3
The default unit of measure (UOM) code for the product. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the product can be deleted. The default value is false. -
Description: string
Title:
Description
Maximum Length:4000
The description of the product. -
DimensionUOMCode: string
Title:
Dimension Unit of Measure
Maximum Length:3
The unit of measure for the dimension of the item. -
EligibilityCompatibilityRuleFlag: boolean
Title:
Eligibility Rule
Maximum Length:1
A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer. -
EligibleForService: string
Title:
Eligible for Service
Default Value:Y
Indicates whether the product is eligible for service. -
EligibleToSell: string
Title:
Meaning
Maximum Length:80
Indicates whether the product is eligible to be sold. -
EligibleToSellFlag: boolean
Title:
Eligible to Sell
Maximum Length:1
Default Value:true
Indicates whether the item can be sold or not. -
EquipmentTypeFlag: boolean
Title:
Warehouse Equipment
Maximum Length:30
Default Value:false
Indicates whether the item is equipment. -
EventFlag: boolean
Title:
Event
Maximum Length:1
Indicates whether the item is event. -
ExtendedDescriptionOne: string
(byte)
Title:
Extended Description 1
The first additional description of the product. -
ExtendedDescriptionTwo: string
(byte)
Title:
Extended Description 2
The second additional description of the product. -
FinancingAllowedFlag: boolean
Title:
Financing Allowed
Maximum Length:1
Indicates whether a customer can finance this item. -
InternalVolume: number
Title:
Internal Volume
The internal volume of the container or vehicle. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. This value is generated when the product is created. -
InventoryItemStatusCode: string
Title:
Product Status Code
Maximum Length:10
Default Value:Active
The predefined code that indicates the status of the product. The default value is active. -
InvoiceableItemFlag: boolean
Title:
Invoiced
Maximum Length:1
Default Value:false
Indicates whether to include an item on an Oracle Receivables invoice. -
InvoiceEnabledFlag: boolean
Title:
Invoice Enabled
Maximum Length:1
Default Value:false
Indicates whether to activate an item for invoicing in Oracle Receivables. -
InvOrgId: integer
(int64)
Title:
Inventory Organization ID
Read Only:true
The unique identifier of the inventory organization. -
ItemCatalogGroupId: integer
(int64)
Title:
Item Catalog Group ID
The unique identifier of the catalog group that the product belongs to. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
ItemType: string
Title:
User Item Type
Maximum Length:30
Indicator or classification for an item, such as finished or purchased. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the product record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the product record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the product record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumLoadWeight: number
Title:
Maximum Load Weight
The maximum load weight of the container or vehicle. -
MinimumFillPercent: number
Title:
Minimum Fill Percent
The minimum fill of the container or vehicle to be used. -
ModelConfigAttributes: string
Title:
Model Attributes
Maximum Length:4000
The model configuration of the product. -
ModelFamily: string
Title:
Model Family
Maximum Length:1000
The name of the model family associated with the Product Group. -
ModelLine: string
Title:
Model Line
Maximum Length:1000
The name of the model line associated with the Product Group. -
ModelName: string
Title:
Model
Maximum Length:1000
The name of the model. -
Name: string
Title:
Name
Maximum Length:240
The name of the inventory item generated during product creation. -
OrganizationCode: string
Title:
Organization Code
Read Only:true
Maximum Length:18
The code that uniquely identifies the organization. This value is derived from the ItemOrganizationId. -
OrganizationId: integer
(int64)
Title:
Organization ID
The unique identifier of the inventory organization associated with the product. -
PickComponentsFlag: boolean
Title:
Pick Components
Maximum Length:1
Default Value:false
Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory. -
ProcessingDays: number
Title:
Processing Days
The lead time for the order. -
ProductAttachments: array
Product Attachments
Title:
Product Attachments
The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product. -
ProductImageAttachments: array
Product Image Attachments
Title:
Product Image Attachments
The attachment resource is used to view, create, and update image attachments of a product. -
ProductLaunchFlag: boolean
Title:
Product Launch Indicator
Maximum Length:1
Default Value:false
Indicates whether the product is ready to be sold. -
ProductTranslations: array
Product Translations
Title:
Product Translations
The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product. -
ProductType: string
Title:
Sales Product Type
Maximum Length:80
The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription. -
ProductTypeCode: string
Title:
Sales Product Type Code
Maximum Length:30
The code indicating the type of the product. The accepted values are, COVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING. -
ReplenishToOrderFlag: boolean
Title:
Assemble to Order
Maximum Length:1
Default Value:false
The final assembly work order which is created based on sales order details. -
ReturnableFlag: boolean
Title:
Returnable
Maximum Length:1
Default Value:false
Indicates whether to allow customers to return an item. -
SalesProductLookupType: object
SalesProductLookupType
The lookup type for the sales product type.
-
SerialNumberControlCode: string
Title:
Serial Number Control
Maximum Length:30
Default Value:1
The number assigned to each unit of an item and used to track the item. -
ServiceDuration: number
Title:
Service Duration
The number to indicate the service duration. -
ServiceDurationPeriodCode: string
Title:
Service Duration Period
Maximum Length:10
The number to indicate the service duration period. -
ServiceDurationTypeCode: string
Title:
Service Duration Type
Maximum Length:3
Default Value:O
The type of duration applicable for a service item. -
ServiceStartDelay: number
Title:
Service Start Delay
Default Value:0
The attribute specifying the delay in starting a service after a milestone. -
ServiceStartTypeCode: string
Title:
Service Start Type
Maximum Length:3
Default Value:MS
The type of service start rule which should be used for a service item. -
ShippableItemFlag: boolean
Title:
Shippable
Maximum Length:1
Default Value:false
Indicates whether to ship an item to a customer. -
StartAutoSerialNumber: string
Title:
Starting Serial Number
Maximum Length:80
The starting number for all serial numbers for this item. -
TemplateName: string
Title:
Product Template
Maximum Length:960
The name of the template. -
UnitHeight: number
Title:
Height
The height of the item. -
UnitLength: number
Title:
Length
The length of the item. -
UnitVolume: number
Title:
Unit Volume
The volume of one unit of item. -
UnitWeight: number
Title:
Unit Weight
The weight of one unit of item. -
UnitWidth: number
Title:
Width
The width of the item. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the product can be updated. The default value is true. -
VehicleItemFlag: boolean
Title:
Vehicle
Maximum Length:1
Indicates whether vehicles are used for shipping the items. -
VolumeUOMCode: string
Title:
Volume Unit of Measure
Maximum Length:3
The volume unit of measure. -
WeightUOMCode: string
Title:
Weight Unit of Measure
Maximum Length:3
The weight unit of measure. -
WIPSupplyType: integer
(int64)
Title:
Supply Type
Default Value:1
The supply type for components.
Nested Schema : Default Prices
Type:
array
Title:
Default Prices
The default prices resource is used to view, create, update, and delete default prices for products.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Product Attachments
Type:
array
Title:
Product Attachments
The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.
Show Source
Nested Schema : Product Image Attachments
Type:
array
Title:
Product Image Attachments
The attachment resource is used to view, create, and update image attachments of a product.
Show Source
Nested Schema : Product Translations
Type:
array
Title:
Product Translations
The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.
Show Source
Nested Schema : SalesProductLookupType
Type:
object
The lookup type for the sales product type.
Nested Schema : products-DefaultPrices-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the default price. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the default price was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The code for the Currency of the default price. -
DefaultPriceId: integer
(int64)
Read Only:
true
The unique identifier of the default price. This value is generated when the default price is created. -
InvItemId: integer
(int64)
Title:
Inventory Item ID
Read Only:true
The unique identifier of the inventory item associated with the default price -
InvOrgId: integer
(int64)
Read Only:
true
The unique identifier of the inventory organization associated with the default price. -
ItemNumber: string
Title:
Product Number
Maximum Length:300
The unique alternate identifier of the product. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the default price was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the default price. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the default price. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
Default Value:0
The List Price for the combination of product, currency and UOM. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PricebookId: integer
(int64)
The unique identifier of the price book associated with the default price
-
PriceBookName: string
Title:
Name
Read Only:true
Maximum Length:150
The name of the Price book associated with the Default Price. -
PriceUOMCode: string
Title:
UOM
Maximum Length:30
The unit of measurement code of the default price.
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 : products-ProductAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the picture attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the 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 contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the picture attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : products-ProductImageAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the picture attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code that indicates the data type. For example, a file or a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the 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 contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the picture attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : products-ProductTranslations-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the product record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the product record was created. -
Description: string
Title:
Description
Maximum Length:4000
The long description of the product. -
ExtendedDescriptionOne: string
(byte)
Title:
Extended Description 1
The first additional description of the product. -
ExtendedDescriptionTwo: string
(byte)
Title:
Extended Description 2
The second additional description of the product. -
InventoryItemId: integer
(int64)
Title:
Inventory Item ID
The unique identifier of the inventory item. This value is generated when the product is created. -
ItemNumber: string
Read Only:
true
Maximum Length:300
The unique alternate identifier of the product. -
Language: string
Maximum Length:
4
The translated language for the translation record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the product record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the product record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the product record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:240
The description of the product. -
OrganizationId: integer
(int64)
Title:
Organization ID
The unique identifier of the inventory organization associated with the product. -
SourceLang: string
Maximum Length:
4
The source language for the translation record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ApprovalStatusLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_APPROVAL_STATUS
- finder:
- AssetTrackedFlagLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_EGP_ASSET_TRACKING
- finder:
- AtpLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_ORDATPCHECKVS_TYPE
- finder:
- BomItemTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_BOM_ITEM_TYPE
- finder:
- ContainerTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DINV_CONTAINER_TYPE
- finder:
- CoverageLovVA
- DefaultPeriodicityLookupLovVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DMOO_RECURRING_FREQUENCY
- finder:
- DefaultPriceTypeLookupLovVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ZCA_SO_LINE_PRICE_TYPE
- finder:
- DefaultPrices
-
Parameters:
- InventoryItemId:
$request.path.InventoryItemId
- InventoryItemId:
- EligibleToSellLookupPVOLovVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DYES_NO
- finder:
- EquipmentTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_COMMON_YES_NO_NUM
- finder:
- ItemStatusVA
- ItemTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_ITEM_TYPE
- finder:
- ProductAttachments
-
Parameters:
- InventoryItemId:
$request.path.InventoryItemId
- InventoryItemId:
- ProductImageAttachments
-
Operation: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachmentsParameters:
- InventoryItemId:
$request.path.InventoryItemId
- InventoryItemId:
- ProductTranslations
-
Parameters:
- InventoryItemId:
$request.path.InventoryItemId
- InventoryItemId:
- ProductTypeLovVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DQSC_SALES_PRODUCT_TYPE
- finder:
- SerialNumberControlLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERIAL_NUMBER_CONTROL_TYPE
- finder:
- ServiceDurationPeriodLovVA
- ServiceDurationTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERV_DUR_TYPE_CODE
- finder:
- ServiceStartTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_SERV_START_TYPE_CODE
- finder:
- SpimTemplatesVO1
- UnitOfMeasureVVOLovVA
- WipSupplyTypeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_WIP_SUP_TYPE
- finder:
- YesNoLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_COMMON_YES_NO_CHAR
- finder: