Skip to main content

Ingram Micro - Xvantage Integration (XI) Python Server-side SDK.

Project description

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:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xi.sdk.resellers-1.1.0.tar.gz (176.4 kB view details)

Uploaded Source

Built Distribution

xi.sdk.resellers-1.1.0-py3-none-any.whl (421.4 kB view details)

Uploaded Python 3

File details

Details for the file xi.sdk.resellers-1.1.0.tar.gz.

File metadata

  • Download URL: xi.sdk.resellers-1.1.0.tar.gz
  • Upload date:
  • Size: 176.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for xi.sdk.resellers-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1cd1cbf2ade6a9ae028b97d4ee4ddf4bbc52255e1a4a7432bbbcb473c75828c6
MD5 6f758b45e0c899fa00ba79e7e961d123
BLAKE2b-256 19f7f96b1d6522ed1d11f2d52f328eae69c5b07b075eed43dffb18dd9d0cac86

See more details on using hashes here.

File details

Details for the file xi.sdk.resellers-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for xi.sdk.resellers-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f176854986f1782721cb5ebee34767265c4eed2eac49988894561b370120f5b
MD5 c78206162276ecd4a4cbd30364b1f610
BLAKE2b-256 e333f4459bf3d2c1f3eb4c5c18ced9825e2bb83d16b98c4134c6c871d53a435e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page