1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Shopping Catalog Item Details

Get one item detail

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogItemDetails/{SearchObjectId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : shoppingCatalogItemDetails-item-response
Type: object
Show Source
Nested Schema : Buying Options
Type: array
Title: Buying Options
The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.
Show Source
Nested Schema : Item GTIN Relationships
Type: array
Title: Item GTIN Relationships
The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.
Show Source
Nested Schema : Item Images
Type: array
Title: Item Images
The Item Images resource gets the images for the master item.
Show Source
Nested Schema : Item Manufacturers
Type: array
Title: Item Manufacturers
The Item Manufacturers resource gets the manufacturer details for the master item.
Show Source
Nested Schema : Item Suppliers
Type: array
Title: Item Suppliers
The Item Suppliers resource gets the supplier details for the master item.
Show Source
Nested Schema : shoppingCatalogItemDetails-buyingOptions-item-response
Type: object
Show Source
Nested Schema : shoppingCatalogItemDetails-itemGTINRelationships-item-response
Type: object
Show Source
  • Title: GTIN
    Read Only: true
    Maximum Length: 255
    Value that uniquely identifies the global trade item number (GTIN) of the master item.
  • Links
  • Read Only: true
    Maximum Length: 255
    Type of party of the global trade item number (GTIN). Values can be blank, a supplier, or a manufacturer.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the unit of measure for which the global trade item number (GTIN) is defined.
Nested Schema : shoppingCatalogItemDetails-itemImages-item-response
Type: object
Show Source
  • Title: DownloadInfo
    JSON formatted string containing information required to programmatically retrieve a file attachment.
  • Title: File Web Image
    Read Only: true
    Base64-encoded image of the file displayed in .png format if the source is a convertible image.
  • Read Only: true
    Uniform resource locator (URL) of the item image.
  • Links
Nested Schema : shoppingCatalogItemDetails-itemManufacturers-item-response
Type: object
Show Source
  • Links
  • Title: Manufacturer
    Read Only: true
    Maximum Length: 360
    Name of the manufacturer of the item.
  • Title: Manufacturer Part Number
    Read Only: true
    Maximum Length: 150
    Number issued by the manufacturer that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.
Nested Schema : shoppingCatalogItemDetails-itemSuppliers-item-response
Type: object
Show Source
  • Links
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier of the master item.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 150
    Number issued by the supplier that uniquely identifies the individual part. This attribute differentiates the part from similar parts and counterfeits.
Links
buyingOptions
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
The Buying Options resource gets the different buying options when an item is referenced by multiple agreements.
getItemExtendedAttributes
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
Retrieves extensible flexfields associated with an item.
itemGTINRelationships
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
The Item GTIN Relationships resource gets the global trade item number (GTIN) details for the master item.
itemImages
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
The Item Images resource gets the images for the master item.
itemManufacturers
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
The Item Manufacturers resource gets the manufacturer details for the master item.
itemSuppliers
Parameters:
  • SearchObjectId: $request.path.SearchObjectId
The Item Suppliers resource gets the supplier details for the master item.
Back to Top

Examples

This example describes how to get one item detail.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/SearchObjectId"

For example, the following command gets one item detail:

curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments/4011"

Example Response Body

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

{
	"items": [
	{
		"SearchObjectId": 100100139952304,
		"SupplierPartAuxid": "Aux1234",
		"Availability": "Available",
		"PackagingString": "EA 5/BX 5",
		"LeadTime": 10,
		"LongDescription": "Mother Board for the internal laptops",
		"Comments": "This agreement is for internal user",
		"CategoryName": "Miscellaneous_1",
		"VendorName": "CV_SuppA01",
		"UnitOfMeasure": "Each",
		"Amount": 1000,
		"UnitPrice": 100,
		"Quantity": 10,
		"CurrencyCode": "USD",
		"ShortDescription": "Mother board",
		"Manufacturer": "Dell",
		"ImageURL": "https://images.example.com/photo-1516424716439-aeccb78c41c8?ixlib=rb-1.2.1",
		"LineType": "Goods",
		"ManufacturerPartNumber": "Part1234",
		"SourceDocumentHeaderId": 556300,
		"SourceDocumentLineId": 534087,
		"SourceDocumentNumber": "1002737",
		"UNSPSC": "345353",
		"UOMCode": "Ea",
		"Item": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304",
			"name": "shoppingCatalogItemDetails",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304",
			"name": "shoppingCatalogItemDetails",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemGTINRelationships",
			"name": "itemGTINRelationships",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemImages",
			"name": "itemImages",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemManufacturers",
			"name": "itemManufacturers",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails/100100139952304/child/itemSuppliers",
			"name": "itemSuppliers",
			"kind": "collection"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/shoppingCatalogItemDetails",
		"name": "shoppingCatalogItemDetails",
		"kind": "collection"
	}
	]
}
Back to Top