Skip to content

ingrammicro-xvantage/xi-sdk-resellers-java

BranchesTags

Repository files navigation

xi.sdk.resellers

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

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository: In settings.xml in your machine add :

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                      http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <activeProfiles>
    <activeProfile>github</activeProfile>
  </activeProfiles>

  <profiles>
    <profile>
      <id>github</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2</url>
        </repository>
        <repository>
          <id>github</id>
          <url>https://maven.pkg.github.com/ingrammicro-xvantage/xi-sdk-resellers-java</url>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
    </profile>
  </profiles>

  <servers>
    <server>
      <id>github</id>
      <username>youruserid</username> ///Replace with your user id 
      <password>accesstoken</password> /// Get access token from developer settings in your profile. 
    </server>
  </servers>
</settings>
mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>xi.sdk.resellers</groupId>
  <artifactId>xi.sdk.resellers</artifactId>
  <version>1.1.0</version>
  <scope>compile</scope>
</dependency>

If you want to compile it yourself, here's how:

git clone https://github.com/ingrammicro-xvantage/xi-sdk-resellers-java.git
cd xi-sdk-resellers-java
mvn install       # Requires maven, download from https://maven.apache.org/download.html

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/xi.sdk.resellers-1.0.0.jar
  • target/lib/*.jar

Getting Started

Quickstart on creating an application can be found here

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

// Import classes:
import xiresellers.client.ApiClient;
import xiresellers.client.ApiException;
import xiresellers.client.Configuration;
import xiresellers.client.models.*;
import xiresellers.client.api.AccesstokenApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.ingrammicro.com:443");

    AccesstokenApi apiInstance = new AccesstokenApi(defaultClient);
    String grantType = "client_credentials"; // String | Keep grant_type as client_credentials only.
    String clientId = "clientId_example"; // String | 
    String clientSecret = "clientSecret_example"; // String | 
    try {
      AccesstokenResponse result = apiInstance.getAccesstoken(grantType, clientId, clientSecret);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccesstokenApi#getAccesstoken");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AccesstokenApi getAccesstoken GET /oauth/oauth20/token Accesstoken
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 postCreateorderV7 POST /resellers/v7/orders Create your Order v7
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
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

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

application

Author

-Ingram Micro Xvantage

Contact

For any inquiries or support, please feel free to contact us at:

About

Ingram Micro - Xvantage Integration Java Server-side SDK

Topics

java sdk xi xvantage ingrammicro

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

1.0.0 Latest
Feb 29, 2024

Packages

 
 
 

Contributors 5

Languages