Overview
Getting started
Overview
- Direct customers who intend to manage their purchased services (Example use case, customer managing users assigned to their subscriptions using APIs to automate the entitlements)
- Non-IBM Marketplaces (3rd party marketplaces (3PM) / resellers) that want to sell products available on the IBM Marketplace to their own customers (Example use cases, 3PM calls catalog APIs to retrieve current descriptions, names and details regarding the IBM products they resell. 3PM calls order APIs to create subscriptions for their customers who have purchased IBM products from them. *Note - 3PM / Resellers manage payments through contracts independent of these APIs) If you are a 3rd Party Marketplace and are interested in reselling IBM products, please review the process for becoming a 3rd Party Marketplace
Entity Model
- Product - A product quite literally represents a product or service that may be tried and purchased from the Marketplace's catalog
- Subscription - Is an entity created to represent the fulfillment of an order for a product
- User - A user is a single user that has an IBM ID. A user may be part of one or more subscriptions
- Orders - Its an entity created to represent the orders placed by resellers
View a diagram of the IBM Marketplace entity relationships
View a diagram of the Third Party Orders entity relationships
Authentication
Each external Marketplace API request must require authentication, but not using typical HTTP conventions. Requests must pass below authentication credentials [id/secret] in a pair of headers for validation.
- x-ibm-client-id
- x-ibm-client-secret
Requests that fail to present the required headers must return an error response with the HTTP status code 401 "Unauthorized", along with an appropriate message. No WWW-Authenticate header is required for the response.
Requests presenting credentials that cannot be validated must return an error response with the HTTP status code 401 "Unauthorized", along with an appropriate message. Validated id and secret permit access to the requested endpoint. Subsequent behavior may be subject to role authorization for the endpoint's HTTP method, the requested resource[s], etc., as appropriate.
Values are validated against separately stored credentials introduced via an undocumented administrative endpoint.
Error Handling
The following status codes are used in this API:
- 200 OK - Everything is working.
- 201 OK - A new resource has been successfully created.
- 204 OK - An existing resource as been successfully deleted and no response body is returned.
- 304 Not Modified - Client can use cached data.
- 400 Bad Request - The request was invalid or cannot be served. Examples include request URLs and bodies that cannot be parsed. A specific message must be provided in the error response body.
- 401 Unauthorized - Despite the mis-leading use of the word 'Unauthorized', the request requires authentication credentials.Either 1) credentials were not provided, i.e. the Authorization header was absent, or 2) credentials were provided,but failed validation. A response must contain a WWW-Authenticate header.
- 403 Forbidden - The request is understood, but it is refused or cannot be allowed because. The request should not be repeated. The response should indicate a reason for the refusal, but need not. For potential security-related issues, 404 Not Found may be returned instead.
- 404 Not Found - There is no resource for the given URI. The identified resource or requested response is non-existent.
- 405 Method Not Allowed - An authenticated request isn't authorized for the endpoint's HTTP method.
- 409 Conflict - The attempted operation cannot be completed. There is a conflict between the requested operation and the state of the resource. An example would be trying to delete a subscription that is currently in the process of being provisioned.
- 415 Unsupported Media Type - The request header 'Content-type: application/json' was not passed with request.
- 422 Unprocessable Entity - The POST or PATCH request body cannot be validated. A resource could not created
- 500 Internal Server Error - Avoid this status code, if possible. Never return the stack trace.
Security
Keys
Documentation
IBM Marketplace APIs:
Catalog
Get a product
GET /v2/catalog/products/{id}
https://api.ibm.com/marketplace/run/v2/catalog/products/{id}
Keys
Path and Query parameters
id
URL , required
The ID of the product
locale
STRING , required
Locale of the products
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/products/{id}?locale=string")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
OBJECT , required
Marketplace product
links
OBJECT , required
Links representing the response and references relating to the response
archived
BOOLEAN , optional
Flag indicating whether the product has been archived. An archived product no longer appears on the IBM Marketplace, but may still have existing orders or subscriptions against it.
availableForLocales
ARRAY , required
List of locales where this product will appear on the IBM Marketplace
benefits
ARRAY , optional
Key benefits of the product
businessUnit
STRING , optional
Business unit that the product belongs to. i.e. '3rd party' or 'generic'
category
ARRAY , optional
Categories the product belongs to
categoryTopics
ARRAY , optional
Category topics the product belongs to
contactModuleKey
STRING , optional
Name of LiveAdvisor or contact module for live chat and contact information
demoUrl
STRING , optional
Home URL for further information and content if the product is non-IBM based
description
STRING , optional
Description of the products features and benefits
hasTrialAvailable
BOOLEAN , optional
Flag indicating whether the product has a trial available
icon
STRING , optional
Company logo if the product is non-IBM
id
STRING , required
Unique identifier of the product
imageUrl
STRING , optional
Product overview image
isThirdParty
BOOLEAN , optional
Boolean value showing if a product is third party or not.
keywords
ARRAY , optional
Product keywords
kubernetes
ARRAY , optional
Indicates CloudPaks available for the product.
lastModified
INTEGER , optional
Date when this product's catalog data was last modified
locale
STRING , optional
Product locale
longDescription
STRING , optional
Description of the product
name
STRING , required
Name of product
naturalLanguageName
STRING , required
Name of product or shortened name of product if the product name is long
offeringHeadline
STRING , optional
Description of the product's most unique feature or benefit
overview
STRING , optional
Intro sentences for the product that initiate a compelling story about it's value proposition
overviewHeadline
STRING , optional
Marketing overview headline
partnerWorldCertifications
ARRAY , optional
Ready For program certifications.
pictogram
STRING , optional
Small image representing the categorization of the product
primaryCategory
STRING , optional
Primary category that the product belongs to
primaryCategoryTopic
STRING , optional
Primary category topic that the product belongs to
productId
STRING , optional
Used for backwards compatibility only. Please reference the productIds attribute instead.
productIds
ARRAY , optional
The unique product IDs for this product. This list represents the product IDs from the product's various purchasePlans.
productKey
STRING , required
Unique identifier of the product in IBM Marketplace.
productPageName
STRING , required
Name given to the IBM Marketplace product page. This is also the last directory from the product page URL path
provider
OBJECT , optional
Product provider
publishedOn
INTEGER , optional
Date when this product's catalog data originally published
purchasePlans
ARRAY , optional
Product purchase plans
resources
ARRAY , optional
Resources with more information about the product
screenshotUrl
STRING , optional
Product screenshot image
serviceType
STRING , optional
Type of service (e.g. Application, API, hardware, etc.)
support
OBJECT , optional
Support information for purchased products
topics
ARRAY , optional
Topics the product is tagged with. Topics are a subclassification of a product within categories.
trialSupport
OBJECT , optional
Support information for trial products
url
STRING , required
IBM Marketplace product page URL
description
STRING , optional
Description of each key benefit
title
STRING , optional
Title of each key benefit
readyForProgram
STRING , optional
Ready For program certifications for 3rd party solutions.
readyForSubprogram
ARRAY , optional
Ready For subprogram certifications for 3rd party solutions.
contact
STRING , optional
Provider's email address
name
STRING , optional
Name of the product provider (IBM for 1st party, company name for 3rd party)
attributes
ARRAY , optional
Features of the purchase plan
currencySymbol
STRING , optional
Price symbol
description
STRING , optional
Description of the purchase plan
formattedPrice
STRING , optional
List price including the symbol and unit (e.g. 99.00 USD)
id
STRING , optional
Unique identifier of the purchase plan
inAppUrl
STRING , optional
URL to IBM Marketplace checkout page to buy more of the specific purchase plan
label
STRING , optional
Purchase plan label (e.g. Purchase now)
name
STRING , optional
Name of the purchase plan (e.g. Free, Base, Professional)
prefix
STRING , optional
Price prefix (e.g. Starting at)
price
STRING , optional
List price for purchase plan
productId
STRING , optional
The unique product ID for this purchase plan
suffix
STRING , optional
Price suffix (e.g. per user)
supportsReferralsOnly
STRING , optional
If true, the purchased plan will be provisioned by a 3rd party company. If false, the purchased plan will be provisioned by IBM.
type
STRING , optional
Purchase plan type (e.g. Try or Buy)
unit
STRING , optional
Currency unit (e.g. USD, EUR)
url
STRING , optional
URL to IBM Marketplace checkout page to purchase the specific purchase plan
description
STRING , optional
Description of the purchase plan attribute
id
STRING , optional
Unique identifier of the purchase plan attribute
name
STRING , optional
Name of the purchase plan attribute
toolTip
STRING , optional
Tool tip for the purchase plan attribute
description
STRING , optional
Verbose description of the resource
name
STRING , optional
Name of resource
type
STRING , optional
Type of resource (e.g. Video, Whitepaper, Blog)
url
STRING , optional
URL to access resource
chat
STRING , optional
Chat URL to get support for the purchased product
STRING , optional
Email to get support for the purchased product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the purchased product
phone
STRING , optional
Phone number to get support for the purchased product
url
STRING , optional
URL to get support for the purchased product
chat
STRING , optional
Chat URL to get support for the trial product
STRING , optional
Email to get support for the trial product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the trial product
phone
STRING , optional
Phone number to get support for the trial product
url
STRING , optional
URL to get support for the trial product
self
STRING , optional
Url to self
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
404
Not found
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
422
Unprocessable entity
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : {
"archived" : false,
"availableForLocales" : [string],
"benefits" : [{
"description" : "Get insights in the office or on the go.",
"title" : "Improve your business"
}],
"businessUnit" : "Cloud",
"category" : [string],
"categoryTopics" : [string],
"contactModuleKey" : "Analytics",
"demoUrl" : "https://www.example.com/demo",
"description" : "A description of the product.",
"hasTrialAvailable" : true,
"icon" : "http://www.example.com/icon.jpg",
"id" : "34c03458eceefb2ca29cbb220545a1f67",
"imageUrl" : "https://www.example.com/icon.jpg",
"isThirdParty" : false,
"keywords" : [string],
"kubernetes" : [string],
"lastModified" : 1507661029,
"locale" : "en-us",
"longDescription" : "A long description of the product.",
"name" : "IBM Product ABC",
"naturalLanguageName" : "Product ABC",
"offeringHeadline" : "An offering headline",
"overview" : "A short overview of the product.",
"overviewHeadline" : "An overview headline.",
"partnerWorldCertifications" : [{
"readyForProgram" : "Ready for IBM Cloud",
"readyForSubprogram" : [string]
}],
"pictogram" : "https://www.example.com/pictogram.png",
"primaryCategory" : "Analytics",
"primaryCategoryTopic" : "cat.topic:WebAnalytics",
"productId" : "123AB45",
"productIds" : [string],
"productKey" : "IBM_20394857230948572",
"productPageName" : "product-abc",
"provider" : {
"contact" : "john.smith@ibm.com",
"name" : "IBM"
},
"publishedOn" : 1507661029,
"purchasePlans" : [{
"attributes" : [{
"description" : "1 user",
"id" : "XFEATURE_ABC_Users",
"name" : "Number of users",
"toolTip" : "Number of users"
}],
"currencySymbol" : "$",
"description" : "Get all the features of Free plus more storage and data sources, including databases and Twitter.",
"formattedPrice" : "$30.00 USD",
"id" : "01t50000004K1mfABC",
"inAppUrl" : "https://www.ibm.com/example/buy-more",
"label" : "Purchase now",
"name" : "Plus",
"prefix" : "Starting at",
"price" : "30.00",
"productId" : "123AB45",
"suffix" : "per month",
"supportsReferralsOnly" : "true",
"type" : "Buy",
"unit" : "USD",
"url" : "https://www.ibm.com/marketplace/purchase/sadirect/configure?locale=en_US&productId=example"
}],
"resources" : [{
"description" : "Data analysis technology enables immediate decisions, giving you a leg up on the competition.",
"name" : "23 reasons to get excited about data",
"type" : "Whitepapers",
"url" : "https://www.ibm.com/common/ssi/cgi-bin/ssialias?htmlfid=ASM12USEN"
}],
"screenshotUrl" : "https://1.www.s81c.com/8034F2C/dal05/v1/AUTH_db1cfc7b-a055-460b-9274-1fd3f11fe689/9e788878d94054b4a97b67a120521cce/offering_970cf3f3-2063-47f0-a9f0-ba55235f6d58.png",
"serviceType" : "Application",
"support" : {
"chat" : "Chat",
"email" : "help@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knowledgebase/product-abc",
"phone" : "1-888-555-1111",
"url" : "https://www.ibm.com/communities/analytics/product-abc/"
},
"topics" : [string],
"trialSupport" : {
"chat" : "Chat",
"email" : "trialhelp@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knoledgebase/product-abc-trial",
"phone" : "1-888-555-2222",
"url" : "https://www.ibm.com/communities/analytics/product-abc-trial"
},
"url" : "https://www.ibm.com/us-en/marketplace/product-abc"
},
"links" : {
"self" : string
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
404
Not found
{
"error" : {
"code" : 404,
"message" : "Not found"
}
}
422
Unprocessable entity
{
"error" : {
"code" : 422,
"message" : "Unprocessable entity"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Get a reseller product
GET /v2/catalog/reseller/products/{id}
https://api.ibm.com/marketplace/run/v2/catalog/reseller/products/{id}
Keys
Path and Query parameters
id
URL , required
The ID of the product
locale
STRING , required
Locale of the products
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/reseller/products/{id}?locale=string")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
OBJECT , required
Marketplace product
links
OBJECT , required
Links representing the response and references relating to the response
archived
BOOLEAN , optional
Flag indicating whether the product has been archived. An archived product no longer appears on the IBM Marketplace, but may still have existing orders or subscriptions against it.
availableForLocales
ARRAY , required
List of locales where this product will appear on the IBM Marketplace
benefits
ARRAY , optional
Key benefits of the product
businessUnit
STRING , optional
Business unit that the product belongs to. i.e. '3rd party' or 'generic'
category
ARRAY , optional
Categories the product belongs to
categoryTopics
ARRAY , optional
Category topics the product belongs to
contactModuleKey
STRING , optional
Name of LiveAdvisor or contact module for live chat and contact information
demoUrl
STRING , optional
Home URL for further information and content if the product is non-IBM based
description
STRING , optional
Description of the products features and benefits
hasTrialAvailable
BOOLEAN , optional
Flag indicating whether the product has a trial available
icon
STRING , optional
Company logo if the product is non-IBM
id
STRING , required
Unique identifier of the product
imageUrl
STRING , optional
Product overview image
isThirdParty
BOOLEAN , optional
Boolean value showing if a product is third party or not.
keywords
ARRAY , optional
Product keywords
kubernetes
ARRAY , optional
Indicates CloudPaks available for the product.
lastModified
INTEGER , optional
Date when this product's catalog data was last modified
locale
STRING , optional
Product locale
longDescription
STRING , optional
Description of the product
name
STRING , required
Name of product
naturalLanguageName
STRING , required
Name of product or shortened name of product if the product name is long
offeringHeadline
STRING , optional
Description of the product's most unique feature or benefit
overview
STRING , optional
Intro sentences for the product that initiate a compelling story about it's value proposition
overviewHeadline
STRING , optional
Marketing overview headline
partnerWorldCertifications
ARRAY , optional
Ready For program certifications.
pictogram
STRING , optional
Small image representing the categorization of the product
primaryCategory
STRING , optional
Primary category that the product belongs to
primaryCategoryTopic
STRING , optional
Primary category topic that the product belongs to
productId
STRING , optional
Used for backwards compatibility only. Please reference the productIds attribute instead.
productIds
ARRAY , optional
The unique product IDs for this product. This list represents the product IDs from the product's various purchasePlans.
productKey
STRING , required
Unique identifier of the product in IBM Marketplace.
productPageName
STRING , required
Name given to the IBM Marketplace product page. This is also the last directory from the product page URL path
provider
OBJECT , optional
Product provider
publishedOn
INTEGER , optional
Date when this product's catalog data originally published
purchasePlans
ARRAY , optional
Product purchase plans
resources
ARRAY , optional
Resources with more information about the product
screenshotUrl
STRING , optional
Product screenshot image
serviceType
STRING , optional
Type of service (e.g. Application, API, hardware, etc.)
support
OBJECT , optional
Support information for purchased products
topics
ARRAY , optional
Topics the product is tagged with. Topics are a subclassification of a product within categories.
trialSupport
OBJECT , optional
Support information for trial products
url
STRING , required
IBM Marketplace product page URL
description
STRING , optional
Description of each key benefit
title
STRING , optional
Title of each key benefit
readyForProgram
STRING , optional
Ready For program certifications for 3rd party solutions.
readyForSubprogram
ARRAY , optional
Ready For subprogram certifications for 3rd party solutions.
contact
STRING , optional
Provider's email address
name
STRING , optional
Name of the product provider (IBM for 1st party, company name for 3rd party)
attributes
ARRAY , optional
Features of the purchase plan
currencySymbol
STRING , optional
Price symbol
description
STRING , optional
Description of the purchase plan
formattedPrice
STRING , optional
List price including the symbol and unit (e.g. 99.00 USD)
id
STRING , optional
Unique identifier of the purchase plan
inAppUrl
STRING , optional
URL to IBM Marketplace checkout page to buy more of the specific purchase plan
label
STRING , optional
Purchase plan label (e.g. Purchase now)
name
STRING , optional
Name of the purchase plan (e.g. Free, Base, Professional)
prefix
STRING , optional
Price prefix (e.g. Starting at)
price
STRING , optional
List price for purchase plan
productId
STRING , optional
The unique product ID for this purchase plan
suffix
STRING , optional
Price suffix (e.g. per user)
supportsReferralsOnly
STRING , optional
If true, the purchased plan will be provisioned by a 3rd party company. If false, the purchased plan will be provisioned by IBM.
type
STRING , optional
Purchase plan type (e.g. Try or Buy)
unit
STRING , optional
Currency unit (e.g. USD, EUR)
url
STRING , optional
URL to IBM Marketplace checkout page to purchase the specific purchase plan
description
STRING , optional
Description of the purchase plan attribute
id
STRING , optional
Unique identifier of the purchase plan attribute
name
STRING , optional
Name of the purchase plan attribute
toolTip
STRING , optional
Tool tip for the purchase plan attribute
description
STRING , optional
Verbose description of the resource
name
STRING , optional
Name of resource
type
STRING , optional
Type of resource (e.g. Video, Whitepaper, Blog)
url
STRING , optional
URL to access resource
chat
STRING , optional
Chat URL to get support for the purchased product
STRING , optional
Email to get support for the purchased product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the purchased product
phone
STRING , optional
Phone number to get support for the purchased product
url
STRING , optional
URL to get support for the purchased product
chat
STRING , optional
Chat URL to get support for the trial product
STRING , optional
Email to get support for the trial product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the trial product
phone
STRING , optional
Phone number to get support for the trial product
url
STRING , optional
URL to get support for the trial product
self
STRING , optional
Url to self
400
Bad Request
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
500
Internal Server Error
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
Response example
200
Success
{
"data" : {
"archived" : false,
"availableForLocales" : [string],
"benefits" : [{
"description" : "Get insights in the office or on the go.",
"title" : "Improve your business"
}],
"businessUnit" : "Cloud",
"category" : [string],
"categoryTopics" : [string],
"contactModuleKey" : "Analytics",
"demoUrl" : "https://www.example.com/demo",
"description" : "A description of the product.",
"hasTrialAvailable" : true,
"icon" : "http://www.example.com/icon.jpg",
"id" : "34c03458eceefb2ca29cbb220545a1f67",
"imageUrl" : "https://www.example.com/icon.jpg",
"isThirdParty" : false,
"keywords" : [string],
"kubernetes" : [string],
"lastModified" : 1507661029,
"locale" : "en-us",
"longDescription" : "A long description of the product.",
"name" : "IBM Product ABC",
"naturalLanguageName" : "Product ABC",
"offeringHeadline" : "An offering headline",
"overview" : "A short overview of the product.",
"overviewHeadline" : "An overview headline.",
"partnerWorldCertifications" : [{
"readyForProgram" : "Ready for IBM Cloud",
"readyForSubprogram" : [string]
}],
"pictogram" : "https://www.example.com/pictogram.png",
"primaryCategory" : "Analytics",
"primaryCategoryTopic" : "cat.topic:WebAnalytics",
"productId" : "123AB45",
"productIds" : [string],
"productKey" : "IBM_20394857230948572",
"productPageName" : "product-abc",
"provider" : {
"contact" : "john.smith@ibm.com",
"name" : "IBM"
},
"publishedOn" : 1507661029,
"purchasePlans" : [{
"attributes" : [{
"description" : "1 user",
"id" : "XFEATURE_ABC_Users",
"name" : "Number of users",
"toolTip" : "Number of users"
}],
"currencySymbol" : "$",
"description" : "Get all the features of Free plus more storage and data sources, including databases and Twitter.",
"formattedPrice" : "$30.00 USD",
"id" : "01t50000004K1mfABC",
"inAppUrl" : "https://www.ibm.com/example/buy-more",
"label" : "Purchase now",
"name" : "Plus",
"prefix" : "Starting at",
"price" : "30.00",
"productId" : "123AB45",
"suffix" : "per month",
"supportsReferralsOnly" : "true",
"type" : "Buy",
"unit" : "USD",
"url" : "https://www.ibm.com/marketplace/purchase/sadirect/configure?locale=en_US&productId=example"
}],
"resources" : [{
"description" : "Data analysis technology enables immediate decisions, giving you a leg up on the competition.",
"name" : "23 reasons to get excited about data",
"type" : "Whitepapers",
"url" : "https://www.ibm.com/common/ssi/cgi-bin/ssialias?htmlfid=ASM12USEN"
}],
"screenshotUrl" : "https://1.www.s81c.com/8034F2C/dal05/v1/AUTH_db1cfc7b-a055-460b-9274-1fd3f11fe689/9e788878d94054b4a97b67a120521cce/offering_970cf3f3-2063-47f0-a9f0-ba55235f6d58.png",
"serviceType" : "Application",
"support" : {
"chat" : "Chat",
"email" : "help@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knowledgebase/product-abc",
"phone" : "1-888-555-1111",
"url" : "https://www.ibm.com/communities/analytics/product-abc/"
},
"topics" : [string],
"trialSupport" : {
"chat" : "Chat",
"email" : "trialhelp@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knoledgebase/product-abc-trial",
"phone" : "1-888-555-2222",
"url" : "https://www.ibm.com/communities/analytics/product-abc-trial"
},
"url" : "https://www.ibm.com/us-en/marketplace/product-abc"
},
"links" : {
"self" : string
}
}
400
Bad Request
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
500
Internal Server Error
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
Get plan configurations for a product
GET /v2/catalog/reseller/products/{id}/plans/{planId}/config
https://api.ibm.com/marketplace/run/v2/catalog/reseller/products/{id}/plans/{planId}/config
Keys
Path and Query parameters
id
URL , required
The ID of the product
planId
URL , required
ID of the plan
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/reseller/products/{id}/plans/{planId}/config")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
allowedPlanChanges
ARRAY , optional
String array that gives the list of all plans that this plan can be changed to
components
OBJECT , optional
Gives the list of part identifiers that this plan supports
isSubscriptionManagementAllowed
BOOLEAN , required
Boolean value that indicates if subscription management is allowed or not.
marketableCountries
ARRAY , optional
String array that gives the list of all marketable countries name.
supportsCancellation
BOOLEAN , optional
If true, then the order’s renewal type can be toggled on and off. If false, then the order’s renewal type can not be changed and cancelOperationAllowed attribute will always have NONE value. If this attribute is missing in API response, then by default order supports changing renewal type as long as order is in proper state for accepting renew changes.
type
STRING , required
Indicates the type of the product edition. It can be Try or Buy
allowedPartChanges
STRING , required
String array that specifies a list of components this component can be changed to
attributes
ARRAY , optional
List of attributes that are required to be passed
currencyCode
STRING , optional
Currency code of the listUnitPrice
description
STRING , required
A description for the component
name
STRING , required
Name of the component
partIdentifier
STRING , required
The identifier for the component to be ordered
partType
STRING , required
Has the values "bundle" or "option" to indicate if its either a base component or an add on.
required
BOOLEAN , required
Specifies if this component is required and should be passed as part of the line items in the order
attributeName
STRING , required
An identifier for the attribute
description
STRING , required
Description for the attribute
displayValues
ARRAY , optional
If provided, contains key-value pairs, where each key represent the text which should be displayed to user in user specific locale and corresponding value should be provided to create order API payload.
listUnitPrice
ARRAY , required
List unit price for the attribute. If the attribute is an enumeration then each value of the enumeration has a corresponding listUnitPrice
max
STRING , optional
Maximum value if the attribute is a number
min
STRING , optional
Minimum value if the attribute is a number
name
STRING , required
A display name for the attribute
optional
BOOLEAN , optional
By default the value is false. When false, this attribute is mandatory and the validations fail if not provided. If true, then this attibute is optional.
supportsOrderUpdates
BOOLEAN , optional
If true, then existing subscriptions of this plan can be updated (ie, upgrade to a different plan or increase quantity). If false, then the existing subscription can not be modified with the exception of cancellation
type
STRING , required
A type for the attributes. The allowed values are: a) text: A text value can be provided b) number: specifies that its a numeric value c) enumeration: Specifies that the attribute is an enumeration d) url: Specifies that value of attribute is a valid url e) email: Specifies that value of attribute is a valid email
unitOfMeasure
STRING , required
Unit of measure
values
STRING , optional
The list of allowed values for the attribute and this is provided if the attribute type is an enumeration.
Asia-Pacific
STRING , optional
Example Value populated for attribute displayValues
400
Bad Request
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
500
Internal Server Error
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
Response example
200
Success
{
"allowedPlanChanges" : [string],
"components" : {
"allowedPartChanges" : "D1BCWLL",
"attributes" : [{
"attributeName" : "item_qty",
"description" : string,
"displayValues" : [{
"Asia-Pacific" : "AP"
}],
"listUnitPrice" : ["50"],
"max" : "100",
"min" : "1",
"name" : string,
"optional" : false,
"supportsOrderUpdates" : true,
"type" : "number",
"unitOfMeasure" : "users",
"values" : string
}],
"currencyCode" : "USD",
"description" : string,
"name" : "IBM Watson Analytics",
"partIdentifier" : "D1BCYLL",
"partType" : "bundle",
"required" : true
},
"isSubscriptionManagementAllowed" : true,
"marketableCountries" : [string],
"supportsCancellation" : true,
"type" : "BUY"
}
400
Bad Request
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
500
Internal Server Error
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
Get product categories
GET /v2/catalog/categories
https://api.ibm.com/marketplace/run/v2/catalog/categories
Keys
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/categories")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of product categories
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
400
Bad Request
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : [string],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer
}
}
400
Bad Request
{
"error" : {
"code" : 400,
"message" : "Bad Request"
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Get product locales
GET /v2/catalog/locales
https://api.ibm.com/marketplace/run/v2/catalog/locales
Keys
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/locales")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of locales
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
400
Bad Request
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : [string],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer
}
}
400
Bad Request
{
"error" : {
"code" : 400,
"message" : "Bad Request"
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Get products
GET /v2/catalog/products
https://api.ibm.com/marketplace/run/v2/catalog/products
Keys
Path and Query parameters
category
STRING , optional
Filter products on category. Must be an exact match.
locale
STRING , required
Locale of the products
naturalLanguageName
STRING , optional
Filter products on natural language name. Must be an exact match.
page
INTEGER , optional
The page number to retrieve
pageSize
INTEGER , optional
The size of each page
primaryCategory
STRING , optional
Filter products on primary category. Must be an exact match.
productId
STRING , optional
Filter products on product ID. Must be an exact match.
provider.name
STRING , optional
Filter products on provider name. Must be an exact match.
serviceType
STRING , optional
Filter products on service type. Must be an exact match.
topics
STRING , optional
Filter products on topics. Must be an exact match.
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/products?locale=string&page=1&pageSize=10&naturalLanguageName=string&category=string&primaryCategory=string&topics=string&serviceType=string&productId=string&provider.name=string")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of products
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
archived
BOOLEAN , optional
Flag indicating whether the product has been archived. An archived product no longer appears on the IBM Marketplace, but may still have existing orders or subscriptions against it.
availableForLocales
ARRAY , required
List of locales where this product will appear on the IBM Marketplace
benefits
ARRAY , optional
Key benefits of the product
businessUnit
STRING , optional
Business unit that the product belongs to. i.e. '3rd party' or 'generic'
category
ARRAY , optional
Categories the product belongs to
categoryTopics
ARRAY , optional
Category topics the product belongs to
contactModuleKey
STRING , optional
Name of LiveAdvisor or contact module for live chat and contact information
demoUrl
STRING , optional
Home URL for further information and content if the product is non-IBM based
description
STRING , optional
Description of the products features and benefits
hasTrialAvailable
BOOLEAN , optional
Flag indicating whether the product has a trial available
icon
STRING , optional
Company logo if the product is non-IBM
id
STRING , required
Unique identifier of the product
imageUrl
STRING , optional
Product overview image
isThirdParty
BOOLEAN , optional
Boolean value showing if a product is third party or not.
keywords
ARRAY , optional
Product keywords
kubernetes
ARRAY , optional
Indicates CloudPaks available for the product.
lastModified
INTEGER , optional
Date when this product's catalog data was last modified
locale
STRING , optional
Product locale
longDescription
STRING , optional
Description of the product
name
STRING , required
Name of product
naturalLanguageName
STRING , required
Name of product or shortened name of product if the product name is long
offeringHeadline
STRING , optional
Description of the product's most unique feature or benefit
overview
STRING , optional
Intro sentences for the product that initiate a compelling story about it's value proposition
overviewHeadline
STRING , optional
Marketing overview headline
partnerWorldCertifications
ARRAY , optional
Ready For program certifications.
pictogram
STRING , optional
Small image representing the categorization of the product
primaryCategory
STRING , optional
Primary category that the product belongs to
primaryCategoryTopic
STRING , optional
Primary category topic that the product belongs to
productId
STRING , optional
Used for backwards compatibility only. Please reference the productIds attribute instead.
productIds
ARRAY , optional
The unique product IDs for this product. This list represents the product IDs from the product's various purchasePlans.
productKey
STRING , required
Unique identifier of the product in IBM Marketplace.
productPageName
STRING , required
Name given to the IBM Marketplace product page. This is also the last directory from the product page URL path
provider
OBJECT , optional
Product provider
publishedOn
INTEGER , optional
Date when this product's catalog data originally published
purchasePlans
ARRAY , optional
Product purchase plans
resources
ARRAY , optional
Resources with more information about the product
screenshotUrl
STRING , optional
Product screenshot image
serviceType
STRING , optional
Type of service (e.g. Application, API, hardware, etc.)
support
OBJECT , optional
Support information for purchased products
topics
ARRAY , optional
Topics the product is tagged with. Topics are a subclassification of a product within categories.
trialSupport
OBJECT , optional
Support information for trial products
url
STRING , required
IBM Marketplace product page URL
description
STRING , optional
Description of each key benefit
title
STRING , optional
Title of each key benefit
readyForProgram
STRING , optional
Ready For program certifications for 3rd party solutions.
readyForSubprogram
ARRAY , optional
Ready For subprogram certifications for 3rd party solutions.
contact
STRING , optional
Provider's email address
name
STRING , optional
Name of the product provider (IBM for 1st party, company name for 3rd party)
attributes
ARRAY , optional
Features of the purchase plan
currencySymbol
STRING , optional
Price symbol
description
STRING , optional
Description of the purchase plan
formattedPrice
STRING , optional
List price including the symbol and unit (e.g. 99.00 USD)
id
STRING , optional
Unique identifier of the purchase plan
inAppUrl
STRING , optional
URL to IBM Marketplace checkout page to buy more of the specific purchase plan
label
STRING , optional
Purchase plan label (e.g. Purchase now)
name
STRING , optional
Name of the purchase plan (e.g. Free, Base, Professional)
prefix
STRING , optional
Price prefix (e.g. Starting at)
price
STRING , optional
List price for purchase plan
productId
STRING , optional
The unique product ID for this purchase plan
suffix
STRING , optional
Price suffix (e.g. per user)
supportsReferralsOnly
STRING , optional
If true, the purchased plan will be provisioned by a 3rd party company. If false, the purchased plan will be provisioned by IBM.
type
STRING , optional
Purchase plan type (e.g. Try or Buy)
unit
STRING , optional
Currency unit (e.g. USD, EUR)
url
STRING , optional
URL to IBM Marketplace checkout page to purchase the specific purchase plan
description
STRING , optional
Description of the purchase plan attribute
id
STRING , optional
Unique identifier of the purchase plan attribute
name
STRING , optional
Name of the purchase plan attribute
toolTip
STRING , optional
Tool tip for the purchase plan attribute
description
STRING , optional
Verbose description of the resource
name
STRING , optional
Name of resource
type
STRING , optional
Type of resource (e.g. Video, Whitepaper, Blog)
url
STRING , optional
URL to access resource
chat
STRING , optional
Chat URL to get support for the purchased product
STRING , optional
Email to get support for the purchased product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the purchased product
phone
STRING , optional
Phone number to get support for the purchased product
url
STRING , optional
URL to get support for the purchased product
chat
STRING , optional
Chat URL to get support for the trial product
STRING , optional
Email to get support for the trial product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the trial product
phone
STRING , optional
Phone number to get support for the trial product
url
STRING , optional
URL to get support for the trial product
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
offset
INTEGER , required
The offset in the total count of the response data items
page
INTEGER , required
The page of the items returned
pageSize
INTEGER , required
The size of the page
pageTotal
INTEGER , optional
The total number of pages
total
INTEGER , optional
The total count of items available
400
Bad Request
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
422
Unprocessable entity
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : [{
"archived" : false,
"availableForLocales" : [string],
"benefits" : [{
"description" : "Get insights in the office or on the go.",
"title" : "Improve your business"
}],
"businessUnit" : "Cloud",
"category" : [string],
"categoryTopics" : [string],
"contactModuleKey" : "Analytics",
"demoUrl" : "https://www.example.com/demo",
"description" : "A description of the product.",
"hasTrialAvailable" : true,
"icon" : "http://www.example.com/icon.jpg",
"id" : "34c03458eceefb2ca29cbb220545a1f67",
"imageUrl" : "https://www.example.com/icon.jpg",
"isThirdParty" : false,
"keywords" : [string],
"kubernetes" : [string],
"lastModified" : 1507661029,
"locale" : "en-us",
"longDescription" : "A long description of the product.",
"name" : "IBM Product ABC",
"naturalLanguageName" : "Product ABC",
"offeringHeadline" : "An offering headline",
"overview" : "A short overview of the product.",
"overviewHeadline" : "An overview headline.",
"partnerWorldCertifications" : [{
"readyForProgram" : "Ready for IBM Cloud",
"readyForSubprogram" : [string]
}],
"pictogram" : "https://www.example.com/pictogram.png",
"primaryCategory" : "Analytics",
"primaryCategoryTopic" : "cat.topic:WebAnalytics",
"productId" : "123AB45",
"productIds" : [string],
"productKey" : "IBM_20394857230948572",
"productPageName" : "product-abc",
"provider" : {
"contact" : "john.smith@ibm.com",
"name" : "IBM"
},
"publishedOn" : 1507661029,
"purchasePlans" : [{
"attributes" : [{
"description" : "1 user",
"id" : "XFEATURE_ABC_Users",
"name" : "Number of users",
"toolTip" : "Number of users"
}],
"currencySymbol" : "$",
"description" : "Get all the features of Free plus more storage and data sources, including databases and Twitter.",
"formattedPrice" : "$30.00 USD",
"id" : "01t50000004K1mfABC",
"inAppUrl" : "https://www.ibm.com/example/buy-more",
"label" : "Purchase now",
"name" : "Plus",
"prefix" : "Starting at",
"price" : "30.00",
"productId" : "123AB45",
"suffix" : "per month",
"supportsReferralsOnly" : "true",
"type" : "Buy",
"unit" : "USD",
"url" : "https://www.ibm.com/marketplace/purchase/sadirect/configure?locale=en_US&productId=example"
}],
"resources" : [{
"description" : "Data analysis technology enables immediate decisions, giving you a leg up on the competition.",
"name" : "23 reasons to get excited about data",
"type" : "Whitepapers",
"url" : "https://www.ibm.com/common/ssi/cgi-bin/ssialias?htmlfid=ASM12USEN"
}],
"screenshotUrl" : "https://1.www.s81c.com/8034F2C/dal05/v1/AUTH_db1cfc7b-a055-460b-9274-1fd3f11fe689/9e788878d94054b4a97b67a120521cce/offering_970cf3f3-2063-47f0-a9f0-ba55235f6d58.png",
"serviceType" : "Application",
"support" : {
"chat" : "Chat",
"email" : "help@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knowledgebase/product-abc",
"phone" : "1-888-555-1111",
"url" : "https://www.ibm.com/communities/analytics/product-abc/"
},
"topics" : [string],
"trialSupport" : {
"chat" : "Chat",
"email" : "trialhelp@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knoledgebase/product-abc-trial",
"phone" : "1-888-555-2222",
"url" : "https://www.ibm.com/communities/analytics/product-abc-trial"
},
"url" : "https://www.ibm.com/us-en/marketplace/product-abc"
}],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer,
"offset" : integer,
"page" : integer,
"pageSize" : integer,
"pageTotal" : integer,
"total" : integer
}
}
400
Bad Request
{
"error" : {
"code" : 400,
"message" : "Bad Request"
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
422
Unprocessable entity
{
"error" : {
"code" : 422,
"message" : "Unprocessable entity"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Get product service types
GET /v2/catalog/service-types
https://api.ibm.com/marketplace/run/v2/catalog/service-types
Keys
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/service-types")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of product service types
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
400
Bad Request
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : [string],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer
}
}
400
Bad Request
{
"error" : {
"code" : 400,
"message" : "Bad Request"
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Get products for a reseller
GET /v2/catalog/reseller/products
https://api.ibm.com/marketplace/run/v2/catalog/reseller/products
Keys
Path and Query parameters
locale
STRING , required
Locale of the products
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/reseller/products?locale=string")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of products
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
archived
BOOLEAN , optional
Flag indicating whether the product has been archived. An archived product no longer appears on the IBM Marketplace, but may still have existing orders or subscriptions against it.
availableForLocales
ARRAY , required
List of locales where this product will appear on the IBM Marketplace
benefits
ARRAY , optional
Key benefits of the product
businessUnit
STRING , optional
Business unit that the product belongs to. i.e. '3rd party' or 'generic'
category
ARRAY , optional
Categories the product belongs to
categoryTopics
ARRAY , optional
Category topics the product belongs to
contactModuleKey
STRING , optional
Name of LiveAdvisor or contact module for live chat and contact information
demoUrl
STRING , optional
Home URL for further information and content if the product is non-IBM based
description
STRING , optional
Description of the products features and benefits
hasTrialAvailable
BOOLEAN , optional
Flag indicating whether the product has a trial available
icon
STRING , optional
Company logo if the product is non-IBM
id
STRING , required
Unique identifier of the product
imageUrl
STRING , optional
Product overview image
isThirdParty
BOOLEAN , optional
Boolean value showing if a product is third party or not.
keywords
ARRAY , optional
Product keywords
kubernetes
ARRAY , optional
Indicates CloudPaks available for the product.
lastModified
INTEGER , optional
Date when this product's catalog data was last modified
locale
STRING , optional
Product locale
longDescription
STRING , optional
Description of the product
name
STRING , required
Name of product
naturalLanguageName
STRING , required
Name of product or shortened name of product if the product name is long
offeringHeadline
STRING , optional
Description of the product's most unique feature or benefit
overview
STRING , optional
Intro sentences for the product that initiate a compelling story about it's value proposition
overviewHeadline
STRING , optional
Marketing overview headline
partnerWorldCertifications
ARRAY , optional
Ready For program certifications.
pictogram
STRING , optional
Small image representing the categorization of the product
primaryCategory
STRING , optional
Primary category that the product belongs to
primaryCategoryTopic
STRING , optional
Primary category topic that the product belongs to
productId
STRING , optional
Used for backwards compatibility only. Please reference the productIds attribute instead.
productIds
ARRAY , optional
The unique product IDs for this product. This list represents the product IDs from the product's various purchasePlans.
productKey
STRING , required
Unique identifier of the product in IBM Marketplace.
productPageName
STRING , required
Name given to the IBM Marketplace product page. This is also the last directory from the product page URL path
provider
OBJECT , optional
Product provider
publishedOn
INTEGER , optional
Date when this product's catalog data originally published
purchasePlans
ARRAY , optional
Product purchase plans
resources
ARRAY , optional
Resources with more information about the product
screenshotUrl
STRING , optional
Product screenshot image
serviceType
STRING , optional
Type of service (e.g. Application, API, hardware, etc.)
support
OBJECT , optional
Support information for purchased products
topics
ARRAY , optional
Topics the product is tagged with. Topics are a subclassification of a product within categories.
trialSupport
OBJECT , optional
Support information for trial products
url
STRING , required
IBM Marketplace product page URL
description
STRING , optional
Description of each key benefit
title
STRING , optional
Title of each key benefit
readyForProgram
STRING , optional
Ready For program certifications for 3rd party solutions.
readyForSubprogram
ARRAY , optional
Ready For subprogram certifications for 3rd party solutions.
contact
STRING , optional
Provider's email address
name
STRING , optional
Name of the product provider (IBM for 1st party, company name for 3rd party)
attributes
ARRAY , optional
Features of the purchase plan
currencySymbol
STRING , optional
Price symbol
description
STRING , optional
Description of the purchase plan
formattedPrice
STRING , optional
List price including the symbol and unit (e.g. 99.00 USD)
id
STRING , optional
Unique identifier of the purchase plan
inAppUrl
STRING , optional
URL to IBM Marketplace checkout page to buy more of the specific purchase plan
label
STRING , optional
Purchase plan label (e.g. Purchase now)
name
STRING , optional
Name of the purchase plan (e.g. Free, Base, Professional)
prefix
STRING , optional
Price prefix (e.g. Starting at)
price
STRING , optional
List price for purchase plan
productId
STRING , optional
The unique product ID for this purchase plan
suffix
STRING , optional
Price suffix (e.g. per user)
supportsReferralsOnly
STRING , optional
If true, the purchased plan will be provisioned by a 3rd party company. If false, the purchased plan will be provisioned by IBM.
type
STRING , optional
Purchase plan type (e.g. Try or Buy)
unit
STRING , optional
Currency unit (e.g. USD, EUR)
url
STRING , optional
URL to IBM Marketplace checkout page to purchase the specific purchase plan
description
STRING , optional
Description of the purchase plan attribute
id
STRING , optional
Unique identifier of the purchase plan attribute
name
STRING , optional
Name of the purchase plan attribute
toolTip
STRING , optional
Tool tip for the purchase plan attribute
description
STRING , optional
Verbose description of the resource
name
STRING , optional
Name of resource
type
STRING , optional
Type of resource (e.g. Video, Whitepaper, Blog)
url
STRING , optional
URL to access resource
chat
STRING , optional
Chat URL to get support for the purchased product
STRING , optional
Email to get support for the purchased product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the purchased product
phone
STRING , optional
Phone number to get support for the purchased product
url
STRING , optional
URL to get support for the purchased product
chat
STRING , optional
Chat URL to get support for the trial product
STRING , optional
Email to get support for the trial product
knowledgebaseUrl
STRING , optional
Knowledge base URL to get support for the trial product
phone
STRING , optional
Phone number to get support for the trial product
url
STRING , optional
URL to get support for the trial product
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
offset
INTEGER , required
The offset in the total count of the response data items
page
INTEGER , required
The page of the items returned
pageSize
INTEGER , required
The size of the page
pageTotal
INTEGER , optional
The total number of pages
total
INTEGER , optional
The total count of items available
400
Bad Request
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
500
Internal Server Error
Body
errorCode
STRING , required
Error code
errorMessage
OBJECT , required
Error message
Response example
200
Success
{
"data" : [{
"archived" : false,
"availableForLocales" : [string],
"benefits" : [{
"description" : "Get insights in the office or on the go.",
"title" : "Improve your business"
}],
"businessUnit" : "Cloud",
"category" : [string],
"categoryTopics" : [string],
"contactModuleKey" : "Analytics",
"demoUrl" : "https://www.example.com/demo",
"description" : "A description of the product.",
"hasTrialAvailable" : true,
"icon" : "http://www.example.com/icon.jpg",
"id" : "34c03458eceefb2ca29cbb220545a1f67",
"imageUrl" : "https://www.example.com/icon.jpg",
"isThirdParty" : false,
"keywords" : [string],
"kubernetes" : [string],
"lastModified" : 1507661029,
"locale" : "en-us",
"longDescription" : "A long description of the product.",
"name" : "IBM Product ABC",
"naturalLanguageName" : "Product ABC",
"offeringHeadline" : "An offering headline",
"overview" : "A short overview of the product.",
"overviewHeadline" : "An overview headline.",
"partnerWorldCertifications" : [{
"readyForProgram" : "Ready for IBM Cloud",
"readyForSubprogram" : [string]
}],
"pictogram" : "https://www.example.com/pictogram.png",
"primaryCategory" : "Analytics",
"primaryCategoryTopic" : "cat.topic:WebAnalytics",
"productId" : "123AB45",
"productIds" : [string],
"productKey" : "IBM_20394857230948572",
"productPageName" : "product-abc",
"provider" : {
"contact" : "john.smith@ibm.com",
"name" : "IBM"
},
"publishedOn" : 1507661029,
"purchasePlans" : [{
"attributes" : [{
"description" : "1 user",
"id" : "XFEATURE_ABC_Users",
"name" : "Number of users",
"toolTip" : "Number of users"
}],
"currencySymbol" : "$",
"description" : "Get all the features of Free plus more storage and data sources, including databases and Twitter.",
"formattedPrice" : "$30.00 USD",
"id" : "01t50000004K1mfABC",
"inAppUrl" : "https://www.ibm.com/example/buy-more",
"label" : "Purchase now",
"name" : "Plus",
"prefix" : "Starting at",
"price" : "30.00",
"productId" : "123AB45",
"suffix" : "per month",
"supportsReferralsOnly" : "true",
"type" : "Buy",
"unit" : "USD",
"url" : "https://www.ibm.com/marketplace/purchase/sadirect/configure?locale=en_US&productId=example"
}],
"resources" : [{
"description" : "Data analysis technology enables immediate decisions, giving you a leg up on the competition.",
"name" : "23 reasons to get excited about data",
"type" : "Whitepapers",
"url" : "https://www.ibm.com/common/ssi/cgi-bin/ssialias?htmlfid=ASM12USEN"
}],
"screenshotUrl" : "https://1.www.s81c.com/8034F2C/dal05/v1/AUTH_db1cfc7b-a055-460b-9274-1fd3f11fe689/9e788878d94054b4a97b67a120521cce/offering_970cf3f3-2063-47f0-a9f0-ba55235f6d58.png",
"serviceType" : "Application",
"support" : {
"chat" : "Chat",
"email" : "help@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knowledgebase/product-abc",
"phone" : "1-888-555-1111",
"url" : "https://www.ibm.com/communities/analytics/product-abc/"
},
"topics" : [string],
"trialSupport" : {
"chat" : "Chat",
"email" : "trialhelp@us.ibm.com",
"knowledgebaseUrl" : "https://www.ibm.com/knoledgebase/product-abc-trial",
"phone" : "1-888-555-2222",
"url" : "https://www.ibm.com/communities/analytics/product-abc-trial"
},
"url" : "https://www.ibm.com/us-en/marketplace/product-abc"
}],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer,
"offset" : integer,
"page" : integer,
"pageSize" : integer,
"pageTotal" : integer,
"total" : integer
}
}
400
Bad Request
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
500
Internal Server Error
{
"errorCode" : "MP0010E",
"errorMessage" : "This is an example error message"
}
Get product topics
GET /v2/catalog/topics
https://api.ibm.com/marketplace/run/v2/catalog/topics
Keys
Request code
HttpResponse<String> response = Unirest.get("https://api.ibm.com/marketplace/run/v2/catalog/topics")
.header("x-ibm-client-id", "REPLACE_KEY_VALUE")
.header("x-ibm-client-secret", "REPLACE_KEY_VALUE")
.asString();
Response model
200
Success
Body
data
ARRAY , required
An array of product topics
links
OBJECT , required
Links representing the response and references relating to the response
metadata
OBJECT , required
Metadata describing the response
first
STRING , optional
Url to the first page of items
last
STRING , optional
Url to the last page of items
next
STRING , optional
Url to the next page of items
prev
STRING , optional
Url to the previous page of items
self
STRING , required
Url to self
count
INTEGER , required
The count of items returned in the response data
400
Bad Request
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
401
Unauthorized
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
500
Internal Server Error
Body
error
OBJECT , required
code
INTEGER , required
HTTP Response Code
message
STRING , required
Error message
Response example
200
Success
{
"data" : [string],
"links" : {
"first" : string,
"last" : string,
"next" : string,
"prev" : string,
"self" : string
},
"metadata" : {
"count" : integer
}
}
400
Bad Request
{
"error" : {
"code" : 400,
"message" : "Bad Request"
}
}
401
Unauthorized
{
"error" : {
"code" : 401,
"message" : "Unauthorized"
}
}
500
Internal Server Error
{
"error" : {
"code" : 500,
"message" : "Internal Server Error"
}
}
Loading content...