Skip to content

Latest commit

 

History

History
360 lines (297 loc) · 20.5 KB

QuotesApi.md

File metadata and controls

360 lines (297 loc) · 20.5 KB

xi.sdk.resellers.Api.QuotesApi

All URIs are relative to https://api.ingrammicro.com:443

Method HTTP request Description
GetQuotessearchV6 GET /resellers/v6/quotes/search Quote Search
GetResellerV6ValidateQuote GET /resellers/v6/q2o/validatequote Validate Quote
GetResellersV6Quotes GET /resellers/v6/quotes/{quoteNumber} Get Quote Details

GetQuotessearchV6

QuoteSearchResponse GetQuotessearchV6 (string iMCustomerNumber, string iMCountryCode, string iMCustomerContact, string iMCorrelationID, List? ingramOrderDateBt = null, string? quoteNumber = null, string? specialBidNumber = null, string? endUserContact = null, string? sortingOrder = null, string? sortBy = null, int? pageSize = null, int? pageNumber = null, string? vendorName = null, string? quoteName = null, string? status = null, string? quoteCreateDateBt = null, string? iMSenderID = null)

Quote Search

The Quote Search API, by default, will retrieve quotes modified or created within the last 30 days. Quotes older than 365 days are excluded by default. The date filters enable the retrieval of quotes older than 30 days and up to 365 days when using date range criteria. The Quote Search API enables the retrieval and filtering of relevant quote list key criteria data such as Quote Number, Special Bid Numbers, End User Name, Quote Status, and Date Ranges from Ingram Micros CRM system. Only Active quotes are avaiable through the API. Draft and Closed quotes are excluded and are not accessable through the Quote List Search API.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;

namespace Example
{
    public class GetQuotessearchV6Example
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.ingrammicro.com:443";
            // Configure OAuth2 access token for authorization: application
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new QuotesApi(httpClient, config, httpClientHandler);
            var iMCustomerNumber = 20-222222;  // string | Your unique Ingram Micro customer number.
            var iMCountryCode = US;  // string | Two-character ISO country code.
            var iMCustomerContact = John.Doe@reseller.com;  // string | Logged in Users email address contact.
            var iMCorrelationID = fbac82ba-cf0a-4bcf-fc03-0c5084;  // string | Unique transaction number to identify each transaction across all the systems.
            var ingramOrderDateBt = new List<string>?(); // List<string>? | Search with start and end date(only 2 entries allowed). (optional) 
            var quoteNumber = QUO-10985-C4C3F7;  // string? | Unique identifier generated by Ingram Micros CRM specific to each quote.  When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes. (optional) 
            var specialBidNumber = 9638445-1880;  // string? | Special Pricing Bid Number, also referred to as a Dart Number by some vendors, is a unique identifier associated with vendor specific products and discounts. (optional) 
            var endUserContact = JD Enterprises;  // string? | End User Name is the end customer name that is associated with a quote in Ingram Micros CRM. (optional) 
            var sortingOrder = desc;  // string? | Sort applies to the selected column (sortingColumnName) and may be specified in  Ascending (asc) or Descending (desc) order. The default sort is Descending (desc) - most recent first. (optional) 
            var sortBy = quoteNumber;  // string? | Refers to the column selected to apply the sorting criteria.  The default column is dateCreated and will sort by the most recently created quote first with the following in descending order.  The default filter retrieves quotes created within the last 30 days. Filtering allows user to select a specific column to sort: quoteNumber, createdDate, lastModifiedDate and expiryDate. (optional) 
            var pageSize = 25;  // int? | Number of records (quotes) to display per page in the quote list.  The default is 25, but may be decreased using the filter . (optional) 
            var pageNumber = 1;  // int? | Page index or page number for the list of quotes being returned. (optional)  (default to 1)
            var vendorName = Dell;  // string? | The name of the vendor. (optional) 
            var quoteName = MyQuote;  // string? | The quote name was given by the customer while creating quote. (optional) 
            var status = Ready to Order;  // string? | The status of the quote. (optional) 
            var quoteCreateDateBt = "quoteCreateDateBt_example";  // string? | Search with start and end date(only 2 entries allowed). (optional) 
            var iMSenderID = MyCompany;  // string? | Unique value used to identify the sender of the transaction. Example: MyCompany (optional) 

