xi.sdk.resellers
0.0.1
See the version list below for details.
dotnet add package xi.sdk.resellers --version 0.0.1
NuGet\Install-Package xi.sdk.resellers -Version 0.0.1
<PackageReference Include="xi.sdk.resellers" Version="0.0.1" />
paket add xi.sdk.resellers --version 0.0.1
#r "nuget: xi.sdk.resellers, 0.0.1"
// Install xi.sdk.resellers as a Cake Addin
#addin nuget:?package=xi.sdk.resellers&version=0.0.1
// Install xi.sdk.resellers as a Cake Tool
#tool nuget:?package=xi.sdk.resellers&version=0.0.1
xi.sdk.resellers - the C# library for the 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 C# SDK is automatically generated by the OpenAPI Generator project:
API version: 1.0.0
SDK version: 1.0.0
Build package: org.openapitools.codegen.languages.CSharpClientCodegen
Json.NET - 13.0.2 or later
JsonSubTypes - 1.8.0 or later
System.ComponentModel.Annotations - 5.0.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations
<a id="installation"></a>
Installation
Run the following command to generate the DLL
- [Mac/Linux]
/bin/sh build.sh
- [Windows]
build.bat
Then include the DLL (under the bin
folder) in the C# project, and use the namespaces:
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;
<a id="packaging"></a>
Packaging
A .nuspec
is included with the project. You can follow the Nuget quickstart to create and publish packages.
This .nuspec
uses placeholders from the .csproj
, so build the .csproj
directly:
nuget pack -Build -OutputDirectory out xi.sdk.resellers.csproj
Then, publish to a local feed or other host and consume the new package via Nuget as usual.
<a id="usage"></a>
Usage
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
Connections
Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.
To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see here for details). To use your own HttpClient instance just pass it to the ApiClass constructor.
HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);
If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.
HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);
You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.
Here an example of DI setup in a sample web project:
services.AddHttpClient<YourApiClass>(httpClient =>
new PetApi(httpClient));
<a id="getting-started"></a>
Getting Started
using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;
namespace Example
{
public class Example
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.ingrammicro.com:443";
// Configure OAuth2 access token for authorization: application
config.AccessToken = "YOUR_ACCESS_TOKEN";
// create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
HttpClient httpClient = new HttpClient();
HttpClientHandler httpClientHandler = new HttpClientHandler();
var apiInstance = new DealsApi(httpClient, config, httpClientHandler);
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.
try
{
// Deals Details
DealsDetailsResponse result = apiInstance.GetResellersV6Dealsdetails(iMCustomerNumber, iMCountryCode, iMCorrelationID, iMApplicationId, iMEnvironment, dealId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DealsApi.GetResellersV6Dealsdetails: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
<a id="documentation-for-api-endpoints"></a>
Documentation for API Endpoints
All URIs are relative to https://api.ingrammicro.com:443
Class | Method | HTTP request | Description |
---|---|---|---|
DealsApi | GetResellersV6Dealsdetails | GET /resellers/v6/deals/{dealId} | Deals Details |
DealsApi | GetResellersV6Dealssearch | GET /resellers/v6/deals/search | Deals Search |
FreightEstimateApi | PostFreightestimate | POST /resellers/v6/freightestimate | Freight Estimate |
InvoicesApi | GetInvoicedetailsV61 | GET /resellers/v6.1/invoices/{invoiceNumber} | Get Invoice Details v6.1 |
InvoicesApi | GetResellersV6Invoicesearch | GET /resellers/v6/invoices | Search your invoice |
OrderStatusApi | ResellersV1WebhooksOrderstatuseventPost | POST /resellers/v1/webhooks/orderstatusevent | Order Status |
OrdersApi | DeleteOrdercancel | DELETE /resellers/v6/orders/{OrderNumber} | Cancel your Order |
OrdersApi | GetOrderdetailsV61 | GET /resellers/v6.1/orders/{ordernumber} | Get Order Details v6.1 |
OrdersApi | GetResellersV6Ordersearch | GET /resellers/v6/orders/search | Search your Orders |
OrdersApi | PostCreateorderV6 | POST /resellers/v6/orders | Create your Order |
OrdersApi | PutOrdermodify | PUT /resellers/v6/orders/{orderNumber} | Modify your Order |
ProductCatalogApi | GetResellerV6Productdetail | GET /resellers/v6/catalog/details/{ingramPartNumber} | Product Details |
ProductCatalogApi | GetResellerV6Productsearch | GET /resellers/v6/catalog | Search Products |
ProductCatalogApi | PostPriceandavailability | POST /resellers/v6/catalog/priceandavailability | Price and Availability |
QuoteToOrderApi | PostQuoteToOrderV6 | POST /resellers/v6/q2o/orders | Quote To Order |
QuotesApi | GetQuotessearchV6 | GET /resellers/v6/quotes/search | Quote Search |
QuotesApi | GetResellerV6ValidateQuote | GET /resellers/v6/q2o/validatequote | Validate Quote |
QuotesApi | GetResellersV6Quotes | GET /resellers/v6/quotes/{quoteNumber} | Get Quote Details |
RenewalsApi | GetResellersV6Renewalsdetails | GET /resellers/v6/renewals/{renewalId} | Renewals Details |
RenewalsApi | PostRenewalssearch | POST /resellers/v6/renewals/search | Renewals Search |
ReturnsApi | GetResellersV6Returnsdetails | GET /resellers/v6/returns/{caseRequestNumber} | Returns Details |
ReturnsApi | GetResellersV6Returnssearch | GET /resellers/v6/returns/search | Returns Search |
ReturnsApi | PostReturnscreate | POST /resellers/v6/returns/create | Returns Create |
StockUpdateApi | ResellersV1WebhooksAvailabilityupdatePost | POST /resellers/v1/webhooks/availabilityupdate | Stock Update |
<a id="documentation-for-models"></a>
Documentation for Models
- Model.AvailabilityAsyncNotificationRequest
- Model.AvailabilityAsyncNotificationRequestResourceInner
- Model.AvailabilityAsyncNotificationRequestResourceInnerLinksInner
- Model.DealsDetailsResponse
- Model.DealsDetailsResponseProductsInner
- Model.DealsSearchResponse
- Model.DealsSearchResponseDealsInner
- Model.Error
- Model.ErrorResponse
- Model.ErrorResponseDTO
- Model.ErrorResponseErrorsInner
- Model.ErrorResponseErrorsInnerFieldsInner
- Model.Fields
- Model.FreightRequest
- Model.FreightRequestLinesInner
- Model.FreightRequestShipToAddressInner
- Model.FreightResponse
- Model.FreightResponseFreightEstimateResponse
- Model.FreightResponseFreightEstimateResponseDistributionInner
- Model.FreightResponseFreightEstimateResponseDistributionInnerCarrierListInner
- Model.FreightResponseFreightEstimateResponseLinesInner
- Model.GetResellerV6ValidateQuote400Response
- Model.GetResellerV6ValidateQuote400ResponseFieldsInner
- Model.GetResellerV6ValidateQuote500Response
- Model.InvoiceDetailsv61Response
- Model.InvoiceDetailsv61ResponseBillToInfo
- Model.InvoiceDetailsv61ResponseFxRateInfo
- Model.InvoiceDetailsv61ResponseLinesInner
- Model.InvoiceDetailsv61ResponseLinesInnerSerialNumbersInner
- Model.InvoiceDetailsv61ResponsePaymentTermsInfo
- Model.InvoiceDetailsv61ResponseShipToInfo
- Model.InvoiceDetailsv61ResponseSummary
- Model.InvoiceDetailsv61ResponseSummaryForeignFxTotals
- Model.InvoiceDetailsv61ResponseSummaryLines
- Model.InvoiceDetailsv61ResponseSummaryMiscChargesInner
- Model.InvoiceDetailsv61ResponseSummaryTotals
- Model.InvoiceSearchResponse
- Model.InvoiceSearchResponseInvoicesInner
- Model.OrderCreateRequest
- Model.OrderCreateRequestAdditionalAttributesInner
- Model.OrderCreateRequestEndUserInfo
- Model.OrderCreateRequestLinesInner
- Model.OrderCreateRequestLinesInnerAdditionalAttributesInner
- Model.OrderCreateRequestLinesInnerEndUserInfoInner
- Model.OrderCreateRequestLinesInnerWarrantyInfoInner
- Model.OrderCreateRequestLinesInnerWarrantyInfoInnerSerialInfoInner
- Model.OrderCreateRequestResellerInfo
- Model.OrderCreateRequestShipToInfo
- Model.OrderCreateRequestShipmentDetails
- Model.OrderCreateRequestVmf
- Model.OrderCreateResponse
- Model.OrderCreateResponseEndUserInfo
- Model.OrderCreateResponseOrdersInner
- Model.OrderCreateResponseOrdersInnerAdditionalAttributesInner
- Model.OrderCreateResponseOrdersInnerLinesInner
- Model.OrderCreateResponseOrdersInnerLinesInnerAdditionalAttributesInner
- Model.OrderCreateResponseOrdersInnerLinesInnerShipmentDetailsInner
- Model.OrderCreateResponseOrdersInnerLinksInner
- Model.OrderCreateResponseOrdersInnerMiscellaneousChargesInner
- Model.OrderCreateResponseOrdersInnerRejectedLineItemsInner
- Model.OrderCreateResponseShipToInfo
- Model.OrderDetailB2B
- Model.OrderDetailB2BAdditionalAttributesInner
- Model.OrderDetailB2BBillToInfo
- Model.OrderDetailB2BEndUserInfo
- Model.OrderDetailB2BLinesInner
- Model.OrderDetailB2BLinesInnerAdditionalAttributesInner
- Model.OrderDetailB2BLinesInnerEstimatedDatesInner
- Model.OrderDetailB2BLinesInnerEstimatedDatesInnerDelivery
- Model.OrderDetailB2BLinesInnerEstimatedDatesInnerDeliveryDeliveryDateRange
- Model.OrderDetailB2BLinesInnerEstimatedDatesInnerShip
- Model.OrderDetailB2BLinesInnerEstimatedDatesInnerShipShipDateRange
- Model.OrderDetailB2BLinesInnerLinksInner
- Model.OrderDetailB2BLinesInnerMultipleShipmentsInner
- Model.OrderDetailB2BLinesInnerScheduleLinesInner
- Model.OrderDetailB2BLinesInnerServiceContractInfo
- Model.OrderDetailB2BLinesInnerServiceContractInfoContractInfo
- Model.OrderDetailB2BLinesInnerServiceContractInfoLicenseInfo
- Model.OrderDetailB2BLinesInnerServiceContractInfoSubscriptions
- Model.OrderDetailB2BLinesInnerShipmentDetailsInner
- Model.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInner
- Model.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInner
- Model.OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInnerSerialNumbersInner
- Model.OrderDetailB2BMiscellaneousChargesInner
- Model.OrderDetailB2BShipToInfo
- Model.OrderModifyRequest
- Model.OrderModifyRequestAdditionalAttributesInner
- Model.OrderModifyRequestLinesInner
- Model.OrderModifyRequestShipToInfo
- Model.OrderModifyResponse
- Model.OrderModifyResponseLinesInner
- Model.OrderModifyResponseLinesInnerAdditionalAttributesInner
- Model.OrderModifyResponseLinesInnerShipmentDetails
- Model.OrderModifyResponseRejectedLineItemsInner
- Model.OrderModifyResponseShipToInfo
- Model.OrderSearchResponse
- Model.OrderSearchResponseOrdersInner
- Model.OrderSearchResponseOrdersInnerLinks
- Model.OrderSearchResponseOrdersInnerSubOrdersInner
- Model.OrderSearchResponseOrdersInnerSubOrdersInnerLinksInner
- Model.OrderStatusAsyncNotificationRequest
- Model.OrderStatusAsyncNotificationRequestResourceInner
- Model.OrderStatusAsyncNotificationRequestResourceInnerLinesInner
- Model.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerSerialNumberDetailsInner
- Model.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInner
- Model.OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInnerPackageDetailsInner
- Model.OrderStatusAsyncNotificationRequestResourceInnerLinksInner
- Model.PostQuoteToOrderV6400Response
- Model.PostQuoteToOrderV6400ResponseFieldsInner
- Model.PostRenewalssearch400Response
- Model.PriceAndAvailabilityRequest
- Model.PriceAndAvailabilityRequestAdditionalAttributesInner
- Model.PriceAndAvailabilityRequestAvailabilityByWarehouseInner
- Model.PriceAndAvailabilityRequestProductsInner
- Model.PriceAndAvailabilityRequestProductsInnerAdditionalAttributesInner
- Model.PriceAndAvailabilityResponseInner
- Model.PriceAndAvailabilityResponseInnerAvailability
- Model.PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInner
- Model.PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInnerBackOrderInfoInner
- Model.PriceAndAvailabilityResponseInnerDiscountsInner
- Model.PriceAndAvailabilityResponseInnerDiscountsInnerQuantityDiscountsInner
- Model.PriceAndAvailabilityResponseInnerDiscountsInnerSpecialPricingInner
- Model.PriceAndAvailabilityResponseInnerPricing
- Model.PriceAndAvailabilityResponseInnerReserveInventoryDetailsInner
- Model.PriceAndAvailabilityResponseInnerServiceFeesInner
- Model.ProductDetailResponse
- Model.ProductDetailResponseAdditionalInformation
- Model.ProductDetailResponseAdditionalInformationProductWeightInner
- Model.ProductDetailResponseCiscoFields
- Model.ProductDetailResponseIndicators
- Model.ProductDetailResponseTechnicalSpecificationsInner
- Model.ProductSearchResponse
- Model.ProductSearchResponseCatalogInner
- Model.ProductSearchResponseCatalogInnerLinksInner
- Model.QuoteDetailsResponse
- Model.QuoteDetailsResponseAdditionalAttributesInner
- Model.QuoteDetailsResponseEndUserInfo
- Model.QuoteDetailsResponseProductsInner
- Model.QuoteDetailsResponseProductsInnerPrice
- Model.QuoteDetailsResponseResellerInfo
- Model.QuoteSearchResponse
- Model.QuoteSearchResponseQuotesInner
- Model.QuoteSearchResponseQuotesInnerLinks
- Model.QuoteToOrderDetailsDTO
- Model.QuoteToOrderDetailsDTOAdditionalAttributesInner
- Model.QuoteToOrderDetailsDTOEndUserInfoInner
- Model.QuoteToOrderDetailsDTOLinesInner
- Model.QuoteToOrderDetailsDTOLinesInnerVmfAdditionalAttributesLinesInner
- Model.QuoteToOrderDetailsDTOShipToInfoInner
- Model.QuoteToOrderDetailsDTOVmfadditionalAttributesInner
- Model.QuoteToOrderResponse
- Model.RenewalsDetailsResponse
- Model.RenewalsDetailsResponseAdditionalAttributesInner
- Model.RenewalsDetailsResponseEndUserInfo
- Model.RenewalsDetailsResponseProductsInner
- Model.RenewalsDetailsResponseReferenceNumber
- Model.RenewalsSearchRequest
- Model.RenewalsSearchRequestDateType
- Model.RenewalsSearchRequestDateTypeEndDate
- Model.RenewalsSearchRequestDateTypeExpirationDate
- Model.RenewalsSearchRequestDateTypeInvoiceDate
- Model.RenewalsSearchRequestDateTypeStartDate
- Model.RenewalsSearchRequestStatus
- Model.RenewalsSearchRequestStatusOpporutinyStatus
- Model.RenewalsSearchResponse
- Model.RenewalsSearchResponseRenewalsInner
- Model.RenewalsSearchResponseRenewalsInnerLinksInner
- Model.ReturnsCreateRequest
- Model.ReturnsCreateRequestListInner
- Model.ReturnsCreateRequestListInnerShipFromInfoInner
- Model.ReturnsCreateResponse
- Model.ReturnsCreateResponseReturnsClaimsInner
- Model.ReturnsDetailsResponse
- Model.ReturnsDetailsResponseProductsInner
- Model.ReturnsSearchResponse
- Model.ReturnsSearchResponseReturnsClaimsInner
- Model.ReturnsSearchResponseReturnsClaimsInnerLinksInner
- Model.ValidateQuoteResponse
- Model.ValidateQuoteResponseLinesInner
- Model.ValidateQuoteResponseVmfAdditionalAttributesInner
<a id="documentation-for-authorization"></a>
Documentation for Authorization
Authentication schemes defined for the API: <a id="application"></a>
application
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- write: allows modifying resources
- read: allows reading resources
Author
Contact
For any inquiries or support, please feel free to contact us at:
- Email: xi_support@ingrammicro.com
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 8.2.1)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Net.Http (>= 4.3.4)
-
net7.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 8.2.1)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Net.Http (>= 4.3.4)
-
net8.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.3)
- Polly (>= 8.2.1)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Net.Http (>= 4.3.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.