Get all search items
get
/fscmRestApi/resources/11.13.18.05/shoppingSearches
Request
Query Parameters
-
expand: string
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).
-
fields: string
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 -
finder: string
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: Find search results according to the search phrased identifier.
Finder Variables:- SearchPhraseId; integer; Value that uniquely identifies the search phrases.
- PrimaryKey: Find search results according to the search phrased identifier.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- RequisitioningBUId; integer; Value that uniquely identifies the requisitioning BU in which the search was run.
- SearchDate; string; Date when the search was conducted.
- SearchPhraseId; integer; Value that uniquely identifies the search phrase.
- SearchPhraseTerms; string; String of characters that you can use to search.
-
totalResults: boolean
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
-
Metadata-Context: string
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: string
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : shoppingSearches
Type:
Show Source
object-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shoppingSearches-item-response
Type:
Show Source
object-
brandFilters: array
Brand Filters
Title:
Brand FiltersThe Brand Filters resource filters the items in the search results into distinct brands. -
links: array
Links
Title:
LinksThe 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 ItemsThe Result Items resource manages the search results. -
resultPunchoutCatalogs: array
Result Punchout Catalogs
Title:
Result Punchout CatalogsThe Result Punchout Catalogs resource manages the punchout catalogs from the search results. -
SearchDate: string
(date)
Read Only:
trueDate when the search was conducted. -
SearchPhraseId: integer
(int64)
Value that uniquely identifies the search phrase.
-
SearchPhraseTerms: string
Maximum Length:
700String of characters that you can use to search.
Nested Schema : Brand Filters
Type:
arrayTitle:
Brand FiltersThe Brand Filters resource filters the items in the search results into distinct brands.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Result Items
Type:
arrayTitle:
Result ItemsThe Result Items resource manages the search results.
Show Source
Nested Schema : Result Punchout Catalogs
Type:
arrayTitle:
Result Punchout CatalogsThe Result Punchout Catalogs resource manages the punchout catalogs from the search results.
Show Source
Nested Schema : shoppingSearches-brandFilters-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Manufacturer: string
Read Only:
trueMaximum Length:255Name of the party who manufactures the item. -
TotalItems: string
Total count of the items from a particular manufacturer.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : shoppingSearches-resultItems-item-response
Type:
Show Source
object-
Amount: number
Title:
AmountAmount of the item in functional currency. -
CatalogItemKey: integer
(int64)
Read Only:
trueValue that uniquely identifies the catalog item. -
CategoryName: string
Read Only:
trueMaximum Length:250Name of the category that classifies the item. -
CurrencyAmount: number
Title:
AmountAmount of the item in foreign currency. -
CurrencyCode: string
Read Only:
trueMaximum Length:32Abbreviation that identifies the currency of the item that is displayed in the search results. -
CurrencyUnitPrice: number
Title:
PriceRead Only:truePrice of item for each unit in foreign currency. -
FormattedAmount: string
Read Only:
trueAmount formatted for the currency. -
FormattedCurrencyAmount: string
Read Only:
trueCurrency amount formatted for the currency. -
FormattedCurrencyUnitPrice: string
Read Only:
trueValue of the currency price of item for each unit formatted for the currency. -
FormattedUnitPrice: string
Read Only:
truePrice of item for each unit formatted for the currency. -
FunctionalCurrencyCode: string
Read Only:
trueMaximum Length:32Abbreviation that identifies the functional currency. -
FunctionalCurrencySymbol: string
Read Only:
trueSymbol that identifies the functional currency. -
ItemDescription: string
Title:
DescriptionRead Only:trueMaximum Length:960Description of the item that is displayed in the search results. -
ItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the item. -
ItemKey: string
Read Only:
trueMaximum Length:88Value 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:
trueMaximum Length:255Default Value:CATALOGValue 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:
LinksThe link relations associated with the resource instance. -
Manufacturer: string
Title:
BrandRead Only:trueMaximum Length:700Name of the party who manufactures the item. -
OrderTypeLookupCode: string
Title:
Line TypeRead Only:trueMaximum Length:25Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity. -
PunchoutCatalogId: integer
(int64)
Read Only:
trueValue that uniquely identifies punchout catalog. -
PunchoutItemId: integer
(int64)
Read Only:
trueValue that uniquely identifies the punchout item. -
ThumbnailImage: string
Maximum Length:
700Thumbnail image of the item. -
UnitOfMeasure: string
Read Only:
trueUnit of measure that the item uses. -
UnitPrice: number
Title:
PriceRead Only:truePrice of item for each unit in functional currency.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : shoppingSearches-resultPunchoutCatalogs-item-response
Type:
Show Source
object-
CatalogId: integer
(int64)
Read Only:
trueValue that uniquely identifies the punchout catalog. -
CatalogName: string
Read Only:
trueMaximum Length:30Name of the punchout catalog that is displayed in the search results. -
ImageURL: string
Read Only:
trueURL (Uniform Resource Locator) of the image of the item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PunchoutURL: string
Read Only:
trueURL (Uniform Resource Locator) of the image of the punchout catalog.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source