Skip to content

Latest commit

 

History

History
338 lines (297 loc) · 40.8 KB

README.md

File metadata and controls

338 lines (297 loc) · 40.8 KB

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.

Requirements.

Python 3.7+

Installation & Usage

pip install

If you want to install from PyPI:

pip install xi.sdk.resellers

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ingrammicro-xvantage/xi-sdk-resellers-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ingrammicro-xvantage/xi-sdk-resellers-python.git)

Then import the package:

import xi.sdk.resellers

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import xi.sdk.resellers

Tests

Execute pytest to run the tests.

Getting Started

Quickstart on creating an application can be found here

import xi.sdk.resellers
from xi.sdk.resellers.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ingrammicro.com:443
# See configuration.py for a list of all supported configuration parameters.
configuration = xi.sdk.resellers.Configuration(
    host = "https://api.ingrammicro.com:443"
)



# Enter a context with an instance of the API client
with xi.sdk.resellers.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = xi.sdk.resellers.AccesstokenApi(api_client)
    grant_type = 'client_credentials' # str | Keep grant_type as client_credentials only.
    client_id = 'client_id_example' # str | 
    client_secret = 'client_secret_example' # str | 

    try:
        # Accesstoken
        api_response = api_instance.get_accesstoken(grant_type, client_id, client_secret)
        print("The response of AccesstokenApi->get_accesstoken:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccesstokenApi->get_accesstoken: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AccesstokenApi get_accesstoken GET /oauth/oauth20/token Accesstoken
DealsApi get_resellers_v6_dealsdetails GET /resellers/v6/deals/{dealId} Deals Details
DealsApi get_resellers_v6_dealssearch GET /resellers/v6/deals/search Deals Search
FreightEstimateApi post_freightestimate POST /resellers/v6/freightestimate Freight Estimate
InvoicesApi get_invoicedetails_v6_1 GET /resellers/v6.1/invoices/{invoiceNumber} Get Invoice Details v6.1
InvoicesApi get_resellers_v6_invoicesearch GET /resellers/v6/invoices Search your invoice
OrderStatusApi resellers_v1_webhooks_orderstatusevent_post POST /resellers/v1/webhooks/orderstatusevent Order Status
OrdersApi delete_ordercancel DELETE /resellers/v6/orders/{OrderNumber} Cancel your Order
OrdersApi get_orderdetails_v6_1 GET /resellers/v6.1/orders/{ordernumber} Get Order Details v6.1
OrdersApi get_resellers_v6_ordersearch GET /resellers/v6/orders/search Search your Orders
OrdersApi post_createorder_v6 POST /resellers/v6/orders Create your Order
OrdersApi post_createorder_v7 POST /resellers/v7/orders Create your Order v7
OrdersApi put_ordermodify PUT /resellers/v6/orders/{orderNumber} Modify your Order
ProductCatalogApi get_reseller_v6_productdetail GET /resellers/v6/catalog/details/{ingramPartNumber} Product Details
ProductCatalogApi get_reseller_v6_productsearch GET /resellers/v6/catalog Search Products
ProductCatalogApi post_priceandavailability POST /resellers/v6/catalog/priceandavailability Price and Availability
QuotesApi get_quotessearch_v6 GET /resellers/v6/quotes/search Quote Search
QuotesApi get_reseller_v6_validate_quote GET /resellers/v6/q2o/validatequote Validate Quote
QuotesApi get_resellers_v6_quotes GET /resellers/v6/quotes/{quoteNumber} Get Quote Details
RenewalsApi get_resellers_v6_renewalsdetails GET /resellers/v6/renewals/{renewalId} Renewals Details
RenewalsApi post_renewalssearch POST /resellers/v6/renewals/search Renewals Search
ReturnsApi get_resellers_v6_returnsdetails GET /resellers/v6/returns/{caseRequestNumber} Returns Details
ReturnsApi get_resellers_v6_returnssearch GET /resellers/v6/returns/search Returns Search
ReturnsApi post_returnscreate POST /resellers/v6/returns/create Returns Create
StockUpdateApi resellers_v1_webhooks_availabilityupdate_post 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: