0.0.3 • Published 1 year ago

reseller_api v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

xi_sdk_resellers

XiSdkResellers - JavaScript client for xi_sdk_resellers For Resellers. Who are looking to Innovate with Ingram Micro's API SolutionsAutomate your eCommerce with our offering of APIs and Webhooks to create a seamless experience for your customers. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.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 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

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

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 XiSdkResellers = require('xi_sdk_resellers');

var defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
var application = defaultClient.authentications['application'];
application.accessToken = "YOUR ACCESS TOKEN"

var api = new XiSdkResellers.DealsApi()
var iMCustomerNumber = 20-222222; // {String} Your unique Ingram Micro customer number.
var iMCountryCode = US; // {String} Two-character ISO country code.
var iMCorrelationID = fbac82ba-cf0a-4bcf-fc03-0c5084; // {String} Unique transaction number to identify each transaction across all the systems.
var iMApplicationId = MyCompany; // {String} Unique value used to identify the sender of the transaction. Example: MyCompany
var iMEnvironment = prodChicago; // {String} Environment name.
var dealId = 12345678; // {String} Unique deal ID.
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getResellersV6Dealsdetails(iMCustomerNumber, iMCountryCode, iMCorrelationID, iMApplicationId, iMEnvironment, dealId, callback);

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
XiSdkResellers.DealsApigetResellersV6DealsdetailsGET /resellers/v6/deals/{dealId}Deals Details
XiSdkResellers.DealsApigetResellersV6DealssearchGET /resellers/v6/deals/searchDeals Search
XiSdkResellers.FreightEstimateApipostFreightestimatePOST /resellers/v6/freightestimateFreight Estimate
XiSdkResellers.InvoicesApigetInvoicedetailsV61GET /resellers/v6.1/invoices/{invoiceNumber}Get Invoice Details v6.1
XiSdkResellers.InvoicesApigetResellersV6InvoicesearchGET /resellers/v6/invoicesSearch your invoice
XiSdkResellers.InvoicesV4ApipostV4InvoicedetailsPOST /invoices/v4/invoicedetailsGet Invoice Details
XiSdkResellers.InvoicesV5ApigetInvoicesGET /resellers/v5/invoices/{invoiceNumber}Get Invoice Details
XiSdkResellers.InvoicesV6ApigetInvoicedetailsV6GET /resellers/v6/invoices/{invoicenumber}Get Invoice Details v6
XiSdkResellers.OrderStatusApiresellersV1WebhooksOrderstatuseventPostPOST /resellers/v1/webhooks/orderstatuseventOrder Status
XiSdkResellers.OrdersApideleteOrdercancelDELETE /resellers/v6/orders/{OrderNumber}Cancel your Order
XiSdkResellers.OrdersApigetOrderdetailsV61GET /resellers/v6.1/orders/{ordernumber}Get Order Details v6.1
XiSdkResellers.OrdersApigetResellersV6OrdersearchGET /resellers/v6/orders/searchSearch your Orders
XiSdkResellers.OrdersApipostCreateorderV6POST /resellers/v6/ordersCreate your Order
XiSdkResellers.OrdersApiputOrdermodifyPUT /resellers/v6/orders/{orderNumber}Modify your Order
XiSdkResellers.OrdersV4ApipostV4OrdercreatePOST /orders/v4/ordercreateCreate a new Order
XiSdkResellers.OrdersV4ApipostV4OrderdeletePOST /orders/v4/orderdeleteDelete an Order
XiSdkResellers.OrdersV4ApipostV4OrderdetailsPOST /orders/v4/orderdetailsGet Order Details
XiSdkResellers.OrdersV4ApipostV4OrdermodifyPOST /orders/v4/ordermodifyModify an Existing Order
XiSdkResellers.OrdersV4ApipostV4OrdersearchPOST /orders/v4/orderlookupOrder Search
XiSdkResellers.OrdersV5ApideleteOrdersOrderNumberDELETE /resellers/v5/Orders/{ordernumber}Cancel an Existing Order
XiSdkResellers.OrdersV5ApigetOrdersSearchGET /resellers/v5/Orders/searchSearch your Orders
XiSdkResellers.OrdersV5ApigetV5OrdersDetailsGET /resellers/v5/Orders/{ordernumber}Get Order Details
XiSdkResellers.OrdersV5ApipostV5OrdersCreatePOST /resellers/v5/OrdersCreate a New Order
XiSdkResellers.OrdersV6ApigetOrderdetailsV6GET /resellers/v6/orders/{ordernumber}Get Order Details v6
XiSdkResellers.ProductCatalogApigetResellerV6ProductdetailGET /resellers/v6/catalog/details/{ingramPartNumber}Product Details
XiSdkResellers.ProductCatalogApigetResellerV6ProductsearchGET /resellers/v6/catalogSearch Products
XiSdkResellers.ProductCatalogApipostPriceandavailabilityPOST /resellers/v6/catalog/priceandavailabilityPrice and Availability
XiSdkResellers.ProductCatalogV4ApipostV4MultiskupriceandstockPOST /products/v4/multiskupriceandstockProduct availability for upto 50 SKUs
XiSdkResellers.ProductCatalogV4ApipostV4ProductsearchPOST /products/v4/productsearchReal-time Product Search
XiSdkResellers.ProductCatalogV5ApigetV5CatalogProductsearchGET /resellers/v5/CatalogSearch Product Catalog
XiSdkResellers.ProductCatalogV5ApimultiSKUPriceAndStockPOST /resellers/v5/Catalog/priceandavailabilityFind availability of upto 50 SKUs
XiSdkResellers.QuoteToOrderApipostQuoteToOrderV6POST /resellers/v6/q2o/ordersQuote To Order
XiSdkResellers.QuotesApigetQuotessearchV6GET /resellers/v6/quotes/searchQuote Search
XiSdkResellers.QuotesApigetResellerV6ValidateQuoteGET /resellers/v6/q2o/validatequoteValidate Quote
XiSdkResellers.QuotesApigetResellersV6QuotesGET /resellers/v6/quotes/{quoteNumber}Get Quote Details
XiSdkResellers.QuotesV4ApipostV4QuotedetailsPOST /quotes/v1/quotedetailsGet Quote Details
XiSdkResellers.QuotesV4ApipostV4QuotesearchPOST /quotes/v1/quotesGet Quote List
XiSdkResellers.QuotesV5ApigetV5QuotesDetailsGET /resellers/v5/quote/{quoteNumber}Get Quote Details
XiSdkResellers.QuotesV5ApipostV5QuotesSearchPOST /resellers/v5/quote/searchSearch Quotes
XiSdkResellers.RenewalsApigetResellersV6RenewalsdetailsGET /resellers/v6/renewals/{renewalId}Renewals Details
XiSdkResellers.RenewalsApipostRenewalssearchPOST /resellers/v6/renewals/searchRenewals Search
XiSdkResellers.ReturnsApigetResellersV6ReturnsdetailsGET /resellers/v6/returns/{caseRequestNumber}Returns Details
XiSdkResellers.ReturnsApigetResellersV6ReturnssearchGET /resellers/v6/returns/searchReturns Search
XiSdkResellers.ReturnsApipostReturnscreatePOST /resellers/v6/returns/createReturns Create
XiSdkResellers.StockUpdateApiresellersV1WebhooksAvailabilityupdatePostPOST /resellers/v1/webhooks/availabilityupdateStock Update

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

application

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • write: allows modifying resources
    • read: allows reading resources
0.0.3

1 year ago

0.0.2

1 year ago

0.0.1

1 year ago