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

Get all products

get

/crmRestApi/resources/11.13.18.05/catalogProductItems

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:

    • GetCatalogProductItemsRowFinder: Finds a product item with the specified catalog product group row finder.
      Finder Variables:
      • Bind_CustomerOrderEnabledFlag; string; Indicates whether the product item is enabled for customer order.
      • Bind_Date; string; The bind date of the product item.
      • Bind_UsageCode; string; The product items bind usage code.
      • Bind_UsageModeCode; string; The product items bind usage mode code.
    • PrimaryKey: Finds the product item by the specified primary key.
      Finder Variables:
      • InventoryItemId; integer; The unique identifier of the inventory item.
      • OrganizationId; integer; The unique identifier of the organization.
      • ProductGroupDenormId; integer; The unique identifier of the product item.
  • 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:
    • CSSEnabled; string; Indicated whether CSS is enabled.
    • CountryCodeForEligibilityCheck; string; The country code for which product eligibility is defined.
    • CustomerOrderEnabledFlag; string; Indicates whether the product can be ordered by customer.
    • Depth; integer; The difference between the level of the first and the last product group in the path.
    • Description; string; The description of the product.
    • FilterByTM; string; The Filter by TM.
    • FirstProdGrpId; integer; The unique identifier of the first product on the list.
    • GeographyId; string; The unique identifier of the geography of the product.
    • InventoryItemId; integer; The unique identifier of the inventory item.
    • ItemNumber; string; The inventory item number of the item.
    • LongDescription; string; The long description of the product.
    • OrganizationId; integer; The unique identifier of the organization.
    • OverrideEligYN; string; Indicate whether the eligibility is overrode.
    • ParentProductGroupId; integer; The unique identifier of the parent product group for the penultimate node in the path.
    • PathId; integer; The unique identifier of the path.
    • PrimaryUOMCode; string; The code indicating the product unit of measure.
    • ProductGroupDenormId; integer; The unique identifier of the product group denorm.
    • ProductGroupId; integer; The unique identifier of the product group.
    • SalesProductType; string; The type of the sales product.
    • ServReqEnabledCode; string; The code indicating whether server request is enabled.
    • UsageCode; string; The usage code of the product.
    • UsageModeCode; string; The usage mode code of the product.
  • 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 : catalogProductItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : catalogProductItems-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view the attachments of a product item. An attachment includes additional information about the product item.
Show Source
Nested Schema : Item Translation
Type: array
Title: Item Translation
The product item resource is used to view the language code, the translated product group name and description, and the product group ID.
Show Source
Nested Schema : catalogProductItems-Attachments-item-response
Type: object
Show Source
Nested Schema : catalogProductItems-ItemTranslation-item-response
Type: object
Show Source
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    The translated description of the item.
  • Title: Item Number
    Read Only: true
    The unique identifier of the inventory item.
  • Read Only: true
    Maximum Length: 2
    The ISO language associated with the product item like English or Danish.
  • Title: Territory
    Read Only: true
    Maximum Length: 2
    The ISO territory associated with the product item.
  • Read Only: true
    Maximum Length: 4
    The translation language of the item.
  • 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
  • Title: Long Description
    Read Only: true
    Maximum Length: 4000
    The long translated description of the item.
  • Title: Organization
    Read Only: true
    The unique identifier of the organization to which the item belongs.
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/fscmRestApi/resources/11.13.18.05/catalogProductItems

Example of Response Body

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

{
    "items": [
        {
            "ProductGroupId": 100000011628015,
            "ProductGroupDenormId": 100000011836093,
            "FirstProdGrpId": 100000011628005,
            "ParentProductGroupId": 100000011628007,
            "Description": "SalesCatalogItem 001 Autoruns",
            "InventoryItemId": 300100111501658,
            "OrganizationId": 204,
            "CustomerOrderEnabledFlag": "Y",
            "ItemNumber": "SC_PreReqItem_001",
            "PrimaryUOMCode": "Ea",
            "ListPrice": null,
            "CurrencyCode": null,
            "YourPrice": null,
            "Depth": 2,
            "PathId": 100000011836094,
            "SalesProductType": "GOODS",
            "UsageCode": null,
            "UsageModeCode": null,
            "FilterByTM": null,
            "GeographyId": null,
            "CountryCodeForEligibilityCheck": null,
            "OverrideEligYN": null,
            "ServReqEnabledCode": "E",
            "AttachmentEntityName": "ITEM_ENTITY",
            "CSSEnabled": "N",
            "LongDescription": "SalesCatalogItem 001 Autoruns",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductItems/00030000000EACED0005770800005AF3112EDABD0000000EACED00057708000110F0808B095A0000000EACED0005770800000000000000CC",
                    "name": "catalogProductItems",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductItems/00030000000EACED0005770800005AF3112EDABD0000000EACED00057708000110F0808B095A0000000EACED0005770800000000000000CC",
                    "name": "catalogProductItems",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductItems/00030000000EACED0005770800005AF3112EDABD0000000EACED00057708000110F0808B095A0000000EACED0005770800000000000000CC/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductItems/00030000000EACED0005770800005AF3112EDABD0000000EACED00057708000110F0808B095A0000000EACED0005770800000000000000CC/child/ItemTranslation",
                    "name": "ItemTranslation",
                    "kind": "collection"
                }
            ]
        },
  .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/catalogProductItems",
            "name": "catalogProductItems",
            "kind": "collection"
        }
    ]
}
Back to Top