Create one search phrase
/fscmRestApi/resources/11.13.18.05/shoppingSearches
Request
-
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.
- application/json
object
-
brandFilters: array
Brand Filters
Title:
Brand Filters
The Brand Filters resource filters the items in the search results into distinct brands. -
RequisitioningBUId(required): integer
(int64)
Value that uniquely identifies the requisitioning BU in which the search was run.
-
resultItems: array
Result Items
Title:
Result Items
The Result Items resource manages the search results. -
resultPunchoutCatalogs: array
Result Punchout Catalogs
Title:
Result Punchout Catalogs
The Result Punchout Catalogs resource manages the punchout catalogs from the search results. -
SearchPhraseId: integer
(int64)
Value that uniquely identifies the search phrase.
-
SearchPhraseTerms(required): string
Maximum Length:
700
String of characters that you can use to search.
array
Brand Filters
array
Result Items
array
Result Punchout Catalogs
object
-
TotalItems: string
Total count of the items from a particular manufacturer.
object
-
Amount: number
Title:
Amount
Amount of the item in functional currency. -
CurrencyAmount: number
Title:
Amount
Amount of the item in foreign currency. -
ThumbnailImage: string
Maximum Length:
700
Thumbnail image of the item.
Response
- application/json
Default Response
-
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.
object
-
brandFilters: array
Brand Filters
Title:
Brand Filters
The Brand Filters resource filters the items in the search results into distinct brands. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning BU in which the search was run.
-
resultItems: array
Result Items
Title:
Result Items
The Result Items resource manages the search results. -
resultPunchoutCatalogs: array
Result Punchout Catalogs
Title:
Result Punchout Catalogs
The Result Punchout Catalogs resource manages the punchout catalogs from the search results. -
SearchDate: string
(date)
Read Only:
true
Date when the search was conducted. -
SearchPhraseId: integer
(int64)
Value that uniquely identifies the search phrase.
-
SearchPhraseTerms: string
Maximum Length:
700
String of characters that you can use to search.
array
Brand Filters
array
Links
array
Result Items
array
Result Punchout Catalogs
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Manufacturer: string
Read Only:
true
Maximum Length:255
Name of the party who manufactures the item. -
TotalItems: string
Total count of the items from a particular manufacturer.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
Amount: number
Title:
Amount
Amount of the item in functional currency. -
CatalogItemKey: integer
(int64)
Read Only:
true
Value that uniquely identifies the catalog item. -
CategoryName: string
Read Only:
true
Maximum Length:250
Name of the category that classifies the item. -
CurrencyAmount: number
Title:
Amount
Amount of the item in foreign currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:32
Abbreviation that identifies the currency of the item that is displayed in the search results. -
CurrencyUnitPrice: number
Title:
Price
Read Only:true
Price of item for each unit in foreign currency. -
FormattedAmount: string
Read Only:
true
Amount formatted for the currency. -
FormattedCurrencyAmount: string
Read Only:
true
Currency amount formatted for the currency. -
FormattedCurrencyUnitPrice: string
Read Only:
true
Value of the currency price of item for each unit formatted for the currency. -
FormattedUnitPrice: string
Read Only:
true
Price of item for each unit formatted for the currency. -
FunctionalCurrencyCode: string
Read Only:
true
Maximum Length:32
Abbreviation that identifies the functional currency. -
FunctionalCurrencySymbol: string
Read Only:
true
Symbol that identifies the functional currency. -
ItemDescription: string
Title:
Description
Read Only:true
Maximum Length:960
Description of the item that is displayed in the search results. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item. -
ItemKey: string
Read Only:
true
Maximum Length:88
Value that uniquely identifies the item. It is a key that the application generates when it searches for the item. It is the combination of item identifier, source document line identifier, language, and punchout item identifier. -
ItemSource: string
Read Only:
true
Maximum Length:255
Default Value:CATALOG
Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Manufacturer: string
Title:
Brand
Read Only:true
Maximum Length:700
Name of the party who manufactures the item. -
OrderTypeLookupCode: string
Title:
Line Type
Read Only:true
Maximum Length:25
Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity. -
PunchoutCatalogId: integer
(int64)
Read Only:
true
Value that uniquely identifies punchout catalog. -
PunchoutItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the punchout item. -
ThumbnailImage: string
Maximum Length:
700
Thumbnail image of the item. -
UnitOfMeasure: string
Read Only:
true
Unit of measure that the item uses. -
UnitPrice: number
Title:
Price
Read Only:true
Price of item for each unit in functional currency.
array
Links
object
-
CatalogId: integer
(int64)
Read Only:
true
Value that uniquely identifies the punchout catalog. -
CatalogName: string
Read Only:
true
Maximum Length:30
Name of the punchout catalog that is displayed in the search results. -
ImageURL: string
Read Only:
true
URL (Uniform Resource Locator) of the image of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PunchoutURL: string
Read Only:
true
URL (Uniform Resource Locator) of the image of the punchout catalog.
array
Links
- brandFilters
-
Parameters:
- SearchPhraseId:
$request.path.SearchPhraseId
The Brand Filters resource filters the items in the search results into distinct brands. - SearchPhraseId:
- resultItems
-
Parameters:
- SearchPhraseId:
$request.path.SearchPhraseId
The Result Items resource manages the search results. - SearchPhraseId:
- resultPunchoutCatalogs
-
Operation: /fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultPunchoutCatalogsParameters:
- SearchPhraseId:
$request.path.SearchPhraseId
The Result Punchout Catalogs resource manages the punchout catalogs from the search results. - SearchPhraseId:
Examples
This example describes how to create one search phrase.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/shoppingSearches"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SearchPhraseTerms": "1002258" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "SearchPhraseId":300100124738549, "SearchDate":"2018-03-16", "SearchPhraseTerms":"1002258", "RequisitioningBUId":204, "links":[ { "rel":"self", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549", "name":"shoppingSearches", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549", "name":"shoppingSearches", "kind":"item" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultItems", "name":"resultItems", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/brandFilters", "name":"brandFilters", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124738549/child/resultPunchoutCatalogs", "name":"resultPunchoutCatalogs", "kind":"collection" } ] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format to get the result items from the search results. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SearchPhraseTerms":"Laptop Desc" }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "SearchPhraseId":300100124920663, "SearchDate":"2018-03-16", "SearchPhraseTerms":"Laptop Desc", "RequisitioningBUId":204, "links":[ { "rel":"self", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663", "name":"shoppingSearches", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663", "name":"shoppingSearches", "kind":"item" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultItems", "name":"resultItems", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/brandFilters", "name":"brandFilters", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920663/child/resultPunchoutCatalogs", "name":"resultPunchoutCatalogs", "kind":"collection" } ] }
Example 3 Request Body
The following example includes the contents of the request body in JSON format to get the punchout catalogs from the search results. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SearchPhraseTerms":"Rest_Punchout" }
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{ "SearchPhraseId":300100124920640, "SearchDate":"2018-03-16", "SearchPhraseTerms":"Rest_Punchout", "RequisitioningBUId":204, "links":[ { "rel":"self", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640", "name":"shoppingSearches", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640", "name":"shoppingSearches", "kind":"item" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultItems", "name":"resultItems", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/brandFilters", "name":"brandFilters", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920640/child/resultPunchoutCatalogs", "name":"resultPunchoutCatalogs", "kind":"collection" } ] }
Example 4 Request Body
The following example includes the contents of the request body in JSON format to get the items in the search results into distinct brands.. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SearchPhraseTerms":"Laptop" }
Example 4 Response Body
The following example includes the contents of the response body in JSON format:
{ "SearchPhraseId":300100124920664, "SearchDate":"2018-03-16", "SearchPhraseTerms":"Laptop", "RequisitioningBUId":204, "links":[ { "rel":"self", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664", "name":"shoppingSearches", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664", "name":"shoppingSearches", "kind":"item" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultItems", "name":"resultItems", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/brandFilters", "name":"brandFilters", "kind":"collection" }, { "rel":"child", "href":"https://servername/fscmRestApi/resources/version/shoppingSearches/300100124920664/child/resultPunchoutCatalogs", "name":"resultPunchoutCatalogs", "kind":"collection" } ] }