Products
products Based on latest (2026.09)
Create, change and look up Products, with default prices and smart actions.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)9 actions
- Record key
InventoryItemId- Required on create
DefaultUOMDefaultUOMCodeNameOrganizationId- At a glance
- 91 fields1 finders8 children2 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/products?fields=ATPCode,ATPComponentsCode,AllowMaintenanceAssetFlag,AllowSuspendFlag,AllowTerminateFlag&limit=25&onlyData=true
{
"items": [
{
"ATPCode": "<string, max 1>",
"ATPComponentsCode": "<string, max 1>",
"AllowMaintenanceAssetFlag": false,
"AllowSuspendFlag": false,
"AllowTerminateFlag": false
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 91
| Attribute | Type | Use |
|---|---|---|
ATPCode | text · max 1 | Optional on createUpdatableSearchable |
ATPComponentsCode | text · max 1 | Optional on createUpdatableSearchable |
AllowMaintenanceAssetFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AllowSuspendFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AllowTerminateFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ApprovalStatus | text · max 30 | Read-onlySearchable |
AssetTrackedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AttachmentEntityName | text · default ITEM_ENTITY | Optional on createUpdatableSearchable |
AutoSerialAlphaPrefix | text · max 80 | Optional on createUpdatableSearchable |
BOMItemType | text · max 30 | Optional on createUpdatableSearchable |
CSSEnabled | text · max 1 · default N | Optional on createUpdatableSearchable |
CollateralFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ConfigurableFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ContainerItemFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ContainerTypeCode | text · max 30 | Optional on createUpdatableSearchable |
CoverageName | text · max 150 | Optional on createUpdatableSearchable |
CoverageScheduleId | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CustomerOrderFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
CxAssetTrackedFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
DefaultPeriodicity | text · max 80 | Optional on createUpdatableSearchable |
DefaultPeriodicityCode | text · max 30 | Optional on createUpdatableSearchable |
DefaultPeriods | number | Optional on createUpdatableSearchable |
DefaultPriceType | text · max 80 | Optional on createUpdatableSearchable |
DefaultPriceTypeCode | text · max 30 | Optional on createUpdatableSearchable |
DefaultUOM | text · max 25 | Required on createSearchable |
DefaultUOMCode | text · max 3 | Required on createSearchable |
DeleteFlag | yes/no | Read-onlySearchable |
Description | text · max 4000 | Optional on createUpdatableSearchable |
DimensionUOMCode | text · max 3 | Optional on createUpdatableSearchable |
EligibilityCompatibilityRuleFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EligibleForService | text · default Y | Optional on createUpdatable |
EligibleToSell | text · max 80 | Optional on createUpdatableSearchable |
EligibleToSellFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
EnableContractCoverageFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EquipmentTypeFlag | yes/no · max 30 | Optional on createUpdatableSearchable |
EventFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ExtendedDescriptionOne | text | Optional on createUpdatable |
ExtendedDescriptionTwo | text | Optional on createUpdatable |
FinancingAllowedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
InternalVolume | number | Optional on createUpdatableSearchable |
InvOrgId | number | Read-onlySearchable |
InventoryItemId | number | Optional on createSearchable |
InventoryItemStatusCode | text · max 10 · default Active | Optional on createSearchable |
InvoiceEnabledFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
InvoiceableItemFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ItemCatalogGroupId | number | Optional on createSearchable |
ItemNumber | text · max 300 | Optional on createSearchable |
ItemType | text · max 30 | Optional on createUpdatableSearchable |
LastSyncDate | date | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MaximumLoadWeight | number | Optional on createUpdatableSearchable |
MinimumFillPercent | number | Optional on createUpdatableSearchable |
ModelConfigAttributes | text · max 4000 | Optional on createUpdatableSearchable |
ModelFamily | text · max 1000 | Optional on createUpdatableSearchable |
ModelLine | text · max 1000 | Optional on createUpdatableSearchable |
ModelName | text · max 1000 | Optional on createUpdatableSearchable |
Name | text · max 240 | Required on createUpdatableSearchable |
OrganizationCode | text · max 18 | Read-only |
OrganizationId | number | Required on createSearchable |
PickComponentsFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ProcessingDays | number | Optional on createUpdatableSearchable |
ProductLaunchFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ProductStatusCode | text · max 30 · default ORA_CREATED | Optional on createUpdatableSearchable |
ProductType | text · max 80 | Optional on createUpdatableSearchable |
ProductTypeCode | text · max 30 | Optional on createUpdatableSearchable |
ReplenishToOrderFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ReturnableFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
SalesProductLookupType | text | Optional on createUpdatable |
SerialNumberControlCode | text · max 30 | Optional on createUpdatableSearchable |
ServiceDuration | number | Optional on createUpdatableSearchable |
ServiceDurationPeriodCode | text · max 10 | Optional on createUpdatableSearchable |
ServiceDurationTypeCode | text · max 3 | Optional on createUpdatableSearchable |
ServiceStartDelay | number | Optional on createUpdatableSearchable |
ServiceStartTypeCode | text · max 3 | Optional on createUpdatableSearchable |
ShippableItemFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
StartAutoSerialNumber | text · max 80 | Optional on createUpdatableSearchable |
TemplateName | text · max 960 | Optional on create |
UnitHeight | number | Optional on createUpdatableSearchable |
UnitLength | number | Optional on createUpdatableSearchable |
UnitVolume | number | Optional on createUpdatableSearchable |
UnitWeight | number | Optional on createUpdatableSearchable |
UnitWidth | number | Optional on createUpdatableSearchable |
UpdateFlag | yes/no | Read-onlySearchable |
VehicleItemFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
VolumeUOMCode | text · max 3 | Optional on createUpdatableSearchable |
WIPSupplyType | number | Optional on createUpdatableSearchable |
WeightUOMCode | text · max 3 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ProductList·Bind_CountryCodeBind_FilterByTerritoryBind_GeographyIdBind_OverrideEligibilityBind_UsageCodeBind_UsageModeCode
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 8
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/<name>. Add them to a GET with expand.
DefaultPricesGET · POST · PATCH · DELETE Default Prices · 15 fields · 1 findersCreatedByCreationDateCurrencyCodeDefaultPriceIdInvItemIdInvOrgIdItemNumberLastUpdateDateLastUpdateLoginLastUpdatedByListPriceObjectVersionNumberPriceBookNamePriceUOMCodePricebookIdProductAttachmentsGET · POST · PATCH · DELETE Product Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameProductImageAttachmentsGET · POST · PATCH · DELETE Product Image Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameProductTranslationsGET Product Translations · 14 fieldsCreatedByCreationDateDescriptionExtendedDescriptionOneExtendedDescriptionTwoInventoryItemIdItemNumberLanguageLastUpdateDateLastUpdateLoginLastUpdatedByNameOrganizationIdSourceLangsmartActionsGET Smart Actions · 17 fields · 5 findersActionIntentConfirmationMessageContentTypeDisplayLabelEntityHrefIncludedInApplicationMassActionFlagMethodObjectFunctionNamePageTypeSmartSuggestFlagSystemActionFlagUpdateOfAttributesUserActionIdUserActionNameUserActionRankUserActionNavigationGET Smart Action User Interface Definitions · 5 fields · 1 findersSystemActionFlagUserActionNavAppUsageUserActionNavBodyUserActionNavIdUserActionNavTypeUserActionRequestPayloadGET Smart Action REST Payload Definitions · 8 fields · 1 findersBindingMandatoryFlagRequestPayloadIdRequestPayloadNameSmartSuggestPathSystemActionFlagValueValueStructUserActionURLBindingGET Smart Action User Interface Definitions · 5 fields · 1 findersBindingSystemActionFlagURLBindingIdURLBindingNameValue
Actions 9
POST …/{InventoryItemId}/child/smartActions/action/executeActionForRows·payloadPOST …/{InventoryItemId}/child/smartActions/action/generateSmartActions·requestListsourceResourcePOST …/{InventoryItemId}/child/smartActions/action/getActionEvaluationAttributesForResource·resourceNamePOST …/{InventoryItemId}/child/smartActions/action/getActionsForRows·payloadPOST …/{InventoryItemId}/child/smartActions/action/getAttributesForResource·resourceNamePOST …/{InventoryItemId}/child/smartActions/action/getEntitiesPOST …/{InventoryItemId}/child/smartActions/action/getObjectFunctions·resourceNamePOST …/{InventoryItemId}/child/smartActions/action/processMassAction·payloadPOST …/{InventoryItemId}/child/smartActions/{UserActionId}/action/executeAction
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/productsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ProductListfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ATPCode, notatpcode. - 11 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.