Products, payment plans and discounts

In order to understand what products are available for purchase, what editions each of these products offer, and the discounts available for these products, it is important to know about a few more AppDirect API methods. The methods described below will allow you to get the paymentPlanId and discountId necessary to create a subscription through the API. Note that these ids are also available through the UI.

Read product list

The Product Listing API returns all products within the marketplace catalog and information about respective products.  Additional information can be found here.

URL endpoint: /api/marketplace/v1/listing

Method: GET

Parameters: You can use all supported parameters in combination, as in this example that combines 'q' and 'count' -- https://www.mymarketplace.com/api/marketplace/v1/listing?q=sampleapp&count=5

Parameter	Description
type	Set of: WEB_APP, WEB_APP_MANUAL_SETUP, TEMPLATE, DESIGN_ELEMENT, MODULE, EMBEDDED_VIDEO, BUNDLE, DOWNLOADABLE_BUNDLE
filters	Set of: FEATURED, POPULAR, STAFFPICK, FREE, PAID
order	Order of which apps will be displayed. One of: NEWEST_FIRST, ALPHABETICAL, POPULARITY
count	Number of products returned
c	Query category IDs
s	Query subcategory IDs
i	Query customer IDs
a	Query attribue IDs
q	Query search string

HTTP Status Codes: 200 OK on success

Read product

The Read Product API returns the full details of a product in order to show the product profile on the marketplace.  Additional information can be found here.

URL endpoint: /api/marketplace/v1/products/<applicationId>

Method: GET

Parameters: <applicationId> the unique product identifier provided by the channel

HTTP Status Codes: 200 OK on success; 404 Not Found if no product with the specified productId exists in the system.

List discounts

The Discount Listing API returns all discounts available within the marketplace. Additional information can be found here.

URL endpoint: /api/channel/v1/discounts/listing

Method: GET

Parameters: The optional parameters are shown below.

Parameter	Description
code	4-255 characters
sortField	CODE, APPLICATION, REDEMPTIONS, START_DATE, END_DATE, or CREATED_ON; defaults to CREATED_ON
sortOrder	ASC or DESC; defaults to ASC
start	Integer values; defaults to 0
count	0-250; defaults to 250

HTTP Status Codes: 200 OK on success