Xi_sdk_resellers NPM

xi_sdk_resellers

XiSdkResellers - JavaScript client for xi_sdk_resellers

For resellers seeking to innovate with Ingram Micro's API solutions, automate your eCommerce experience with our array of API's and webhooks to craft a seamless journey for your customers.

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 xi_sdk_resellers --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your xi_sdk_resellers from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

The library is hosted in the git repository, https://github.com/ingrammicro-xvantage/xi-sdk-resellers-node install it via:

    npm install ingrammicro-xvantage/xi-sdk-resellers-node

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):

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

Quickstart on creating an application can be found here

var XiSdkResellers = require('xi_sdk_resellers');


var api = new XiSdkResellers.AccesstokenApi()
var grantType = "client_credentials"; // {String} Keep grant_type as client_credentials only.
var clientId = "clientId_example"; // {String} 
var clientSecret = "clientSecret_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccesstoken(grantType, clientId, clientSecret, callback);

Documentation for API Endpoints

All URIs are relative to https://api.ingrammicro.com:443

Class	Method	HTTP request	Description
XiSdkResellers.AccesstokenApi	getAccesstoken	GET /oauth/oauth20/token	Accesstoken
XiSdkResellers.DealsApi	getResellersV6Dealsdetails	GET /resellers/v6/deals/{dealId}	Deals Details
XiSdkResellers.DealsApi	getResellersV6Dealssearch	GET /resellers/v6/deals/search	Deals Search
XiSdkResellers.FreightEstimateApi	postFreightestimate	POST /resellers/v6/freightestimate	Freight Estimate
XiSdkResellers.InvoicesApi	getInvoicedetailsV61	GET /resellers/v6.1/invoices/{invoiceNumber}	Get Invoice Details v6.1
XiSdkResellers.InvoicesApi	getResellersV6Invoicesearch	GET /resellers/v6/invoices	Search your invoice
XiSdkResellers.OrderStatusApi	resellersV1WebhooksOrderstatuseventPost	POST /resellers/v1/webhooks/orderstatusevent	Order Status
XiSdkResellers.OrdersApi	deleteOrdercancel	DELETE /resellers/v6/orders/{OrderNumber}	Cancel your Order
XiSdkResellers.OrdersApi	getOrderdetailsV61	GET /resellers/v6.1/orders/{ordernumber}	Get Order Details v6.1
XiSdkResellers.OrdersApi	getResellersV6Ordersearch	GET /resellers/v6/orders/search	Search your Orders
XiSdkResellers.OrdersApi	postCreateorderV6	POST /resellers/v6/orders	Create your Order
XiSdkResellers.OrdersApi	postCreateorderV7	POST /resellers/v7/orders	Create your Order v7
XiSdkResellers.OrdersApi	putOrdermodify	PUT /resellers/v6/orders/{orderNumber}	Modify your Order
XiSdkResellers.ProductCatalogApi	getResellerV6Productdetail	GET /resellers/v6/catalog/details/{ingramPartNumber}	Product Details
XiSdkResellers.ProductCatalogApi	getResellerV6Productsearch	GET /resellers/v6/catalog	Search Products
XiSdkResellers.ProductCatalogApi	postPriceandavailability	POST /resellers/v6/catalog/priceandavailability	Price and Availability
XiSdkResellers.QuotesApi	getQuotessearchV6	GET /resellers/v6/quotes/search	Quote Search
XiSdkResellers.QuotesApi	getResellerV6ValidateQuote	GET /resellers/v6/q2o/validatequote	Validate Quote
XiSdkResellers.QuotesApi	getResellersV6Quotes	GET /resellers/v6/quotes/{quoteNumber}	Get Quote Details
XiSdkResellers.RenewalsApi	getResellersV6Renewalsdetails	GET /resellers/v6/renewals/{renewalId}	Renewals Details
XiSdkResellers.RenewalsApi	postRenewalssearch	POST /resellers/v6/renewals/search	Renewals Search
XiSdkResellers.ReturnsApi	getResellersV6Returnsdetails	GET /resellers/v6/returns/{caseRequestNumber}	Returns Details
XiSdkResellers.ReturnsApi	getResellersV6Returnssearch	GET /resellers/v6/returns/search	Returns Search
XiSdkResellers.ReturnsApi	postReturnscreate	POST /resellers/v6/returns/create	Returns Create
XiSdkResellers.StockUpdateApi	resellersV1WebhooksAvailabilityupdatePost	POST /resellers/v1/webhooks/availabilityupdate	Stock Update