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_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
- AccesstokenResponse
- AvailabilityAsyncNotificationRequest
- AvailabilityAsyncNotificationRequestResourceInner
- AvailabilityAsyncNotificationRequestResourceInnerLinksInner
- DealsDetailsResponse
- DealsDetailsResponseProductsInner
- DealsSearchResponse
- DealsSearchResponseDealsInner
- Error
- ErrorResponse
- ErrorResponseDTO
- ErrorResponseErrorsInner
- ErrorResponseErrorsInnerFieldsInner
- Fields
- FreightRequest
- FreightRequestLinesInner
- FreightRequestShipToAddressInner
- FreightResponse
- FreightResponseFreightEstimateResponse
- FreightResponseFreightEstimateResponseDistributionInner
- FreightResponseFreightEstimateResponseDistributionInnerCarrierListInner
- FreightResponseFreightEstimateResponseLinesInner
- GetAccesstoken400Response
- GetAccesstoken500Response
- GetAccesstoken500ResponseFault
- GetAccesstoken500ResponseFaultDetail
- GetResellerV6ValidateQuote400Response
- GetResellerV6ValidateQuote400ResponseFieldsInner
- InvoiceDetailsv61Response
- InvoiceDetailsv61ResponseBillToInfo
- InvoiceDetailsv61ResponseFxRateInfo
- InvoiceDetailsv61ResponseLinesInner
- InvoiceDetailsv61ResponseLinesInnerSerialNumbersInner
- InvoiceDetailsv61ResponsePaymentTermsInfo
- InvoiceDetailsv61ResponseShipToInfo
- InvoiceDetailsv61ResponseSummary
- InvoiceDetailsv61ResponseSummaryForeignFxTotals
- InvoiceDetailsv61ResponseSummaryLines
- InvoiceDetailsv61ResponseSummaryMiscChargesInner
- InvoiceDetailsv61ResponseSummaryTotals
- InvoiceSearchResponse
- InvoiceSearchResponseInvoicesInner
- OrderCreateRequest
- OrderCreateRequestAdditionalAttributesInner
- OrderCreateRequestEndUserInfo
- OrderCreateRequestLinesInner
- OrderCreateRequestLinesInnerAdditionalAttributesInner
- OrderCreateRequestLinesInnerEndUserInfoInner
- OrderCreateRequestLinesInnerWarrantyInfoInner
- OrderCreateRequestLinesInnerWarrantyInfoInnerSerialInfoInner
- OrderCreateRequestResellerInfo
- OrderCreateRequestShipToInfo
- OrderCreateRequestShipmentDetails
- OrderCreateRequestVmf
- OrderCreateResponse
- OrderCreateResponseEndUserInfo
- OrderCreateResponseOrdersInner
- OrderCreateResponseOrdersInnerAdditionalAttributesInner
- OrderCreateResponseOrdersInnerLinesInner
- OrderCreateResponseOrdersInnerLinesInnerAdditionalAttributesInner
- OrderCreateResponseOrdersInnerLinesInnerShipmentDetailsInner
- OrderCreateResponseOrdersInnerLinksInner
- OrderCreateResponseOrdersInnerMiscellaneousChargesInner
- OrderCreateResponseOrdersInnerRejectedLineItemsInner
- OrderCreateResponseShipToInfo
- OrderCreateV7Request
- OrderCreateV7RequestAdditionalAttributesInner
- OrderCreateV7RequestEndUserInfo
- OrderCreateV7RequestLinesInner
- OrderCreateV7RequestLinesInnerAdditionalAttributesInner
- OrderCreateV7RequestLinesInnerEndUserInfoInner
- OrderCreateV7RequestLinesInnerVmfAdditionalAttributesLinesInner
- OrderCreateV7RequestResellerInfo
- OrderCreateV7RequestShipToInfo
- OrderCreateV7RequestShipmentDetails
- OrderCreateV7RequestVmfAdditionalAttributesInner
- OrderCreateV7Response
- OrderCreateV7Response201
- OrderCreateV7ResponseResource
- OrderCreateV7ResponseResourceOrdersInner
- OrderCreateV7ResponseResourceOrdersInnerLinesInner
- OrderCreateV7ResponseResourceOrdersInnerLinesInnerShipmentDetailsInner
- OrderCreateV7ResponseResourceShipToInfo
- OrderDetailB2B
- OrderDetailB2BAdditionalAttributesInner
- OrderDetailB2BBillToInfo
- OrderDetailB2BEndUserInfo
- OrderDetailB2BLinesInner
- OrderDetailB2BLinesInnerAdditionalAttributesInner
- OrderDetailB2BLinesInnerEstimatedDatesInner
- OrderDetailB2BLinesInnerEstimatedDatesInnerDelivery
- OrderDetailB2BLinesInnerEstimatedDatesInnerDeliveryDeliveryDateRange
- OrderDetailB2BLinesInnerEstimatedDatesInnerShip
- OrderDetailB2BLinesInnerEstimatedDatesInnerShipShipDateRange
- OrderDetailB2BLinesInnerLinksInner
- OrderDetailB2BLinesInnerMultipleShipmentsInner
- OrderDetailB2BLinesInnerScheduleLinesInner
- OrderDetailB2BLinesInnerServiceContractInfo
- OrderDetailB2BLinesInnerServiceContractInfoContractInfo
- OrderDetailB2BLinesInnerServiceContractInfoLicenseInfo
- OrderDetailB2BLinesInnerServiceContractInfoSubscriptions
- OrderDetailB2BLinesInnerShipmentDetailsInner
- OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInner
- OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInner
- OrderDetailB2BLinesInnerShipmentDetailsInnerCarrierDetailsInnerTrackingDetailsInnerSerialNumbersInner
- OrderDetailB2BMiscellaneousChargesInner
- OrderDetailB2BShipToInfo
- OrderModifyRequest
- OrderModifyRequestAdditionalAttributesInner
- OrderModifyRequestLinesInner
- OrderModifyRequestShipToInfo
- OrderModifyResponse
- OrderModifyResponseLinesInner
- OrderModifyResponseLinesInnerAdditionalAttributesInner
- OrderModifyResponseLinesInnerShipmentDetails
- OrderModifyResponseRejectedLineItemsInner
- OrderModifyResponseShipToInfo
- OrderSearchResponse
- OrderSearchResponseOrdersInner
- OrderSearchResponseOrdersInnerLinks
- OrderSearchResponseOrdersInnerSubOrdersInner
- OrderSearchResponseOrdersInnerSubOrdersInnerLinksInner
- OrderStatusAsyncNotificationRequest
- OrderStatusAsyncNotificationRequestResourceInner
- OrderStatusAsyncNotificationRequestResourceInnerLinesInner
- OrderStatusAsyncNotificationRequestResourceInnerLinesInnerSerialNumberDetailsInner
- OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInner
- OrderStatusAsyncNotificationRequestResourceInnerLinesInnerShipmentDetailsInnerPackageDetailsInner
- OrderStatusAsyncNotificationRequestResourceInnerLinksInner
- PostCreateorderV7400Response
- PostCreateorderV7400ResponseFieldsInner
- PostCreateorderV7500Response
- PostRenewalssearch400Response
- PriceAndAvailabilityRequest
- PriceAndAvailabilityRequestAdditionalAttributesInner
- PriceAndAvailabilityRequestAvailabilityByWarehouseInner
- PriceAndAvailabilityRequestProductsInner
- PriceAndAvailabilityRequestProductsInnerAdditionalAttributesInner
- PriceAndAvailabilityResponseInner
- PriceAndAvailabilityResponseInnerAvailability
- PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInner
- PriceAndAvailabilityResponseInnerAvailabilityAvailabilityByWarehouseInnerBackOrderInfoInner
- PriceAndAvailabilityResponseInnerDiscountsInner
- PriceAndAvailabilityResponseInnerDiscountsInnerQuantityDiscountsInner
- PriceAndAvailabilityResponseInnerDiscountsInnerSpecialPricingInner
- PriceAndAvailabilityResponseInnerPricing
- PriceAndAvailabilityResponseInnerReserveInventoryDetailsInner
- PriceAndAvailabilityResponseInnerServiceFeesInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerBillingPeriod
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerGroupsInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInnerDiscountsInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInnerDiscountsInnerSpecialPricingInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInnerDiscountsInnerVolumeDiscountsInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInnerFeesInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerOptionsInnerResourcePricingInner
- PriceAndAvailabilityResponseInnerSubscriptionPriceInnerSubscriptionPeriodInner
- ProductDetailResponse
- ProductDetailResponseAdditionalInformation
- ProductDetailResponseAdditionalInformationProductWeightInner
- ProductDetailResponseCiscoFields
- ProductDetailResponseIndicators
- ProductDetailResponseSubscriptionDetailsInner
- ProductDetailResponseSubscriptionDetailsInnerBillingPeriod
- ProductDetailResponseSubscriptionDetailsInnerGroupsInner
- ProductDetailResponseSubscriptionDetailsInnerOptionsInner
- ProductDetailResponseSubscriptionDetailsInnerSubscriptionPeriodInner
- ProductSearchResponse
- ProductSearchResponseCatalogInner
- ProductSearchResponseCatalogInnerLinksInner
- ProductSearchResponseSubscriptionCatalogInner
- ProductSearchResponseSubscriptionCatalogInnerPlansInner
- ProductSearchResponseSubscriptionCatalogInnerPlansInnerLinksInner
- ProductSearchResponseSubscriptionCatalogInnerPlansInnerSubscriptionPeriodSummaryInner
- QuoteDetailsResponse
- QuoteDetailsResponseAdditionalAttributesInner
- QuoteDetailsResponseEndUserInfo
- QuoteDetailsResponseProductsInner
- QuoteDetailsResponseProductsInnerBillDetailsInner
- QuoteDetailsResponseProductsInnerPrice
- QuoteDetailsResponseProductsInnerPriceDiscountsInner
- QuoteDetailsResponseProductsInnerPriceExtraFeesDetailsInner
- QuoteDetailsResponseResellerInfo
- QuoteDetailsResponseShippingInfo
- QuoteSearchResponse
- QuoteSearchResponseQuotesInner
- QuoteSearchResponseQuotesInnerLinks
- RenewalsDetailsResponse
- RenewalsDetailsResponseAdditionalAttributesInner
- RenewalsDetailsResponseEndUserInfo
- RenewalsDetailsResponseProductsInner
- RenewalsDetailsResponseReferenceNumber
- RenewalsSearchRequest
- RenewalsSearchRequestDateType
- RenewalsSearchRequestDateTypeEndDate
- RenewalsSearchRequestDateTypeExpirationDate
- RenewalsSearchRequestDateTypeInvoiceDate
- RenewalsSearchRequestDateTypeStartDate
- RenewalsSearchRequestStatus
- RenewalsSearchRequestStatusOpporutinyStatus
- RenewalsSearchResponse
- RenewalsSearchResponseRenewalsInner
- RenewalsSearchResponseRenewalsInnerLinksInner
- ReturnsCreateRequest
- ReturnsCreateRequestListInner
- ReturnsCreateRequestListInnerShipFromInfoInner
- ReturnsCreateResponse
- ReturnsCreateResponseReturnsClaimsInner
- ReturnsDetailsResponse
- ReturnsDetailsResponseProductsInner
- ReturnsSearchResponse
- ReturnsSearchResponseReturnsClaimsInner
- ReturnsSearchResponseReturnsClaimsInnerLinksInner
- ValidateQuoteResponse
- ValidateQuoteResponseLinesInner
- ValidateQuoteResponseLinesInnerVmfAdditionalAttributesLinesInner
- ValidateQuoteResponseVmfAdditionalAttributesInner
Documentation For Authorization
Authentication schemes defined for the API:
application
- Type: OAuth
- Flow: application
- Authorization URL: https://api.ingrammicro.com:443/oauth/oauth20/token?grant_type=client_credentials&client_id={ClientId}&client_secret={clientSecret}
- Method: Get
- Scopes:
- write: allows modifying resources
- read: allows reading resources
Author
Contact
For any inquiries or support, please feel free to contact us at:
- Email: xi_support@ingrammicro.com
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xi_sdk_resellers-1.2.0.tar.gz.
File metadata
- Download URL: xi_sdk_resellers-1.2.0.tar.gz
- Upload date:
- Size: 205.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
465800bd61625ad21d8b04db2ebd963adfa51f5d1e2212e014c01ee8de0da841
|
|
| MD5 |
9b3631dce599ce98e99bd165812f5c4a
|
|
| BLAKE2b-256 |
89b1142ed53438483f584ca3b8aa3d21262393acb4876b8bbb56f88ecdea531a
|
File details
Details for the file xi_sdk_resellers-1.2.0-py3-none-any.whl.
File metadata
- Download URL: xi_sdk_resellers-1.2.0-py3-none-any.whl
- Upload date:
- Size: 474.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b95214f7ac393913ce9cff8ddd0c236a6b46a4bb0e82de9f9a1636f7c1ec199b
|
|
| MD5 |
341189b21af96df3da3110727f401944
|
|
| BLAKE2b-256 |
a90639c3677b27c1c299b617cb8b52a94292d2ef8789f583ff95cf05659a1b31
|