All URIs are relative to https://api.ingrammicro.com:443
| Method | HTTP request | Description |
|---|---|---|
| deleteOrdercancel | DELETE /resellers/v6/orders/{OrderNumber} | Cancel your Order |
| getOrderdetailsV61 | GET /resellers/v6.1/orders/{ordernumber} | Get Order Details v6.1 |
| getResellersV6Ordersearch | GET /resellers/v6/orders/search | Search your Orders |
| postCreateorderV6 | POST /resellers/v6/orders | Create your Order |
| postCreateorderV7 | POST /resellers/v7/orders | Create your Order v7 |
| putOrdermodify | PUT /resellers/v6/orders/{orderNumber} | Modify your Order |
deleteOrdercancel(orderNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, opts)
Cancel your Order
This call must be submitted before the order is released to Ingram Micro’s warehouse. The order cannot be canceled once it is released to the warehouse. Order should be on customer hold to delete any order from Ingram system.
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let orderNumber = "20-RD128"; // String | Ingram Micro sales order number.
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction accross all the systems.
let opts = {
'regionCode': "CS", // String | Region code for sandbox testing - Not for use in production.
'iMSenderID': "MyCompany" // String | Unique value used to identify the sender of the transaction. Example: MyCompany
};
apiInstance.deleteOrdercancel(orderNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| orderNumber | String | Ingram Micro sales order number. | |
| iMCustomerNumber | String | Your unique Ingram Micro customer number. | |
| iMCountryCode | String | Two-character ISO country code. | |
| iMCorrelationID | String | Unique transaction number to identify each transaction accross all the systems. | |
| regionCode | String | Region code for sandbox testing - Not for use in production. | [optional] |
| iMSenderID | String | Unique value used to identify the sender of the transaction. Example: MyCompany | [optional] |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
OrderDetailB2B getOrderdetailsV61(ordernumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, opts)
Get Order Details v6.1
The Orders details API endpoint allows a customer to retrieve their Ingram Micro orders details by using the Ingram Micro sales order number as a path parameter. The sales order number, IM-CustomerNumber, IM-CountryCode, and IM-CorrelationID are required parameters.<br><br>*Service contracts, subscriptions, and license information are unavailable at the moment, this information will be available in the future. <br><br> Recent bug fixes: - Fixed duplication of serial numbers in the API response. - Fixed API time-out issues - Fixed missing tracking information. - Implemented enhanced order status.
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let ordernumber = "20-RD3QV"; // String | The Ingram Micro sales order number.
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction accross all the systems.
let opts = {
'iMSenderID': "MyCompany", // String | Unique value used to identify the sender of the transaction. Example: MyCompany.
'ingramOrderDate': new Date("Wed May 13 00:00:00 UTC 2020"), // Date | The date and time in UTC format that the order was created.
'vendorNumber': "vendorNumber_example", // String | Vendor Number.
'simulateStatus': "simulateStatus_example", // String | Order response for various order statuses. Not for use in production.
'isIml': true, // Boolean | True/False only for IML customers.
'regionCode': "regionCode_example" // String | Region code for sandbox testing - Not for use in production.
};
apiInstance.getOrderdetailsV61(ordernumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| ordernumber | String | The Ingram Micro sales order number. | |
| iMCustomerNumber | String | Your unique Ingram Micro 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 value used to identify the sender of the transaction. Example: MyCompany. | [optional] |
| ingramOrderDate | Date | The date and time in UTC format that the order was created. | [optional] |
| vendorNumber | String | Vendor Number. | [optional] |
| simulateStatus | String | Order response for various order statuses. Not for use in production. | [optional] |
| isIml | Boolean | True/False only for IML customers. | [optional] |
| regionCode | String | Region code for sandbox testing - Not for use in production. | [optional] |
- Content-Type: Not defined
- Accept: application/json
OrderSearchResponse getResellersV6Ordersearch(iMCustomerNumber, iMCountryCode, iMCorrelationID, opts)
Search your Orders
The Orders Search API endpoint allows a customer to search their Ingram Micro orders by using any of the available query string parameters, customer can search their order by using single query string parameters or combining them together. This endpoint supports the pagination of results.
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction accross all the systems.
let opts = {
'ingramOrderNumber': "ingramOrderNumber_example", // String | The Ingram Micro order number.
'orderStatus': "orderStatus_example", // String | Ingram Micro order status.
'orderStatusIn': ["null"], // [String] | Ingram Micro order status(can use it for multiple entries).
'ingramOrderDate': "2021-04-23", // String | Search by Order date(yyyy-MM-dd).
'ingramOrderDateBt': ["null"], // [String] | Search with the start and end date(only 2 entries allowed).
'iMSenderID': "MyCompany", // String | Unique value used to identify the sender of the transaction. Example: MyCompany
'customerOrderNumber': "customerOrderNumber_example", // String | Search using your PO/Order number.
'pageSize': 56, // Number | The number of records required in the call - max records 100 per page.
'pageNumber': 56, // Number | The page number reference.
'endCustomerOrderNumber': "endCustomerOrderNumber_example", // String | End customer/user purchase order number.
'invoiceDateBt': ["null"], // [String] | Invoice date of order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia.
'shipDateBt': ["null"], // [String] | Shipment date of order, search with the start and end date(only 2 entries allowed).
'deliveryDateBt': ["null"], // [String] | The delivery date of the order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia
'ingramPartNumber': "ingramPartNumber_example", // String | Ingram Micro unique part number for the product.
'vendorPartNumber': "vendorPartNumber_example", // String | Vendor’s part number for the product.
'serialNumber': "serialNumber_example", // String | A serial number of the product.
'trackingNumber': "trackingNumber_example", // String | The tracking number of the order.*Currently, this feature is not available in Australia
'vendorName': "vendorName_example", // String | Name of the vendor.
'specialBidNumber': "specialBidNumber_example" // String | The bid number provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers.*Currently, this feature is not available in Australia
};
apiInstance.getResellersV6Ordersearch(iMCustomerNumber, iMCountryCode, iMCorrelationID, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| iMCustomerNumber | String | Your unique Ingram Micro customer number. | |
| iMCountryCode | String | Two-character ISO country code. | |
| iMCorrelationID | String | Unique transaction number to identify each transaction accross all the systems. | |
| ingramOrderNumber | String | The Ingram Micro order number. | [optional] |
| orderStatus | String | Ingram Micro order status. | [optional] |
| orderStatusIn | [String] | Ingram Micro order status(can use it for multiple entries). | [optional] |
| ingramOrderDate | String | Search by Order date(yyyy-MM-dd). | [optional] |
| ingramOrderDateBt | [String] | Search with the start and end date(only 2 entries allowed). | [optional] |
| iMSenderID | String | Unique value used to identify the sender of the transaction. Example: MyCompany | [optional] |
| customerOrderNumber | String | Search using your PO/Order number. | [optional] |
| pageSize | Number | The number of records required in the call - max records 100 per page. | [optional] |
| pageNumber | Number | The page number reference. | [optional] |
| endCustomerOrderNumber | String | End customer/user purchase order number. | [optional] |
| invoiceDateBt | [String] | Invoice date of order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia. | [optional] |
| shipDateBt | [String] | Shipment date of order, search with the start and end date(only 2 entries allowed). | [optional] |
| deliveryDateBt | [String] | The delivery date of the order, search with the start and end date(only 2 entries allowed).*Currently, this feature is not available in Australia | [optional] |
| ingramPartNumber | String | Ingram Micro unique part number for the product. | [optional] |
| vendorPartNumber | String | Vendor’s part number for the product. | [optional] |
| serialNumber | String | A serial number of the product. | [optional] |
| trackingNumber | String | The tracking number of the order.*Currently, this feature is not available in Australia | [optional] |
| vendorName | String | Name of the vendor. | [optional] |
| specialBidNumber | String | The bid number provided to the reseller by the vendor for special pricing and discounts. Line-level bid numbers take precedence over header-level bid numbers.*Currently, this feature is not available in Australia | [optional] |
- Content-Type: Not defined
- Accept: application/json
OrderCreateResponse postCreateorderV6(iMCustomerNumber, iMCountryCode, iMCorrelationID, orderCreateRequest, opts)
Create your Order
Instantly create and place orders. The POST API supports stocked SKUs as well as licensing and warranties SKUs. IM-CustomerNumber, IM-CountryCode, IM-SenderID and IM-CorrelationID are required parameters. Ingram Micro recommends that you provide the ingrampartnumber for each SKU contained in each order. NOTE: You must have net terms to use the Ingram Micro Order Create API. Ingram Micro offers trade credit when using our APIs, and repayment is based on net terms. For example, if your net terms agreement is net-30, you will have 30 days to make a full payment. Ingram Micro does not allow credit card transactions for API ordering.
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction accross all the systems.
let orderCreateRequest = {"customerOrderNumber":"SWAGGER-01","notes":"This is the field for comments","lines":[{"customerLineNumber":"1","ingramPartNumber":"DF4128","quantity":1}],"additionalAttributes":[{"attributeName":"allowDuplicateCustomerOrderNumber","attributeValue":"true"}]}; // OrderCreateRequest |
let opts = {
'iMSenderID': "MyCompany" // String | Unique value used to identify the sender of the transaction. Example: MyCompany
};
apiInstance.postCreateorderV6(iMCustomerNumber, iMCountryCode, iMCorrelationID, orderCreateRequest, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| iMCustomerNumber | String | Your unique Ingram Micro customer number. | |
| iMCountryCode | String | Two-character ISO country code. | |
| iMCorrelationID | String | Unique transaction number to identify each transaction accross all the systems. | |
| orderCreateRequest | OrderCreateRequest | ||
| iMSenderID | String | Unique value used to identify the sender of the transaction. Example: MyCompany | [optional] |
- Content-Type: application/json
- Accept: application/json
AsyncOrderCreateResponse postCreateorderV7(iMCustomerNumber, iMCountryCode, iMCorrelationID, asyncOrderCreateDTO, opts)
Create your Order v7
This API will allow customers to perform both standard ordering and quote to order functionality via a single API enabling them to have a single endpoint to cater to all types of orders. This approach will standardize the ordering flow for customers where they will get the response for all orders on to their webhooks. It provides the much-awaited async ordering flow for Reseller API where large orders can also be placed via a single API with guaranteed delivery.
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction accross all the systems.
let asyncOrderCreateDTO = {"quoteNumber":"QUO-14551943-D2Y9L9","customerOrderNumber":"12345","enduserOrderNumber":"","billToAddressId":"XYZ","endUserInfo":{"companyName":"ABC TECH","contact":"44045678","addressLine1":"Texas","addressLine2":"4","addressLine3":"","city":"","state":"","postalCode":"","countryCode":"US","email":"abc@gmail.com","phoneNumber":"445678901"},"shipToInfo":{"addressId":"12345","companyName":"","contact":"","addressLine1":"Texas","addressLine2":"4","addressLine3":"","city":"","state":"","postalCode":"","countryCode":"US","email":"abc@gmail.com"},"additionalAttributes":[{"attributeName":"VEND_AUTH_NBR_FLG","attributeValue":"ABC1234"}],"vmfAdditionalAttributes":[{"attributeName":"","attributeValue":"","attributeDescription":""}],"lines":[{"customerLineNumber":"12","ingramPartNumber":"YN6231","quantity":"2","vmfAdditionalAttributesLines":[{"attributeName":"","attributeValue":"","attributeDescription":""}]}]}; // AsyncOrderCreateDTO |
let opts = {
'iMSenderID': "MyCompany" // String | Unique value used to identify the sender of the transaction.
};
apiInstance.postCreateorderV7(iMCustomerNumber, iMCountryCode, iMCorrelationID, asyncOrderCreateDTO, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| iMCustomerNumber | String | Your unique Ingram Micro customer number. | |
| iMCountryCode | String | Two-character ISO country code. | |
| iMCorrelationID | String | Unique transaction number to identify each transaction accross all the systems. | |
| asyncOrderCreateDTO | AsyncOrderCreateDTO | ||
| iMSenderID | String | Unique value used to identify the sender of the transaction. | [optional] |
- Content-Type: application/json
- Accept: application/json
OrderModifyResponse putOrdermodify(orderNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, orderModifyRequest, opts)
Modify your Order
The Order Modify API endpoint allows for changes to be made to an order after the order creation process as long as the order was created with the customer hold flag. * Orders can be modified within 24hrs of being placed with the customer hold flag, after 24hrs they are voided if they are not released by the customer. * Modifying orders that were placed without the customer hold flag is not possible
import XiSdkResellers from 'xi_sdk_resellers';
let defaultClient = XiSdkResellers.ApiClient.instance;
// Configure OAuth2 access token for authorization: application
let application = defaultClient.authentications['application'];
application.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new XiSdkResellers.OrdersApi();
let orderNumber = "20-RC1RD"; // String | Ingram sales order number.
let iMCustomerNumber = "20-222222"; // String | Your unique Ingram Micro customer number.
let iMCountryCode = "US"; // String | Two-character ISO country code.
let iMCorrelationID = "fbac82ba-cf0a-4bcf-fc03-0c5084"; // String | Unique transaction number to identify each transaction across all the systems.
let orderModifyRequest = {"lines":[{"customerLineNumber":"002","ingramPartNumber":"2GZ200","addUpdateDeleteLine":"ADD","quantity":2}]}; // OrderModifyRequest |
let opts = {
'actionCode': "release", // String | Action code to be used for order release.
'regionCode': "CS", // String | Region code paramter to be used only for order release functionality.Region code is only for sandbox not for production
'iMSenderID': "MyCompany" // String | Unique value used to identify the sender of the transaction. Example: MyCompany
};
apiInstance.putOrdermodify(orderNumber, iMCustomerNumber, iMCountryCode, iMCorrelationID, orderModifyRequest, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});| Name | Type | Description | Notes |
|---|---|---|---|
| orderNumber | String | Ingram sales order number. | |
| iMCustomerNumber | String | Your unique Ingram Micro customer number. | |
| iMCountryCode | String | Two-character ISO country code. | |
| iMCorrelationID | String | Unique transaction number to identify each transaction across all the systems. | |
| orderModifyRequest | OrderModifyRequest | ||
| actionCode | String | Action code to be used for order release. | [optional] |
| regionCode | String | Region code paramter to be used only for order release functionality.Region code is only for sandbox not for production | [optional] |
| iMSenderID | String | Unique value used to identify the sender of the transaction. Example: MyCompany | [optional] |
- Content-Type: application/json
- Accept: application/json