Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
xvantage-integration committed Oct 29, 2024
1 parent c06cd55 commit dbb2fe6
Show file tree
Hide file tree
Showing 4 changed files with 437 additions and 29 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Class | Method | HTTP request | Description
*OrdersApi* | [**post_createorder_v7**](docs/OrdersApi.md#post_createorder_v7) | **POST** /resellers/v7/orders | Create your Order v7
*OrdersApi* | [**put_ordermodify**](docs/OrdersApi.md#put_ordermodify) | **PUT** /resellers/v6/orders/{orderNumber} | Modify your Order
*ProductCatalogApi* | [**get_reseller_v6_productdetail**](docs/ProductCatalogApi.md#get_reseller_v6_productdetail) | **GET** /resellers/v6/catalog/details/{ingramPartNumber} | Product Details
*ProductCatalogApi* | [**get_reseller_v6_productdetail_cmp**](docs/ProductCatalogApi.md#get_reseller_v6_productdetail_cmp) | **GET** /resellers/v6/catalog/details | Product Details
*ProductCatalogApi* | [**get_reseller_v6_productsearch**](docs/ProductCatalogApi.md#get_reseller_v6_productsearch) | **GET** /resellers/v6/catalog | Search Products
*ProductCatalogApi* | [**post_priceandavailability**](docs/ProductCatalogApi.md#post_priceandavailability) | **POST** /resellers/v6/catalog/priceandavailability | Price and Availability
*QuotesApi* | [**get_quotessearch_v6**](docs/QuotesApi.md#get_quotessearch_v6) | **GET** /resellers/v6/quotes/search | Quote Search
Expand Down
95 changes: 90 additions & 5 deletions docs/ProductCatalogApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ All URIs are relative to *https://api.ingrammicro.com:443*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_reseller_v6_productdetail**](ProductCatalogApi.md#get_reseller_v6_productdetail) | **GET** /resellers/v6/catalog/details/{ingramPartNumber} | Product Details
[**get_reseller_v6_productdetail_cmp**](ProductCatalogApi.md#get_reseller_v6_productdetail_cmp) | **GET** /resellers/v6/catalog/details | Product Details
[**get_reseller_v6_productsearch**](ProductCatalogApi.md#get_reseller_v6_productsearch) | **GET** /resellers/v6/catalog | Search Products
[**post_priceandavailability**](ProductCatalogApi.md#post_priceandavailability) | **POST** /resellers/v6/catalog/priceandavailability | Price and Availability


# **get_reseller_v6_productdetail**
> ProductDetailResponse get_reseller_v6_productdetail(ingram_part_number, im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id, vendor_part_number=vendor_part_number, plan_name=plan_name, plan_id=plan_id)
> ProductDetailResponse get_reseller_v6_productdetail(ingram_part_number, im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id)
Product Details

Expand Down Expand Up @@ -46,6 +47,91 @@ with xi.sdk.resellers.ApiClient(configuration) as api_client:
ingram_part_number = '6YE881' # str | Ingram Micro unique part number for the product
im_customer_number = '20-222222' # str | Your unique Ingram Micro customer number
im_country_code = 'US' # str | Two-character ISO country code.
im_correlation_id = 'fbac82ba-cf0a-4bcf-fc03-0c5084' # str | Unique transaction number to identify each transaction accross all the systems
im_sender_id = 'MyCompany' # str | Sender Identification text (optional)

try:
# Product Details
api_response = api_instance.get_reseller_v6_productdetail(ingram_part_number, im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id)
print("The response of ProductCatalogApi->get_reseller_v6_productdetail:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProductCatalogApi->get_reseller_v6_productdetail: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ingram_part_number** | **str**| Ingram Micro unique part number for the product |
**im_customer_number** | **str**| Your unique Ingram Micro customer number |
**im_country_code** | **str**| Two-character ISO country code. |
**im_correlation_id** | **str**| Unique transaction number to identify each transaction accross all the systems |
**im_sender_id** | **str**| Sender Identification text | [optional]

### Return type

[**ProductDetailResponse**](ProductDetailResponse.md)

### Authorization

[application](../README.md#application)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Success | - |
**400** | Bad Request | - |
**404** | No Content | - |
**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **get_reseller_v6_productdetail_cmp**
> ProductDetailResponse get_reseller_v6_productdetail_cmp(im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id, vendor_part_number=vendor_part_number, plan_name=plan_name, plan_id=plan_id)
Product Details

Search all the product-related details using a unique Ingram Part Number.

### Example

* OAuth Authentication (application):

```python
import xi.sdk.resellers
from xi.sdk.resellers.models.product_detail_response import ProductDetailResponse
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"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# 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.ProductCatalogApi(api_client)
im_customer_number = '20-222222' # str | Your unique Ingram Micro customer number
im_country_code = 'US' # str | Two-character ISO country code.
im_correlation_id = 'fbac82ba-cf0a-4bcf-fc03-0c5084' # str | Unique transaction number to identify each transaction across all the systems
im_sender_id = 'MyCompany' # str | Sender Identification text (optional)
vendor_part_number = 'vendor_part_number_example' # str | Vendor’s part number for the product. (optional)
Expand All @@ -54,11 +140,11 @@ with xi.sdk.resellers.ApiClient(configuration) as api_client:

try:
# Product Details
api_response = api_instance.get_reseller_v6_productdetail(ingram_part_number, im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id, vendor_part_number=vendor_part_number, plan_name=plan_name, plan_id=plan_id)
print("The response of ProductCatalogApi->get_reseller_v6_productdetail:\n")
api_response = api_instance.get_reseller_v6_productdetail_cmp(im_customer_number, im_country_code, im_correlation_id, im_sender_id=im_sender_id, vendor_part_number=vendor_part_number, plan_name=plan_name, plan_id=plan_id)
print("The response of ProductCatalogApi->get_reseller_v6_productdetail_cmp:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ProductCatalogApi->get_reseller_v6_productdetail: %s\n" % e)
print("Exception when calling ProductCatalogApi->get_reseller_v6_productdetail_cmp: %s\n" % e)
```


Expand All @@ -68,7 +154,6 @@ with xi.sdk.resellers.ApiClient(configuration) as api_client:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ingram_part_number** | **str**| Ingram Micro unique part number for the product |
**im_customer_number** | **str**| Your unique Ingram Micro customer number |
**im_country_code** | **str**| Two-character ISO country code. |
**im_correlation_id** | **str**| Unique transaction number to identify each transaction across all the systems |
Expand Down
7 changes: 7 additions & 0 deletions test/test_product_catalog_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ def test_get_reseller_v6_productdetail(self) -> None:
"""
pass

def test_get_reseller_v6_productdetail_cmp(self) -> None:
"""Test case for get_reseller_v6_productdetail_cmp
Product Details
"""
pass

def test_get_reseller_v6_productsearch(self) -> None:
"""Test case for get_reseller_v6_productsearch
Expand Down
Loading

0 comments on commit dbb2fe6

Please sign in to comment.