xi_sdk_resellers
v1.1.0
Published
Ingram Micro - Xvantage Integration (XI) Node.Js Server-side SDK.
Downloads
714
Maintainers
Readme
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
Documentation for Models
- XiSdkResellers.AccesstokenResponse
- XiSdkResellers.AsyncOrderCreateDTO
- XiSdkResellers.AsyncOrderCreateDTOAdditionalAttributesInner
- XiSdkResellers.AsyncOrderCreateDTOEndUserInfo
- XiSdkResellers.AsyncOrderCreateDTOLinesInner
- XiSdkResellers.AsyncOrderCreateDTOLinesInnerEndUserInfoInner
- XiSdkResellers.AsyncOrderCreateDTOResellerInfo
- XiSdkResellers.AsyncOrderCreateDTOShipToInfo
- XiSdkResellers.AsyncOrderCreateDTOShipmentDetails
- XiSdkResellers.AsyncOrderCreateDTOVmfadditionalAttributesInner
- XiSdkResellers.AsyncOrderCreateDTOWarrantyInfoInner
- XiSdkResellers.AsyncOrderCreateDTOWarrantyInfoInnerSerialInfoInner
- XiSdkResellers.AsyncOrderCreateDTOWarrantyInfoInnerVmfAdditionalAttributesLinesInner
- XiSdkResellers.AsyncOrderCreateResponse
- XiSdkResellers.AvailabilityAsyncNotificationRequest
- XiSdkResellers.AvailabilityAsyncNotificationRequestResourceInner
- XiSdkResellers.AvailabilityAsyncNotificationRequestResourceInnerLinksInner
- XiSdkResellers.DealsDetailsResponse
- XiSdkResellers.DealsDetailsResponseProductsInner
- XiSdkResellers.DealsSearchResponse
- XiSdkResellers.DealsSearchResponseDealsInner
- XiSdkResellers.Error
- XiSdkResellers.ErrorResponse
- XiSdkResellers.ErrorResponseDTO
- XiSdkResellers.ErrorResponseErrorsInner
- XiSdkResellers.ErrorResponseErrorsInnerFieldsInner
- XiSdkResellers.Fields
- XiSdkResellers.FreightRequest
- XiSdkResellers.FreightRequestLinesInner
- XiSdkResellers.FreightRequestShipToAddressInner
- XiSdkResellers.FreightResponse
- XiSdkResellers.FreightResponseFreightEstimateResponse
- XiSdkResellers.FreightResponseFreightEstimateResponseDistributionInner
- XiSdkResellers.FreightResponseFreightEstimateResponseDistributionInnerCarrierListInner
- XiSdkResellers.FreightResponseFreightEstimateResponseLinesInner
- XiSdkResellers.GetAccesstoken400Response
- XiSdkResellers.GetAccesstoken500Response
- XiSdkResellers.GetAccesstoken500ResponseFault
- XiSdkResellers.GetAccesstoken500ResponseFaultDetail
- XiSdkResellers.GetResellerV6ValidateQuote400Response
- XiSdkResellers.GetResellerV6ValidateQuote400ResponseFieldsInner
- XiSdkResellers.InvoiceDetailsv61Response
- XiSdkResellers.InvoiceDetailsv61ResponseBillToInfo
- XiSdkResellers.InvoiceDetailsv61ResponseFxRateInfo
- XiSdkResellers.InvoiceDetailsv61ResponseLinesInner
- XiSdkResellers.InvoiceDetailsv61ResponseLinesInnerSerialNumbersInner
- XiSdkResellers.InvoiceDetailsv61ResponsePaymentTermsInfo
- XiSdkResellers.InvoiceDetailsv61ResponseShipToInfo
- XiSdkResellers.InvoiceDetailsv61ResponseSummary
- XiSdkResellers.InvoiceDetailsv61ResponseSummaryForeignFxTotals
- XiSdkResellers.InvoiceDetailsv61ResponseSummaryLines
- XiSdkResellers.InvoiceDetailsv61ResponseSummaryMiscChargesInner
- XiSdkResellers.InvoiceDetailsv61ResponseSummaryTotals
- XiSdkResellers.InvoiceSearchResponse
- XiSdkResellers.InvoiceSearchResponseInvoicesInner
- XiSdkResellers.OrderCreateRequest
- XiSdkResellers.OrderCreateRequestAdditionalAttributesInner
- XiSdkResellers.OrderCreateRequestEndUserInfo
- XiSdkResellers.OrderCreateRequestLinesInner
- XiSdkResellers.OrderCreateRequestLinesInnerAdditionalAttributesInner
- XiSdkResellers.OrderCreateRequestLinesInnerEndUserInfoInner
- XiSdkResellers.OrderCreateRequestLinesInnerWarrantyInfoInner
- XiSdkResellers.OrderCreateRequestLinesInnerWarrantyInfoInnerSerialInfoInner
- XiSdkResellers.OrderCreateRequestResellerInfo
- XiSdkResellers.OrderCreateRequestShipToInfo
- XiSdkResellers.OrderCreateRequestShipmentDetails
- XiSdkResellers.OrderCreateRequestVmf
- XiSdkResellers.OrderCreateResponse
- XiSdkResellers.OrderCreateResponseEndUserInfo
- XiSdkResellers.OrderCreateResponseOrdersInner
- XiSdkResellers.OrderCreateResponseOrdersInnerAdditionalAttributesInner
- XiSdkResellers.OrderCreateResponseOrdersInnerLinesInner
- XiSdkResellers.OrderCreateResponseOrdersInnerLinesInnerAdditionalAttributesInner
- XiSdkResellers.OrderCreateResponseOrdersInnerLinesInnerShipmentDetailsInner
- XiSdkResellers.OrderCreateResponseOrdersInnerLinksInner
- XiSdkResellers.OrderCreateResponseOrdersInnerMiscellaneousChargesInner
- XiSdkResellers.OrderCreateResponseOrdersInnerRejectedLineItemsInner
- XiSdkResellers.OrderCreateResponseShipToInfo
- XiSdkResellers.OrderDetailB2B
- XiSdkResellers.OrderDetailB2BAdditionalAttributesInner
- XiSdkResellers.OrderDetailB2BBillToInfo
- XiSdkResellers.OrderDetailB2BEndUserInfo
- XiSdkResellers.OrderDetailB2BLinesInner
- XiSdkResellers.OrderDetailB2BLinesInnerAdditionalAttributesInner
- XiSdkResellers.OrderDetailB2BLinesInnerEstimatedDatesInner
- XiSdkResellers.OrderDetailB2BLinesInnerEstimatedDatesInnerDelivery
- XiSdkResellers.OrderDetailB2BLinesInnerEstimatedDatesInnerDeliveryDeliveryDateRange
- XiSdkResellers.OrderDetailB2BLinesInnerEstimatedDatesInnerShip
- XiSdkResellers.OrderDetailB2BLinesInnerEstimatedDatesInnerShipShipDateRange
- XiSdkResellers.OrderDetailB2BLinesInnerLinksInner
- XiSdkResellers.OrderDetailB2BLinesInnerMultipleShipmentsInner
- XiSdkResellers.OrderDetailB2BLinesInnerScheduleLinesInner
- XiSdkResellers.OrderDetailB2BLinesInnerServiceContractInfo
- XiSdkResellers.OrderDetailB2BLinesInnerServiceContractInfoContractInfo
- XiSdkResellers.OrderDetailB2BLinesInnerServiceContractInfoLicenseInfo
- XiSdkResellers.OrderDetailB2BLinesInnerServiceContractInfoSubscriptions
- XiSdkResellers.OrderDetailB2BLinesInnerShipmentDetailsInner
- XiSdkResellers.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInner
- XiSdkResellers.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInner
- XiSdkResellers.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInnerSerialNumbersInner
- XiSdkResellers.OrderDetailB2BMiscellaneousChargesInner
- XiSdkResellers.OrderDetailB2BShipToInfo
- XiSdkResellers.OrderModifyRequest
- XiSdkResellers.OrderModifyRequestAdditionalAttributesInner
- XiSdkResellers.OrderModifyRequestLinesInner
- XiSdkResellers.OrderModifyRequestShipToInfo
- XiSdkResellers.OrderModifyResponse
- XiSdkResellers.OrderModifyResponseLinesInner
- XiSdkResellers.OrderModifyResponseLinesInnerAdditionalAttributesInner
- XiSdkResellers.OrderModifyResponseLinesInnerShipmentDetails
- XiSdkResellers.OrderModifyResponseRejectedLineItemsInner
- XiSdkResellers.OrderModifyResponseShipToInfo
- XiSdkResellers.OrderSearchResponse
- XiSdkResellers.OrderSearchResponseOrdersInner
- XiSdkResellers.OrderSearchResponseOrdersInnerLinks
- XiSdkResellers.OrderSearchResponseOrdersInnerSubOrdersInner
- XiSdkResellers.OrderSearchResponseOrdersInnerSubOrdersInnerLinksInner
- XiSdkResellers.OrderStatusAsyncNotificationRequest
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInner
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInnerLinesInner
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerSerialNumberDetailsInner
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInner
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInnerPackageDetailsInner
- XiSdkResellers.OrderStatusAsyncNotificationRequestResourceInnerLinksInner
- XiSdkResellers.PostCreateorderV7400Response
- XiSdkResellers.PostCreateorderV7400ResponseFieldsInner
- XiSdkResellers.PostCreateorderV7500Response
- XiSdkResellers.PostRenewalssearch400Response
- XiSdkResellers.PriceAndAvailabilityRequest
- XiSdkResellers.PriceAndAvailabilityRequestAdditionalAttributesInner
- XiSdkResellers.PriceAndAvailabilityRequestAvailabilityByWarehouseInner
- XiSdkResellers.PriceAndAvailabilityRequestProductsInner
- XiSdkResellers.PriceAndAvailabilityRequestProductsInnerAdditionalAttributesInner
- XiSdkResellers.PriceAndAvailabilityResponseInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerAvailability
- XiSdkResellers.PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInnerBackOrderInfoInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerDiscountsInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerDiscountsInnerQuantityDiscountsInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerDiscountsInnerSpecialPricingInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerPricing
- XiSdkResellers.PriceAndAvailabilityResponseInnerReserveInventoryDetailsInner
- XiSdkResellers.PriceAndAvailabilityResponseInnerServiceFeesInner
- XiSdkResellers.ProductDetailResponse
- XiSdkResellers.ProductDetailResponseAdditionalInformation
- XiSdkResellers.ProductDetailResponseAdditionalInformationProductWeightInner
- XiSdkResellers.ProductDetailResponseCiscoFields
- XiSdkResellers.ProductDetailResponseIndicators
- XiSdkResellers.ProductDetailResponseTechnicalSpecificationsInner
- XiSdkResellers.ProductSearchResponse
- XiSdkResellers.ProductSearchResponseCatalogInner
- XiSdkResellers.ProductSearchResponseCatalogInnerLinksInner
- XiSdkResellers.QuoteDetailsResponse
- XiSdkResellers.QuoteDetailsResponseAdditionalAttributesInner
- XiSdkResellers.QuoteDetailsResponseEndUserInfo
- XiSdkResellers.QuoteDetailsResponseProductsInner
- XiSdkResellers.QuoteDetailsResponseProductsInnerBillDetailsInner
- XiSdkResellers.QuoteDetailsResponseProductsInnerPrice
- XiSdkResellers.QuoteDetailsResponseProductsInnerPriceDiscountsInner
- XiSdkResellers.QuoteDetailsResponseProductsInnerPriceExtraFeesDetailsInner
- XiSdkResellers.QuoteDetailsResponseResellerInfo
- XiSdkResellers.QuoteDetailsResponseShippingInfo
- XiSdkResellers.QuoteSearchResponse
- XiSdkResellers.QuoteSearchResponseQuotesInner
- XiSdkResellers.QuoteSearchResponseQuotesInnerLinks
- XiSdkResellers.RenewalsDetailsResponse
- XiSdkResellers.RenewalsDetailsResponseAdditionalAttributesInner
- XiSdkResellers.RenewalsDetailsResponseEndUserInfo
- XiSdkResellers.RenewalsDetailsResponseProductsInner
- XiSdkResellers.RenewalsDetailsResponseReferenceNumber
- XiSdkResellers.RenewalsSearchRequest
- XiSdkResellers.RenewalsSearchRequestDateType
- XiSdkResellers.RenewalsSearchRequestDateTypeEndDate
- XiSdkResellers.RenewalsSearchRequestDateTypeExpirationDate
- XiSdkResellers.RenewalsSearchRequestDateTypeInvoiceDate
- XiSdkResellers.RenewalsSearchRequestDateTypeStartDate
- XiSdkResellers.RenewalsSearchRequestStatus
- XiSdkResellers.RenewalsSearchRequestStatusOpporutinyStatus
- XiSdkResellers.RenewalsSearchResponse
- XiSdkResellers.RenewalsSearchResponseRenewalsInner
- XiSdkResellers.RenewalsSearchResponseRenewalsInnerLinksInner
- XiSdkResellers.ReturnsCreateRequest
- XiSdkResellers.ReturnsCreateRequestListInner
- XiSdkResellers.ReturnsCreateRequestListInnerShipFromInfoInner
- XiSdkResellers.ReturnsCreateResponse
- XiSdkResellers.ReturnsCreateResponseReturnsClaimsInner
- XiSdkResellers.ReturnsDetailsResponse
- XiSdkResellers.ReturnsDetailsResponseProductsInner
- XiSdkResellers.ReturnsSearchResponse
- XiSdkResellers.ReturnsSearchResponseReturnsClaimsInner
- XiSdkResellers.ReturnsSearchResponseReturnsClaimsInnerLinksInner
- XiSdkResellers.ValidateQuoteResponse
- XiSdkResellers.ValidateQuoteResponseLinesInner
- XiSdkResellers.ValidateQuoteResponseLinesInnerVmfAdditionalAttributesLinesInner
- XiSdkResellers.ValidateQuoteResponseVmfAdditionalAttributesInner
Documentation for Authorization
Authentication schemes defined for the API:
application
- Type: OAuth
- Flow: application
- Authorization URL: https://api.ingrammicro.com:443/oauth/oauth20/token?grant_type=client_credentials&client_id={ClientId}&client_secret={clientSecret}
- Method: Get
- Scopes:
- write: allows modifying resources
- read: allows reading resources
Author
Contact
For any inquiries or support, please feel free to contact us at:
- Email: [email protected]