1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Products

Get all products

get

/crmRestApi/resources/11.13.18.05/products

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the product by the specified primary key.
      Finder Variables:
      • InventoryItemId; integer; The unique identifier of the inventory item generated during product creation.
    • ProductList: Finds the product with the product list.
      Finder Variables:
      • Bind_CountryCode; string; The country code for which product eligibility is defined.
      • Bind_FilterByTerritory; string; Finds a product with the filter territory.
      • Bind_GeographyId; integer; The unique identifier of the geography.
      • Bind_OverrideEligibility; string; The override eligibility of the product.
      • Bind_UsageCode; string; The usage code of the product.
      • Bind_UsageModeCode; string; The usage mode code of the product.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ATPCode; string; Check available to promise and/or capable to promise information when placing demand.
    • ATPComponentsCode; string; Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items.
    • AllowMaintenanceAssetFlag; boolean; Indicates whether maintainable assets can be defined for the item.
    • AllowSuspendFlag; boolean; Indicates whether a service can be suspended.
    • AllowTerminateFlag; boolean; Indicates whether a service can be terminated.
    • ApprovalStatus; string; The approval status of the item.
    • AssetTrackedFlag; boolean; Indicates whether an item is tracked as an asset in installed base.
    • AttachmentEntityName; string; The name of the attachment entity.
    • AutoSerialAlphaPrefix; string; The starting alphabet prefix for all serial numbers which are being defined for the Item.
    • BOMItemType; string; The type of bill of material the item can possess such as standard, model, planning, and other.
    • CSSEnabled; string; Indicates if the product is enabled for customer self-service. The default value is No.
    • CollateralFlag; boolean; Indicates whether the item is a collateral.
    • ConfigurableFlag; boolean; Identifies whether the product is configurable at the time of quoting.
    • ContainerItemFlag; boolean; Indicates whether containers are used for Shipping the items.
    • ContainerTypeCode; string; Attribute indicating the type of the Container.
    • CoverageName; string; The name of template associated with the contract item type.
    • CoverageScheduleId; integer; The template associated with the contract item type.
    • CreatedBy; string; The user who created the product record.
    • CreationDate; string; The date and time when the product record was created.
    • CustomerOrderFlag; boolean; Indicates whether to allow an item to be ordered by external customers.
    • CxAssetTrackedFlag; boolean; Indicates whether the products set to "Y" are to be displayed as customer owned assets.
    • DefaultPeriodicity; string; The default price periodicity such as monthly, for the product.
    • DefaultPeriodicityCode; string; The default price periodicity code such as monthly, for the product.
    • DefaultPeriods; integer; The default number of price periods for the product.
    • DefaultPriceType; string; Identifies the default price type for the product, such as one-time or recurring.
    • DefaultPriceTypeCode; string; Identifies the default price type code for the product, such as one-time or recurring.
    • DefaultUOM; string; The default unit of measure (UOM) for the product.
    • DefaultUOMCode; string; The default unit of measure (UOM) code for the product.
    • DeleteFlag; boolean; Indicates whether the product can be deleted. The default value is false.
    • Description; string; The description of the product.
    • DimensionUOMCode; string; The unit of measure for the dimension of the item.
    • EligibilityCompatibilityRuleFlag; boolean; 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.
    • EligibleToSell; string; Indicates whether the product is eligible to be sold.
    • EligibleToSellFlag; boolean; Indicates whether the item can be sold or not.
    • EquipmentTypeFlag; boolean; Indicates whether the item is equipment.
    • EventFlag; boolean; Indicates whether the item is event.
    • FinancingAllowedFlag; boolean; Indicates whether a customer can finance this item.
    • InternalVolume; number; The internal volume of the container or vehicle.
    • InvOrgId; integer; The unique identifier of the inventory organization.
    • InventoryItemId; integer; The unique identifier of the inventory item. This value is generated when the product is created.
    • InventoryItemStatusCode; string; The predefined code that indicates the status of the product. The default value is active.
    • InvoiceEnabledFlag; boolean; Indicates whether to activate an item for invoicing in Oracle Receivables.
    • InvoiceableItemFlag; boolean; Indicates whether to include an item on an Oracle Receivables invoice.
    • ItemCatalogGroupId; integer; The unique identifier of the catalog group that the product belongs to.
    • ItemNumber; string; The unique alternate identifier of the product.
    • ItemType; string; Indicator or classification for an item, such as finished or purchased.
    • LastUpdateDate; string; The date and time when the product record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the product record.
    • LastUpdatedBy; string; The user who last updated the product record.
    • MaximumLoadWeight; number; The maximum load weight of the container or vehicle.
    • MinimumFillPercent; number; The minimum fill of the container or vehicle to be used.
    • ModelConfigAttributes; string; The model configuration of the product.
    • ModelFamily; string; The name of the model family associated with the Product Group.
    • ModelLine; string; The name of the model line associated with the Product Group.
    • ModelName; string; The name of the model.
    • Name; string; The name of the inventory item generated during product creation.
    • OrganizationId; integer; The unique identifier of the inventory organization associated with the product.
    • PickComponentsFlag; boolean; Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory.
    • ProcessingDays; number; The lead time for the order.
    • ProductLaunchFlag; boolean; Indicates whether the product is ready to be sold.
    • ProductStatusCode; string; The statuses to track product launch.
    • ProductType; string; The code indicating the type of the sales product. For example, Goods, Included Warranty, Extended Warranty, Service Level Agreement, Training, or Subscription.
    • ProductTypeCode; string; 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; The final assembly work order which is created based on sales order details.
    • ReturnableFlag; boolean; Indicates whether to allow customers to return an item.
    • SerialNumberControlCode; string; The number assigned to each unit of an item and used to track the item.
    • ServiceDuration; number; The number to indicate the service duration.
    • ServiceDurationPeriodCode; string; The number to indicate the service duration period.
    • ServiceDurationTypeCode; string; The type of duration applicable for a service item.
    • ServiceStartDelay; number; The attribute specifying the delay in starting a service after a milestone.
    • ServiceStartTypeCode; string; The type of service start rule which should be used for a service item.
    • ShippableItemFlag; boolean; Indicates whether to ship an item to a customer.
    • StartAutoSerialNumber; string; The starting number for all serial numbers for this item.
    • UnitHeight; number; The height of the item.
    • UnitLength; number; The length of the item.
    • UnitVolume; number; The volume of one unit of item.
    • UnitWeight; number; The weight of one unit of item.
    • UnitWidth; number; The width of the item.
    • UpdateFlag; boolean; Indicates whether the product can be updated. The default value is true.
    • VehicleItemFlag; boolean; Indicates whether vehicles are used for shipping the items.
    • VolumeUOMCode; string; The volume unit of measure.
    • WIPSupplyType; integer; The supply type for components.
    • WeightUOMCode; string; The weight unit of measure.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : products
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : products-item-response
Type: object
Show Source
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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : products-DefaultPrices-item-response
Type: object
Show Source
Nested Schema : products-ProductAttachments-item-response
Type: object
Show Source
Nested Schema : products-ProductImageAttachments-item-response
Type: object
Show Source
Nested Schema : products-ProductTranslations-item-response
Type: object
Show Source
Nested Schema : products-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : products-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : products-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : products-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 50
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 80
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Examples

The following example shows how to get all products by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/products

Example of Response Body

The following shows an example of the response body in JSON format.

{
 -items: [25]
 -0:  
   {
    InventoryItemId: 300100072827858
    InventoryItemStatusCode: "Active"
    ItemCatalogGroupId: 100000011369001
    ItemNumber: "NewProductded95808922"
    Description: "New_Desc2ac95808950"
    OrganizationId: 204
    Name: "New_ProdName2f595808963"
    EligibleToSellFlag: true
    DefaultUOMCode: "Box"
    ProductTypeCode: "GOODS"
    DefaultUOM: "Box"
    UOMCode: "Box"
    ...
}
Back to Top