Get all catalog items
get
/fscmRestApi/resources/11.13.18.05/shoppingSearches/{SearchPhraseId}/child/resultItems
Request
Path Parameters
-
SearchPhraseId(required): integer(int64)
Value that uniquely identifies the search phrase.
Query Parameters
-
dependency: string
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> -
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:- ByMobileApplyFilterCriteria: Find search results according to the category or manufacturer.
Finder Variables:- bind_CategoryName; string; Name of the category.
- bind_Manufacturer; string; Name of the manufacturer.
- ByMobileVC: Find specific items when searching using a mobile.
Finder Variables: - ByMobileWithPunchoutItems: Find punchout items with catalog items.
Finder Variables: - PrimaryKey: Find search results according to the catalog item key.
Finder Variables:- CatalogItemKey; integer; Value that uniquely identifies the catalog item.
- ItemKey; string.
- ByMobileApplyFilterCriteria: Find search results according to the category or manufacturer.
-
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:- Amount; number; Amount of the item in functional currency.
- CatalogItemKey; integer; Value that uniquely identifies the catalog item.
- CategoryName; string; Name of the category that classifies the item.
- CurrencyAmount; number; Amount of the item in foreign currency.
- CurrencyCode; string; Abbreviation that identifies the currency of the item that is displayed in the search results.
- CurrencyUnitPrice; number; Price of item for each unit in foreign currency.
- FormattedAmount; string; Amount formatted for the currency.
- FormattedCurrencyAmount; string; Currency amount formatted for the currency.
- FormattedCurrencyUnitPrice; string; Value of the currency price of item for each unit formatted for the currency.
- FormattedUnitPrice; string; Price of item for each unit formatted for the currency.
- FunctionalCurrencyCode; string; Abbreviation that identifies the functional currency.
- FunctionalCurrencySymbol; string; Symbol that identifies the functional currency.
- ItemDescription; string; Description of the item that is displayed in the search results.
- ItemId; integer; Value that uniquely identifies the item.
- ItemKey; string; 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; Value that identifies the source of the item. This source can be catalog, noncatalog, quick create, punchout, requisition import, or web service.
- Manufacturer; string; Name of the party who manufactures the item.
- OrderTypeLookupCode; string; Abbreviation that identifies the lookup value for the order type. A list of accepted values include Fixed Price and Quantity.
- PunchoutCatalogId; integer; Value that uniquely identifies punchout catalog.
- PunchoutItemId; integer; Value that uniquely identifies the punchout item.
- ThumbnailImage; string; Thumbnail image of the item.
- UnitOfMeasure; string; Unit of measure that the item uses.
- UnitPrice; number; Price of item for each unit in functional currency.
-
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:
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.
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(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.
Root Schema : shoppingSearches-resultItems
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:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : shoppingSearches-resultItems-item-response
Type:
Show Source
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all catalog items.
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/shoppingSearches/SearchPhraseId/child/resultItems"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "ItemKey": "l#-2#403958#-2#US", "ItemId": -2, "PunchoutItemId": -2, "PunchoutCatalogId": -2, "ItemDescription": "14\"\" Laptop 4Mhz, 2 TB HD, DVD, Black", "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Laptop Computer", "CurrencyUnitPrice": 969, "UnitPrice": 969, "CurrencyAmount": null, "Amount": null, "Manufacturer": "Big Computers", "ThumbnailImage": "https://servername/~apawar/Strategy_Images/googlesamsun.jpg", "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "FunctionalCurrencySymbol": "$", "CatalogItemKey": 69513, "UnitOfMeasure": "Each", "FormattedUnitPrice": "969.00", "FormattedCurrencyUnitPrice": "969.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393538232D322355530000000EACED000577080000000000010F89", "name": "resultItems", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393538232D322355530000000EACED000577080000000000010F89", "name": "resultItems", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917", "name": "shoppingSearches", "kind": "item" } ] }, { "ItemKey": "l#300100089967925#-2#-2#US", "ItemId": 300100089967925, "PunchoutItemId": -2, "PunchoutCatalogId": -2, "ItemDescription": "zR13OTBI_LCM_ITM002", "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Laptop Accessory", "CurrencyUnitPrice": 5, "UnitPrice": 5, "CurrencyAmount": null, "Amount": null, "Manufacturer": null, "ThumbnailImage": null, "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "FunctionalCurrencySymbol": "$", "CatalogItemKey": 50333, "UnitOfMeasure": "Kilogram", "FormattedUnitPrice": "5.00", "FormattedCurrencyUnitPrice": "5.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/00020000001A6C23333030313030303839393637393235232D32232D322355530000000EACED00057708000000000000C49D", "name": "resultItems", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/00020000001A6C23333030313030303839393637393235232D32232D322355530000000EACED00057708000000000000C49D", "name": "resultItems", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917", "name": "shoppingSearches", "kind": "item" } ] }, { "ItemKey": "l#-2#403961#-2#US", "ItemId": -2, "PunchoutItemId": -2, "PunchoutCatalogId": -2, "ItemDescription": "Laptop Carrycase Black", "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Laptop Accessory", "CurrencyUnitPrice": 25, "UnitPrice": 25, "CurrencyAmount": null, "Amount": null, "Manufacturer": "Big Computers", "ThumbnailImage": "https://servername/~apawar/Strategy_Images/backpack-2-720x480-c.jpg", "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "FunctionalCurrencySymbol": "$", "CatalogItemKey": 69516, "UnitOfMeasure": "Each", "FormattedUnitPrice": "25.00", "FormattedCurrencyUnitPrice": "25.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393631232D322355530000000EACED000577080000000000010F8C", "name": "resultItems", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393631232D322355530000000EACED000577080000000000010F8C", "name": "resultItems", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917", "name": "shoppingSearches", "kind": "item" } ] }, { "ItemKey": "l#-2#403962#-2#US", "ItemId": -2, "PunchoutItemId": -2, "PunchoutCatalogId": -2, "ItemDescription": "Netbook Carrycase Black", "CurrencyCode": "USD", "OrderTypeLookupCode": "QUANTITY", "CategoryName": "Laptop Accessory", "CurrencyUnitPrice": 22, "UnitPrice": 22, "CurrencyAmount": null, "Amount": null, "Manufacturer": "Big Computers", "ThumbnailImage": "https://servername//~apawar/Strategy_Images/s-l1600.jpg", "ItemSource": "CATALOG", "FunctionalCurrencyCode": "USD", "FunctionalCurrencySymbol": "$", "CatalogItemKey": 69517, "UnitOfMeasure": "Each", "FormattedUnitPrice": "22.00", "FormattedCurrencyUnitPrice": "22.00", "FormattedAmount": null, "FormattedCurrencyAmount": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393632232D322355530000000EACED000577080000000000010F8D", "name": "resultItems", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems/0002000000116C232D3223343033393632232D322355530000000EACED000577080000000000010F8D", "name": "resultItems", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917", "name": "shoppingSearches", "kind": "item" } ] } ], "count": 4, "hasMore": false, "limit": 200, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/shoppingSearches/300100111676917/child/resultItems", "name": "resultItems", "kind": "collection" } ] }