# Nr1CatalogApp.ItemDetailsApi

All URIs are relative to *http://api.ncr.com/catalog/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**itemDetailsFindByCriteria**](ItemDetailsApi.md#itemDetailsFindByCriteria) | **GET** /item-details | Find item details for criteria
[**itemDetailsGet**](ItemDetailsApi.md#itemDetailsGet) | **GET** /item-details/{item-identifier} | Retrieve aggregate information for single item specified item by the resource identifier.
[**itemDetailsGetLinkGroups**](ItemDetailsApi.md#itemDetailsGetLinkGroups) | **GET** /item-details/{itemCode}/link-groups | Get the link groups of an item
[**itemDetailsSearch**](ItemDetailsApi.md#itemDetailsSearch) | **GET** /item-details/search | Search item details for criteria


<a name="itemDetailsFindByCriteria"></a>
# **itemDetailsFindByCriteria**
> FindItemsDetailsResponse itemDetailsFindByCriteria(nepEnterpriseUnit, opts)

Find item details for criteria

<p>This API fetches item details for requested search criteria for an enterprise unit. The search criteria is passed as a query parameter with the API request. Items will be implicitly filtered out based on the following item-price criteria <br/><ol><li/>Base price is false <li/>INACTIVE prices<li/>Valid item-prices at the time of API call </ol></p><p><h3>Input parameter:- </h3> <code>request:</code> Finder criteria containing an enterprise unit (mandatory) and filter date (always in UTC).<br/><h3>Returns:</h3> Item details for the criteria</p>

### Example
```javascript
var Nr1CatalogApp = require('nr1_catalog_app');

var apiInstance = new Nr1CatalogApp.ItemDetailsApi();

var nepEnterpriseUnit = "nepEnterpriseUnit_example"; // String | Enterprise unit id.

var opts = { 
  'pageNumber': 0, // Number | The requested page number (starting from zero)
  'pageSize': 200, // Number | The page size
  'filterDate': new Date("2013-10-20T19:20:30+01:00"), // Date | A filter date to filter item prices (inclusive of start and exclusive of end date).  If prices base price is set to true then this date won't be consider
  'nepCorrelationId': "nepCorrelationId_example", // String | A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes
  'nepOrganization': "nepOrganization_example" // String | The organization the request applies to
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.itemDetailsFindByCriteria(nepEnterpriseUnit, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **nepEnterpriseUnit** | **String**| Enterprise unit id. | 
 **pageNumber** | **Number**| The requested page number (starting from zero) | [optional] [default to 0]
 **pageSize** | **Number**| The page size | [optional] [default to 200]
 **filterDate** | **Date**| A filter date to filter item prices (inclusive of start and exclusive of end date).  If prices base price is set to true then this date won't be consider | [optional] 
 **nepCorrelationId** | **String**| A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes | [optional] 
 **nepOrganization** | **String**| The organization the request applies to | [optional] 

### Return type

[**FindItemsDetailsResponse**](FindItemsDetailsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="itemDetailsGet"></a>
# **itemDetailsGet**
> GetItemDetailsResponse itemDetailsGet(itemIdentifier, nepEnterpriseUnit, opts)

Retrieve aggregate information for single item specified item by the resource identifier.

<p>This API retrieves an aggregate of item data (from item, item-attribute and item-prices) for the provided <b>item-identifier</b>. This API is executed on a context of a single enterprise unit which is expected to be passed as a standard header. <b>It binds ACTIVE item-prices of item which are valid at the time of API call (valid item-prices).</b> Return item is never null<br/></p><p><h3>Input parameter:- </h3> <code>request:</code> Identifier for the item to retrieve.<br/><h3>Returns:</h3> Response object containing all known attributes for the specified item; never null.</p>

### Example
```javascript
var Nr1CatalogApp = require('nr1_catalog_app');

var apiInstance = new Nr1CatalogApp.ItemDetailsApi();

var itemIdentifier = "itemIdentifier_example"; // String | Item code. This field could either be the primary item identifier or a package identifier without the type.

var nepEnterpriseUnit = "nepEnterpriseUnit_example"; // String | Enterprise unit id.

var opts = { 
  'nepCorrelationId': "nepCorrelationId_example", // String | A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes
  'nepOrganization': "nepOrganization_example" // String | The organization the request applies to
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.itemDetailsGet(itemIdentifier, nepEnterpriseUnit, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **itemIdentifier** | **String**| Item code. This field could either be the primary item identifier or a package identifier without the type. | 
 **nepEnterpriseUnit** | **String**| Enterprise unit id. | 
 **nepCorrelationId** | **String**| A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes | [optional] 
 **nepOrganization** | **String**| The organization the request applies to | [optional] 

### Return type

[**GetItemDetailsResponse**](GetItemDetailsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="itemDetailsGetLinkGroups"></a>
# **itemDetailsGetLinkGroups**
> GetItemLinkGroupsResponse itemDetailsGetLinkGroups(itemCode, opts)

Get the link groups of an item

Get all the nested link groups (including linked items with in a link group) details of an item.

### Example
```javascript
var Nr1CatalogApp = require('nr1_catalog_app');

var apiInstance = new Nr1CatalogApp.ItemDetailsApi();

var itemCode = "itemCode_example"; // String | An item's unique identifier

var opts = { 
  'nepEnterpriseUnit': "nepEnterpriseUnit_example", // String | An Enterprise unit identifier for which the link groups are defined.  If not passed then link groups will be found globally (tenant level)
  'nepCorrelationId': "nepCorrelationId_example", // String | A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes
  'nepOrganization': "nepOrganization_example" // String | The organization the request applies to
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.itemDetailsGetLinkGroups(itemCode, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **itemCode** | **String**| An item's unique identifier | 
 **nepEnterpriseUnit** | **String**| An Enterprise unit identifier for which the link groups are defined.  If not passed then link groups will be found globally (tenant level) | [optional] 
 **nepCorrelationId** | **String**| A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes | [optional] 
 **nepOrganization** | **String**| The organization the request applies to | [optional] 

### Return type

[**GetItemLinkGroupsResponse**](GetItemLinkGroupsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="itemDetailsSearch"></a>
# **itemDetailsSearch**
> SearchItemDetailsResponse itemDetailsSearch(nepEnterpriseUnit, opts)

Search item details for criteria

<p>This API finds item details for request search criteria for an enterprise unit. The search criteria is passed as a query parameter with the API request. <p><h3>Input parameter:- </h3> <code>request:</code> Search criteria containing an enterprise unit (mandatory).<br/><br/><h3>Returns:</h3> Item details for the criteria

### Example
```javascript
var Nr1CatalogApp = require('nr1_catalog_app');

var apiInstance = new Nr1CatalogApp.ItemDetailsApi();

var nepEnterpriseUnit = "nepEnterpriseUnit_example"; // String | Enterprise unit id.

var opts = { 
  'pageNumber': 0, // Number | The requested page number (starting from zero)
  'pageSize': 200, // Number | The page size
  'itemCodePattern': "itemCodePattern_example", // String | Item Code pattern to use for a search (standard wildcard matching rules apply).
  'packageIdentifierPattern': "packageIdentifierPattern_example", // String | Pattern for package identifier (any type) to use for a search (standard wildcard matching rules apply).
  'longDescriptionPattern': "longDescriptionPattern_example", // String | Pattern for long description to use for a search (standard wildcard matching rules apply).
  'shortDescriptionPattern': "shortDescriptionPattern_example", // String | Pattern for short description to use for a search (standard wildcard matching rules apply).
  'itemStatus': "itemStatus_example", // String | Item status to use for a search.
  'merchandiseCategoryId': "merchandiseCategoryId_example", // String | Merchandise category code to use for a search. Exact match against the code to which the item belongs or any of the parent nodes.
  'sortDirection': "ASC", // String | Sort direction to the apply to the search results.
  'sortField': "SHORT_DESCRIPTION", // String | Specifies the field on which to sort the items.
  'filterDate': new Date("2013-10-20T19:20:30+01:00"), // Date | A filter date to filter item prices (inclusive of start and exclusive of end date).  If prices base price is set to true then this date won't be consider
  'groupCode': "groupCode_example", // String | Group code to use for a search. Exact match against the code to which the item belongs.
  'linkGroupCode': "linkGroupCode_example", // String | Link group code to use for a search. Exact match against the code to which the item belongs.
  'nepCorrelationId': "nepCorrelationId_example", // String | A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes
  'nepOrganization': "nepOrganization_example" // String | The organization the request applies to
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.itemDetailsSearch(nepEnterpriseUnit, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **nepEnterpriseUnit** | **String**| Enterprise unit id. | 
 **pageNumber** | **Number**| The requested page number (starting from zero) | [optional] [default to 0]
 **pageSize** | **Number**| The page size | [optional] [default to 200]
 **itemCodePattern** | **String**| Item Code pattern to use for a search (standard wildcard matching rules apply). | [optional] 
 **packageIdentifierPattern** | **String**| Pattern for package identifier (any type) to use for a search (standard wildcard matching rules apply). | [optional] 
 **longDescriptionPattern** | **String**| Pattern for long description to use for a search (standard wildcard matching rules apply). | [optional] 
 **shortDescriptionPattern** | **String**| Pattern for short description to use for a search (standard wildcard matching rules apply). | [optional] 
 **itemStatus** | **String**| Item status to use for a search. | [optional] 
 **merchandiseCategoryId** | **String**| Merchandise category code to use for a search. Exact match against the code to which the item belongs or any of the parent nodes. | [optional] 
 **sortDirection** | **String**| Sort direction to the apply to the search results. | [optional] [default to ASC]
 **sortField** | **String**| Specifies the field on which to sort the items. | [optional] [default to SHORT_DESCRIPTION]
 **filterDate** | **Date**| A filter date to filter item prices (inclusive of start and exclusive of end date).  If prices base price is set to true then this date won't be consider | [optional] 
 **groupCode** | **String**| Group code to use for a search. Exact match against the code to which the item belongs. | [optional] 
 **linkGroupCode** | **String**| Link group code to use for a search. Exact match against the code to which the item belongs. | [optional] 
 **nepCorrelationId** | **String**| A unique ID that can be used to correlate one or more related requests for debugging or tracing purposes | [optional] 
 **nepOrganization** | **String**| The organization the request applies to | [optional] 

### Return type

[**SearchItemDetailsResponse**](SearchItemDetailsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined