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 Please follow the installation procedure and then run the following:

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
OrdersApi vendor_required_info POST /resellers/v7/vendorrequiredinfo Vendor Required Info
ProductCatalogApi get_reseller_v6_productdetail GET /resellers/v6/catalog/details/{ingramPartNumber} Product Details
ProductCatalogApi get_reseller_v6_productdetailcmp GET /resellers/v6/catalog/details 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

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • write: allows modifying resources
  • read: allows reading resources
  • description:

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.3.0.tar.gz (212.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xi_sdk_resellers-1.3.0-py3-none-any.whl (489.7 kB view details)

Uploaded Python 3

File details

Details for the file xi_sdk_resellers-1.3.0.tar.gz.

File metadata

  • Download URL: xi_sdk_resellers-1.3.0.tar.gz
  • Upload date:
  • Size: 212.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xi_sdk_resellers-1.3.0.tar.gz
Algorithm Hash digest
SHA256 cec899f5622a0e378571d825f4a0e4ab39a49fd766eacfcc6ceda40436e22978
MD5 23f25174c8d2ca0f0f84f8aa36a12fa8
BLAKE2b-256 cafa2407e9b87d54aefaaa0d342f1c1ac80dc5866a649f805650f24e99332b75

See more details on using hashes here.

File details

Details for the file xi_sdk_resellers-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for xi_sdk_resellers-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e407731661b0e291fe075b246ed4fb1445fddd19b9c9c3f8e25b0efd6fc6501f
MD5 ba319b9659e1b4eac258f66f1a050ed8
BLAKE2b-256 15e45c09ebc279a6fd01185dc053419c79c03b98986832270ba589cd30614d67

See more details on using hashes here.

Supported by

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