Nr1_catalog_app NPM

nr1_catalog_app

Nr1CatalogApp - JavaScript client for nr1_catalog_app No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

API version: 2.18.4
Package version: 2.18.4
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install nr1_catalog_app --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your nr1_catalog_app from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('nr1_catalog_app') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/nr1_catalog_app then install it via:

    npm install YOUR_USERNAME/nr1_catalog_app --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Nr1CatalogApp = require('nr1_catalog_app');

var api = new Nr1CatalogApp.CategoryNodesApi()

var nodeId = "nodeId_example"; // {String} A unique code which is used to identify a node in hierarchy.

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);
  }
};
api.categoryNodesFindAncestors(nodeId, opts, callback);

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
Nr1CatalogApp.CategoryNodesApi	categoryNodesFindAncestors	GET /category-nodes/{nodeId}/ancestors	Retrieve ancestry information by the specified category node
Nr1CatalogApp.CategoryNodesApi	categoryNodesFindByParent	GET /category-nodes	Retrieve active category node documents by the specified search criteria.
Nr1CatalogApp.CategoryNodesApi	categoryNodesFindSuggestions	GET /category-nodes/suggestions	Retrieve Category suggestions by the specified search criteria.
Nr1CatalogApp.CategoryNodesApi	categoryNodesGet	GET /category-nodes/{nodeId}	Retrieve a category node document by the resource identifier.
Nr1CatalogApp.CategoryNodesApi	categoryNodesGetNodeSnapshot	GET /category-nodes/{nodeId}/snapshot	Get the snapshot for the specified parent node based on the provided client snapshot version.
Nr1CatalogApp.CategoryNodesApi	categoryNodesGetSnapshot	GET /category-nodes/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.CategoryNodesApi	categoryNodesSaveMultiple	PUT /category-nodes	Creates/Updates multiple category node documents.
Nr1CatalogApp.GroupsApi	groupsFindByCriteria	GET /groups	Retrieve an active group document by the specified search criteria.
Nr1CatalogApp.GroupsApi	groupsGet	GET /groups/{groupCode}	Retrieve a group document based on the provided resource identifier.
Nr1CatalogApp.GroupsApi	groupsGetSnapshot	GET /groups/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.GroupsApi	groupsSaveMultiple	PUT /groups	Creates/updates multiple groups for catalog.
Nr1CatalogApp.ItemAttributesApi	itemAttributesFindMultiple	POST /item-attributes/get-multiple	Retrieves a collection of item-attribute documents matching the item-identifiers in the request
Nr1CatalogApp.ItemAttributesApi	itemAttributesGet	GET /item-attributes/{itemCode}	Retrieve an item-attribute document by the item-attribute resource identifier.
Nr1CatalogApp.ItemAttributesApi	itemAttributesGetItemAttributesDetails	GET /item-attributes/{itemCode}/details	Get item-attributes details.
Nr1CatalogApp.ItemAttributesApi	itemAttributesGetSnapshot	GET /item-attributes/snapshot	Get the snapshot based on the provided enterprise unit.
Nr1CatalogApp.ItemAttributesApi	itemAttributesSave	PUT /item-attributes/{itemCode}	Creates/Updates an item-attribute document for a specific enterprise unit (site/store).
Nr1CatalogApp.ItemAttributesApi	itemAttributesSaveMultiple	PUT /item-attributes	Imports a mini-batch of enterprise unit specific item attributes.
Nr1CatalogApp.ItemCustomModifiersApi	itemCustomModifiersFindMultiple	POST /item-custom-modifiers/get-multiple	Retrieve a collection of matching custom item modifier documents
Nr1CatalogApp.ItemCustomModifiersApi	itemCustomModifiersGet	GET /item-custom-modifiers/{itemCode}/{linkGroupCode}/{linkedItemCode}	Retrieve an item-custom-modifier document by the resource identifier
Nr1CatalogApp.ItemCustomModifiersApi	itemCustomModifiersSaveMultiple	PUT /item-custom-modifiers	Imports a mini-batch of item custom modifier documents.
Nr1CatalogApp.ItemDetailsApi	itemDetailsFindByCriteria	GET /item-details	Find item details for criteria
Nr1CatalogApp.ItemDetailsApi	itemDetailsGet	GET /item-details/{item-identifier}	Retrieve aggregate information for single item specified item by the resource identifier.
Nr1CatalogApp.ItemDetailsApi	itemDetailsGetLinkGroups	GET /item-details/{itemCode}/link-groups	Get the link groups of an item
Nr1CatalogApp.ItemDetailsApi	itemDetailsSearch	GET /item-details/search	Search item details for criteria
Nr1CatalogApp.ItemGroupingsApi	itemGroupingsGet	GET /item-groupings/{itemCode}/{itemGroupingsType}	Retrieves an item-groupings document by the resource identifier.
Nr1CatalogApp.ItemGroupingsApi	itemGroupingsGetItemGroupingsTypeSnapshot	GET /item-groupings/snapshot/{itemGroupingsType}	Get the snapshot based on the provided client snapshot version and item-groupings type.
Nr1CatalogApp.ItemGroupingsApi	itemGroupingsGetSnapshot	GET /item-groupings/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.ItemGroupingsApi	itemGroupingsSaveMultiple	PUT /item-groupings	Creates/updates multiple item-grouping documents.
Nr1CatalogApp.ItemPricesApi	itemPricesFindMultiple	POST /item-prices/get-multiple	Retrieves a collection of item-price documents matching the item-identifiers in the request
Nr1CatalogApp.ItemPricesApi	itemPricesFindMultiplePrices	POST /item-prices/get-multiple-prices	Retrieve a collection of item-price documents grouped on item-codes
Nr1CatalogApp.ItemPricesApi	itemPricesGet	GET /item-prices/{itemCode}/{priceCode}	Retrieve an item-price document by the item-price resource identifier.
Nr1CatalogApp.ItemPricesApi	itemPricesGetPastAndPresentSnapshot	GET /item-prices/snapshot/past-and-present	Get the snapshot of current and expired prices (up to 5 days in the past) based on the provided client snapshot version.
Nr1CatalogApp.ItemPricesApi	itemPricesGetSnapshot	GET /item-prices/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.ItemPricesApi	itemPricesSave	PUT /item-prices/{itemCode}/{priceCode}	Creates/Updates an item-price document with the provided item-price document input for a specific enterprise unit (site/store).
Nr1CatalogApp.ItemPricesApi	itemPricesSaveMultiple	PUT /item-prices	Imports a mini-batch of item-price documents.
Nr1CatalogApp.ItemsApi	itemsFindByCriteria	GET /items	Retrieve item document/s by the specified search criteria.
Nr1CatalogApp.ItemsApi	itemsFindMultiple	POST /items/get-multiple	Retrieve items by the specified item codes or package identifiers.
Nr1CatalogApp.ItemsApi	itemsFindSuggestions	GET /items/suggestions	Retrieve item suggestions by the specified search criteria.
Nr1CatalogApp.ItemsApi	itemsGet	GET /items/{itemCode}	Retrieve an item document by the resource identifier.
Nr1CatalogApp.ItemsApi	itemsGetSnapshot	GET /items/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.ItemsApi	itemsSave	PUT /items/{itemCode}	Creates/Updates a catalog item document.
Nr1CatalogApp.ItemsApi	itemsSaveMultiple	PUT /items	Imports a mini-batch of catalog items.
Nr1CatalogApp.LinkGroupsApi	linkGroupsFindByCriteria	GET /link-groups	Retrieve active link-group documents by the specified search criteria.
Nr1CatalogApp.LinkGroupsApi	linkGroupsGet	GET /link-groups/{linkGroupCode}	Retrieves a link group document by the resource identifier.
Nr1CatalogApp.LinkGroupsApi	linkGroupsGetSnapshot	GET /link-groups/snapshot	Get the snapshot based on the provided client snapshot version.
Nr1CatalogApp.LinkGroupsApi	linkGroupsSave	PUT /link-groups/{linkGroupCode}	Creates/Updates a link-group document.
Nr1CatalogApp.LinkGroupsApi	linkGroupsSaveMultiple	PUT /link-groups	Imports a mini-batch of link group documents.
Nr1CatalogApp.SubscriptionsApi	addSubscription1	POST /subscriptions
Nr1CatalogApp.SubscriptionsApi	subscriptionsDeleteSubscription	DELETE /subscriptions/{name}
Nr1CatalogApp.SubscriptionsApi	subscriptionsGetSubscription	GET /subscriptions/{name}
Nr1CatalogApp.SubscriptionsApi	subscriptionsSearchSubscriptions	GET /subscriptions

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

nr1_catalog_app querystring superagent

@everything-registry/sub-chunk-2350 nr1_catalog_app

2 years ago

2 years ago

2 years ago

2 years ago