• Home
  • Reseller
  • Simulator

    • API Simulator

    The Ingram Micro API Simulation offers a baseline demonstration of how each API call functions. It is a method designed to emulate the behavior of specific endpoints or the API as a whole.

    Usage Guidelines

    • 20-222222 is the US Ingram Micro test account number related to all simulations.
    • Order numbers and/or customer PO numbers are static data that cannot be changed.
    • When using static simulation APIs, it’s essential to maintain consistency by preventing any modifications to the predefined fields or headers.
    • By maintaining this consistency, you can effectively test your code against expected outcomes and handle various scenarios, including error conditions.
    • The embedded simulations below can be viewed by using a 3rd party product such as Postman. 
      • Postman is a free web product that can be used to view API requests and responses and can be downloaded via this: URL By using these Postman requests, you can simulate the entire process from end to end.
      • The simulator URLs can be found in the Postman collection.

    Simulating API calls with Postman

    Simulation is an effective way to test and validate your API's logic and output without impacting live data.

    1. Download and open Postman on your computer.
    2. Download Postman collection and upload to Postman.
    3. Once imported, you’ll see the requests listed in the Collections or History tab.
    4. Select the request you want to simulate and hit the Send button.
    5. Postman will execute the request and display the response in the lower section. (No modifications)

    Simulations are available for select API transactions referenced below. The various scenarios have been created within each description of the individual simulations to cover core business activities.

    API Call Descriptions

    Product Search

    Search the Ingram Micro product catalog by entering any of the following details as keyword: Ingram Micro part number, vendor part number, product description or UPC.

    This simulation showcases a selection of products we offer from a specific manufacturer or vendor. For this demo, we feature Dell Computers.

    You can find more information on Product Search in our API Portal.

    Product Details

    Search all the product-related details using a unique Ingram Micro part number.

    This simulation provides SKU details for Ingram Micro products, including full descriptions and content data. We have included 10 simulator URLs to showcase various product types, such as printers, laptops, and Ethernet network switches, as well as examples of both authorized and unauthorized SKUs.

    You can find more information on Product Details in our API Portal.

    Price and Availability

    The Price and Availability (PNA) API will retrieve pricing, availability, discounts, inventory location, and reserve inventory for up to 50 products per request. We do apply rate limits to your API call in production.

    This simulation demonstrates how to set up a search using either the Ingram Micro part number or the vendor (manufacturer) part number. The Ingram Micro SKU featured in the simulator represents a government/education contract SKU, applicable to Federal, State, Local, K-12, and higher education purchases. The vendor SKU, on the other hand, represents a general vendor SKU.

    Learn more about rate limits.

    You can find more information on Price and Availability search options in our API Portal.

    Quote Search

    The Quote Search API, by default, retrieves quotes that were created or modified within the last 30 days. To access older quotes, you can use the date range feature, which allows you to retrieve quotes older than 30 days and up to 365 days old. Quotes older than 365 days are not included.

    The Quote Search API allows you to retrieve and filter key criteria from quote lists, including Quote Number, Quote Name, Deal ID (Special Bid Numbers), End User Name, and Vendor Name. The search functionality allows you to use any part of a string to find and retrieve related quotes from Ingram Micro’s quote services.

    These are the quotes available for simulation:

    Quote Status
    Ingram Micro Sales Team Created Quotes Active, Closed/Ordered
    Vendor Integration Quotes for Cisco and Dell Active, Draft, Closed/Ordered
    Self-Service - X4C Reseller Created Quotes Active, Draft, Closed/Ordered
    Subscription Quotes Active, Draft, Closed/Ordered
    Renewal Quotes Active, Closed/Ordered
    Cloud Quotes Active, Closed/Ordered
    Hybrid Quotes Active, Closed/Ordered

    The Quote Search response will return the following information:

    • Created Date
    • Quote ID
    • Quote Name
    • Created By
    • End Customer
    • Deal(Deal ID)
    • Vendor (Vendor Name)
    • Total Price
    • Last Updated
    • Expiration Date
    • Status

    This simulation demonstrates how to search your quotes with a ‘Ready To Order’ status using a special bid number. You can find more information on Quote Search in our API Portal.

    Using the information returned by the Quote Search API, you can retrieve all other details associated with a specific quote using the Quote Details API.

    Quote Details

    The Quote Details API retrieves all details associated with a specified quote number. Our collection includes 3 samples for reference. Please note that the parameters “quoteNumber”, “isoCountryCode”, and “customerNumber” are required for this API.

    You can find more information on Quote Details in our API Portal.

    Order Create

    The simulator includes 3 orderCreate examples — Apple Warranty Link, Lenovo, and Logitech. Apple Warranty Link demonstrates how to link the hardware in your order to the software.

    You can find more information on Order Create in our API Portal.

    Order Search

    The Order Search API endpoint enables customers to search their Ingram Micro orders using any of the available query string parameters. You can perform searches with a single parameter or combine multiple parameters for more refined results. This endpoint also supports paginated responses. Use the Ingram Micro Order Number to search your orders efficiently.

    You can find more information on Order Search in our API Portal.

    Order Details

    The Orders Details API endpoint allows a customer to retrieve their Ingram Micro order details by using these parameters: Ingram Micro sales order number, IM-CustomerNumber, IM-CountryCode, and IM-CorrelationID.

    You can find more information on Order Details in our API Portal.

    Invoice Search

    This endpoint enables you to easily search your Ingram Micro invoices by multiple invoice parameters and returns paginated results.

    You can find more information on Invoice Search in our API Portal.

    Invoice Details

    Search for existing invoices or retrieve existing invoice details with these parameters — invoice number, IM-CustomerNumber, IM-CountryCode, IM-ApplicationId and IM-CorrelationID.

    You can find more information on Invoice Details in our API Portal.