            try
            {
                // Quote Search
                QuoteSearchResponse result = apiInstance.GetQuotessearchV6(iMCustomerNumber, iMCountryCode, iMCustomerContact, iMCorrelationID, ingramOrderDateBt, quoteNumber, specialBidNumber, endUserContact, sortingOrder, sortBy, pageSize, pageNumber, vendorName, quoteName, status, quoteCreateDateBt, iMSenderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling QuotesApi.GetQuotessearchV6: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetQuotessearchV6WithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Quote Search
    ApiResponse<QuoteSearchResponse> response = apiInstance.GetQuotessearchV6WithHttpInfo(iMCustomerNumber, iMCountryCode, iMCustomerContact, iMCorrelationID, ingramOrderDateBt, quoteNumber, specialBidNumber, endUserContact, sortingOrder, sortBy, pageSize, pageNumber, vendorName, quoteName, status, quoteCreateDateBt, iMSenderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling QuotesApi.GetQuotessearchV6WithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
iMCustomerNumber string Your unique Ingram Micro customer number.
iMCountryCode string Two-character ISO country code.
iMCustomerContact string Logged in Users email address contact.
iMCorrelationID string Unique transaction number to identify each transaction across all the systems.
ingramOrderDateBt List<string>? Search with start and end date(only 2 entries allowed). [optional]
quoteNumber string? Unique identifier generated by Ingram Micros CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes. [optional]
specialBidNumber string? Special Pricing Bid Number, also referred to as a Dart Number by some vendors, is a unique identifier associated with vendor specific products and discounts. [optional]
endUserContact string? End User Name is the end customer name that is associated with a quote in Ingram Micros CRM. [optional]
sortingOrder string? Sort applies to the selected column (sortingColumnName) and may be specified in Ascending (asc) or Descending (desc) order. The default sort is Descending (desc) - most recent first. [optional]
sortBy string? Refers to the column selected to apply the sorting criteria. The default column is dateCreated and will sort by the most recently created quote first with the following in descending order. The default filter retrieves quotes created within the last 30 days. Filtering allows user to select a specific column to sort: quoteNumber, createdDate, lastModifiedDate and expiryDate. [optional]
pageSize int? Number of records (quotes) to display per page in the quote list. The default is 25, but may be decreased using the filter . [optional]
pageNumber int? Page index or page number for the list of quotes being returned. [optional] [default to 1]
vendorName string? The name of the vendor. [optional]
quoteName string? The quote name was given by the customer while creating quote. [optional]
status string? The status of the quote. [optional]
quoteCreateDateBt string? Search with start and end date(only 2 entries allowed). [optional]
iMSenderID string? Unique value used to identify the sender of the transaction. Example: MyCompany [optional]

Return type

QuoteSearchResponse

Authorization

application

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK * IM-CorrelationID - Unique transaction number to identify each transaction across all the systems.
* IM-SenderID - Unique value used to identify the sender of the transaction. Example: MyCompany
400 Bad Request * IM-CorrelationID - Unique transaction number to identify each transaction across all the systems.
* IM-SenderID - Unique value used to identify the sender of the transaction. Example: MyCompany
401 Unauthorized -
404 Not Found * IM-CorrelationID - Unique transaction number to identify each transaction across all the systems.
* IM-SenderID - Unique value used to identify the sender of the transaction. Example: MyCompany
500 Internal Server Error * IM-CorrelationID - Unique transaction number to identify each transaction across all the systems.
* IM-SenderID - Unique value used to identify the sender of the transaction. Example: MyCompany

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetResellerV6ValidateQuote

ValidateQuoteResponse GetResellerV6ValidateQuote (string quoteNumber, string iMCustomerNumber, string iMCountryCode, string iMCorrelationID, string? iMSenderID = null)

Validate Quote

The validate quote helps the customer validate the quote created in Ingram Micro's system. Apart from validating the quote, the endpoint also identifies all the mandatory fields that are required by the vendor at the header and line levels.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;

namespace Example
{
    public class GetResellerV6ValidateQuoteExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.ingrammicro.com:443";
            // Configure OAuth2 access token for authorization: application
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new QuotesApi(httpClient, config, httpClientHandler);
            var quoteNumber = QUO-14551943-D2Y9L9;  // string | A unique identifier generated by Ingram Micro's CRM specific to each quote.
            var iMCustomerNumber = 20-222222;  // string | Your Ingram Micro unique customer number.
            var iMCountryCode = US;  // string | Two-character ISO country code.
            var iMCorrelationID = fbac82ba-cf0a-4bcf-fc03-0c5084;  // string | Unique transaction number to identify each transaction accross all the systems.
            var iMSenderID = MyCompany;  // string? | Unique identifier used to identify the third party source accessing the services. (optional) 

            try
            {
                // Validate Quote
                ValidateQuoteResponse result = apiInstance.GetResellerV6ValidateQuote(quoteNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, iMSenderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling QuotesApi.GetResellerV6ValidateQuote: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetResellerV6ValidateQuoteWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Validate Quote
    ApiResponse<ValidateQuoteResponse> response = apiInstance.GetResellerV6ValidateQuoteWithHttpInfo(quoteNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, iMSenderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling QuotesApi.GetResellerV6ValidateQuoteWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
quoteNumber string A unique identifier generated by Ingram Micro's CRM specific to each quote.
iMCustomerNumber string Your Ingram Micro unique customer number.
iMCountryCode string Two-character ISO country code.
iMCorrelationID string Unique transaction number to identify each transaction accross all the systems.
iMSenderID string? Unique identifier used to identify the third party source accessing the services. [optional]

Return type

ValidateQuoteResponse

Authorization

application

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetResellersV6Quotes

QuoteDetailsResponse GetResellersV6Quotes (string iMCustomerNumber, string iMCountryCode, string iMCorrelationID, string quoteNumber, string? iMSenderID = null)

Get Quote Details

The quote details API provides all quote details associated with the quote number provided. The “quoteNumber”, “isoCountryCode” and “customerNumber” parameters are required.

Example

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using xi.sdk.resellers.Api;
using xi.sdk.resellers.Client;
using xi.sdk.resellers.Model;

namespace Example
{
    public class GetResellersV6QuotesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.ingrammicro.com:443";
            // Configure OAuth2 access token for authorization: application
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new QuotesApi(httpClient, config, httpClientHandler);
            var iMCustomerNumber = 20-222222;  // string | Your Ingram Micro unique customer number
            var iMCountryCode = US;  // string | Two-character ISO country code.
            var iMCorrelationID = ASJDasbjdn-asjnd12dalks-asjkn;  // string | Unique transaction number to identify each transaction accross all the systems.
            var quoteNumber = QUO-10926-Y8G1B3;  // string | Unique identifier generated by Ingram Micro's CRM specific to each quote.  When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.
            var iMSenderID = MyCompany;  // string? | Unique identifier used to identify the third party source accessing the services. (optional) 

            try
            {
                // Get Quote Details
                QuoteDetailsResponse result = apiInstance.GetResellersV6Quotes(iMCustomerNumber, iMCountryCode, iMCorrelationID, quoteNumber, iMSenderID);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling QuotesApi.GetResellersV6Quotes: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetResellersV6QuotesWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Get Quote Details
    ApiResponse<QuoteDetailsResponse> response = apiInstance.GetResellersV6QuotesWithHttpInfo(iMCustomerNumber, iMCountryCode, iMCorrelationID, quoteNumber, iMSenderID);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling QuotesApi.GetResellersV6QuotesWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name Type Description Notes
iMCustomerNumber string Your Ingram Micro unique customer number
iMCountryCode string Two-character ISO country code.
iMCorrelationID string Unique transaction number to identify each transaction accross all the systems.
quoteNumber string Unique identifier generated by Ingram Micro's CRM specific to each quote. When applying a filter to the quoteNumber and including a partial quote number in the filter, all quotes containing any information included in the filter can be retrieved as a subset of all available customer quotes.
iMSenderID string? Unique identifier used to identify the third party source accessing the services. [optional]

Return type

QuoteDetailsResponse

Authorization

application

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]