Marketplace API
Note
On November 15th, 2021 Ingram Micro has updated Marketplace API on production, which has changed the way the API behaves in some cases. It is imperative that you read the Marketplace API 1.6 release notes carefully, modify your integrations (API clients) to match the updated specifications, and prepare to update your API clients at the time when the new version is implemented by Ingram Micro.
The documentation for the new version can be found under https://apidocs.cloud.im/1.6/. After November 15th, this documentation portal will automatically display this new version.
Glossary¶
- Account
An account is a representation of an organization or a person (do not confuse with user) in the platform’s hierarchical business model. There are three types of accounts: provider (there is a single account of this type in the platform), reseller, and customer. An account can have two types of users: administrators and service users.
- Administrator
- Administrators
A type of user who is able to manage its associated account. Similar to a service user, an administrator can consume services purchased by the account associated with this user.
- API client
A software tool used by resellers to access the API exposed by the platform. This can be a specialized REST UI application, a script, or a command line tool (or a combination of these) used in the production environment and for testing.
- CMP API
- Cloud Marketplace API
- Marketplace API
This is the subject of the whole document set you are reading now. The CMP API is based on REST concepts and designed to enable Ingram Micro Cloud partners to integrate their management systems with the Platform.
- Customer
A type of account that represents an organization or a person (do not confuse with user) that can purchase and consume services from its product vendor. Unlike reseller, a customer is not able to have its subordinary accounts or resell products.
- ISV
- Independent software vendor
- Application vendor
A company specializing in making or selling software designed for mass or niche markets. In the platform, there are no resources that represent ISVs. They are known as independent software vendors that are responsible for the services provided by their cloud applications integrated with the platform.
- MPN
- Manufacture Part Number
This is a unique identifier of a product assigned by the respective service vendor. In the API, an MPN is used to differentiate products from each other when listing, searching, and ordering products.
- Platform
Ingram Micro Cloud platform is a modular, scalable, and secure platform that enables the end-to-end delivery of services, including onboarding, automation, integration, distribution, go-to-market, and support.
- Provider
A type of account that is the owner of the platform. It represents an organization with users that manages the whole platform. Particularly, the provider creates the hierarchical business model, deploys services, and configures products for sales.
- Reseller
A type of account that represents an organization or a person (do not confuse with user) that can resell the provider’s resources directly of through its product vendor. Similar to a customer, a reseller can also purchase and consume services from its product vendor.
- Sales vendor
- Product vendor
For an account, this is the provider or a reseller who created that account and provides products for it.
- Service user
- Service users
A type of user who is a consumer of services purchased by the account associated with this user. Unlike administrator, a service user is not able to manage its associated account.
- User
- Users
A representation of a user who is associated with a particular account and can log in to the platform user panel to manage its own resources (as a service user) or its account (as an administrator).