Skip to main content

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

Project description

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.

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

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 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
QuoteToOrderApi post_quote_to_order_v6 POST /resellers/v6/q2o/orders Quote To Order
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:

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

Uploaded Source

Built Distribution

xi.sdk.resellers-1.0.0.0-py3-none-any.whl (402.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xi.sdk.resellers-1.0.0.0.tar.gz
  • Upload date:
  • Size: 163.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for xi.sdk.resellers-1.0.0.0.tar.gz
Algorithm Hash digest
SHA256 75413ef263d27efd16e95a2b0e7e06fd44452cd399df468bd8503bfb5ee573c4
MD5 a727e3dbb468dda19d6bf8b52f44e129
BLAKE2b-256 253f97d6da0190a05995e133572eb8927745fa6e426ce37b7fddaa533732a3eb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xi.sdk.resellers-1.0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 272c9d5c838ff9b6fc5d6825e8db28d5590dfb1565f918ad8c4289ab18a55bed
MD5 9347cc2e8583df088dcfac6ff01aec61
BLAKE2b-256 6102ebba7717ddf06ea0095659bf9ecc3a6e303c153e70a54459666b5c5a4c86

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