AppDirect Product API
The Product API from AppDirect — 8 operation(s) for product.
OpenAPI Specification
openapi: 3.0.0
info:
description: The Companies API allows developers to manage marketplace companies and their user memberships.
title: Companies AI Embed Product API
license:
name: Apache License, Version 2.0
url: http://www.apache.org/licenses/LICENSE-2.0
version: v296.0-SNAPSHOT
servers:
- url: https://marketplace.appdirect.com/api
- url: https://virtserver.swaggerhub.com
tags:
- name: Product
x-displayName: Products
paths:
/channel/v1/applications:
get:
description: Retrieve all products in the production catalog, including products that are not marked as visible on either the marketplace or network.
tags:
- Product
summary: Retrieve buyable products
x-appdirect-required-scopes:
ROLE_PARTNER_READ:
- Allows access to read all marketplace data.
ROLE_CHANNEL_ADMIN:
- Allows access as a Marketplace Manager for the marketplace.
ROLE_RESELLER_MANAGER:
- Allows access as a Reseller Manager for the marketplace.
ROLE_RESELLER:
- Allows access as a Reseller for the marketplace.
operationId: resource_Product_readProducts_GET
parameters:
- description: The page number. Defaults to 0.
name: page
in: query
schema:
type: string
default: '0'
- description: The maximum number of products to return. The default is 20.
name: size
in: query
schema:
type: string
default: '20'
- description: 'The field by which to sort results. The default is NAME. RATING: Sort by the rating in descending order. POPULARITY: Sort by product popularity, from most to least popular. Popularity is calculated from the number of purchases. NEWEST_FIRST: Sort by product creation date/time. NAME: Sort by the product name in alphabetic order.'
name: sortField
in: query
schema:
type: string
enum:
- RATING
- POPULARITY
- NEWEST_FIRST
- NAME
default: NAME
- description: Sort order, either ASC (ascending) or DESC (descending). The default is ASC.
name: sortOrder
in: query
schema:
type: string
enum:
- ASC
- DESC
default: ASC
- description: Search text.
name: searchText
in: query
schema:
type: string
- description: Product category IDs. If specified, only products belonging to these categories are returned.
name: categoryId
in: query
explode: true
schema:
type: array
items:
type: number
responses:
'200':
description: Success
headers:
X-Total-Count:
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/PagedProductListingWS'
examples:
response:
value:
links:
- rel: next
href: http://dockerdev.appdirect.com:8080/api/channel/v1/applications?page=1&size=3&sortField=NAME&sortOrder=ASC
content:
- href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/4644
id: 4644
uuid: cf6ab187-628b-4571-8089-d97319d68801
url: http://dockerdev.appdirect.com:8080/apps/4644/sb-platform-product-apphelp-business-cloud-helpdesk
name: '[SB] Platform Product AppHelp Business Cloud HelpDesk'
productType: WEB_APP
iconUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/thumbs_64/img5679336365844850048.png
profileLogoUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/thumbs_112/img7862680650740192899.png
iconSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/thumbs_64/img5679336365844850048.png
profileLogoSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/thumbs_112/img7862680650740192899.png
description: Whether you need advice on managing a SaaS or cloud application, deploying and configuring a backup system, or help setting up BYOD for the office, our Business Cloud HelpDesk experts are available 24x7x365 to assist with any cloud or IT support need your business has.
overview: As your business adopts more software and devices to operate and run, it's critical that you have access to quick, effective technical support to assist with the use and troubleshooting of your devices and cloud applications. AppHelp IT HelpDesk gives you an easy and affordable way to address SaaS and IT needs, without having to own your own IT staff. Need help installing software? Configuring backups? Recovering lost files? AppHelp IT HelpDesk has you covered
startingPrice: $60.00
channelStartingPrice:
prices:
MXN:
price: 0
duration: ONE_TIME
CAD:
price: 60
duration: ONE_TIME
USD:
price: 60
duration: ONE_TIME
EUR:
price: 60
duration: ONE_TIME
IDR:
price: 0
duration: ONE_TIME
GBP:
price: 60
duration: ONE_TIME
free: false
freeTrial: true
billingFrequency: ONE_TIME
publishedOn: 1519248071000
developerName: RP QA
vendorName: Appdirect
rating: null
numRatings: null
showRating: true
overviewImageUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/overview/img7694979340532479102.png
overviewImageSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4644/overview/img7694979340532479102.png
blurb: Support for cloud apps and devices
buyable: true
importable: false
free: false
freeTrialOrEditionPresent: true
referable: false
hasLyncToPhone: false
downloadFileSize: null
hidePricings: false
collectLeads: false
addon: false
featured: false
featuredSliderPosition: null
popular: false
popularity: null
staffPick: false
staffPickSliderPosition: null
discountDetails: null
lastModified: 1519248072000
sortRank: 3
tags:
- type: CATEGORY
id: 6
name: Web Development
badge: null
showBadge: false
showOnNavigation: true
children: []
description: null
bundleUrls: []
supportedLanguages:
- en
productRibbon: {}
merchandisingBadges: []
supportedCountries: []
links:
- rel: self
href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/4644?country=¤cy=
- href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/4645
id: 4645
uuid: 9b997bfc-c68c-4ee3-b9f2-66d634ee993f
url: http://dockerdev.appdirect.com:8080/apps/4645/uqa-platform-product-apphelp-business-cloud-helpdesk
name: '[UQA] Platform Product AppHelp Business Cloud HelpDesk'
productType: WEB_APP
iconUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/thumbs_64/img6332905770460652831.png
profileLogoUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/thumbs_112/img6663136721171420581.png
iconSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/thumbs_64/img6332905770460652831.png
profileLogoSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/thumbs_112/img6663136721171420581.png
description: Whether you need advice on managing a SaaS or cloud application, deploying and configuring a backup system, or help setting up BYOD for the office, our Business Cloud HelpDesk experts are available 24x7x365 to assist with any cloud or IT support need your business has.
overview: As your business adopts more software and devices to operate and run, it's critical that you have access to quick, effective technical support to assist with the use and troubleshooting of your devices and cloud applications. AppHelp IT HelpDesk gives you an easy and affordable way to address SaaS and IT needs, without having to own your own IT staff. Need help installing software? Configuring backups? Recovering lost files? AppHelp IT HelpDesk has you covered
startingPrice: $60.00
channelStartingPrice:
prices:
MXN:
price: 60
duration: ONE_TIME
CAD:
price: 60
duration: ONE_TIME
USD:
price: 60
duration: ONE_TIME
EUR:
price: 60
duration: ONE_TIME
IDR:
price: 0
duration: ONE_TIME
GBP:
price: 60
duration: ONE_TIME
free: false
freeTrial: true
billingFrequency: ONE_TIME
publishedOn: 1519248113000
developerName: AppHelp
vendorName: Appdirect
rating: null
numRatings: null
showRating: true
overviewImageUrl: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/overview/img6165482937306752085.png
overviewImageSrcset:
default: https://ad-dev-dump1.s3.amazonaws.com/app_resources/4645/overview/img6165482937306752085.png
blurb: Support for cloud apps and devices
buyable: true
importable: false
free: false
freeTrialOrEditionPresent: true
referable: false
hasLyncToPhone: false
downloadFileSize: null
hidePricings: false
collectLeads: false
addon: false
featured: false
featuredSliderPosition: null
popular: false
popularity: null
staffPick: false
staffPickSliderPosition: null
discountDetails: null
lastModified: 1519248114000
sortRank: 3
tags:
- type: CATEGORY
id: 6
name: Web Development
badge: null
showBadge: false
showOnNavigation: true
children: []
description: null
bundleUrls: []
supportedLanguages:
- en
productRibbon: {}
merchandisingBadges: []
supportedCountries: []
links:
- rel: self
href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/4645?country=¤cy=
- href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/3732
id: 3732
uuid: 531b7811-2372-47a3-8d04-40e66205d2db
url: http://dockerdev.appdirect.com:8080/apps/3732/1-month-contract-recurring-addon-v2
name: 1 Month Contract Recurring Addon V2
productType: WEB_APP
iconUrl: null
profileLogoUrl: null
iconSrcset: {}
profileLogoSrcset: {}
description: 1 Month Contract Recurring Addon V2
overview: null
startingPrice: ''
channelStartingPrice:
prices: {}
free: false
freeTrial: false
billingFrequency: MONTHLY
publishedOn: 1500463144000
developerName: developer+channeladmin
vendorName: developer+channeladmin
rating: null
numRatings: null
showRating: true
overviewImageUrl: null
overviewImageSrcset: {}
blurb: null
buyable: true
importable: false
free: false
freeTrialOrEditionPresent: false
referable: false
hasLyncToPhone: false
downloadFileSize: null
hidePricings: false
collectLeads: false
addon: true
featured: false
featuredSliderPosition: null
popular: false
popularity: 0
staffPick: false
staffPickSliderPosition: null
discountDetails: null
lastModified: 1500540244000
sortRank: 3
tags: []
bundleUrls: []
supportedLanguages:
- en
productRibbon: {}
merchandisingBadges: []
supportedCountries: []
links:
- rel: self
href: http://dockerdev.appdirect.com:8080/api/marketplace/v1/products/3732?country=¤cy=
page:
size: 3
totalElements: 932
totalPages: 311
number: 0
x-codeSamples:
- lang: Shell + Curl
source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/channel/v1/applications?page=SOME_STRING_VALUE&size=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&searchText=SOME_STRING_VALUE&categoryId=SOME_ARRAY_VALUE'"
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/channel/v1/applications',\n qs: {\n page: 'SOME_STRING_VALUE',\n size: 'SOME_STRING_VALUE',\n sortField: 'SOME_STRING_VALUE',\n sortOrder: 'SOME_STRING_VALUE',\n searchText: 'SOME_STRING_VALUE',\n categoryId: 'SOME_ARRAY_VALUE'\n }\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Java + Okhttp
source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/channel/v1/applications?page=SOME_STRING_VALUE&size=SOME_STRING_VALUE&sortField=SOME_STRING_VALUE&sortOrder=SOME_STRING_VALUE&searchText=SOME_STRING_VALUE&categoryId=SOME_ARRAY_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();"
/marketplace/v1/products/{applicationId}:
get:
description: This request returns all details about a specific product on your marketplace. The product in the response contains invisible editions if you are using OAuth to access the endpoint and the current user has either a Marketplace Manager role or a Sales Support role.</br>Maximum of 5 requests per second per caller.</br>To receive language-specific content in your response, ensure that your marketplace supports the specified language. Also ensure that you have a version of your product in the specified language.
tags:
- Product
summary: Retrieve a product
operationId: resource_Product_readProduct_GET
parameters:
- description: Application ID
name: applicationId
in: path
required: true
schema:
type: number
- description: Specify the locale context. Supports both web standard ISO format with hyphen (en-US) and Java standard format with underscore (en_US)
name: locale
in: query
schema:
type: string
responses:
'200':
description: product information
content:
application/json:
schema:
$ref: '#/components/schemas/ProductWS'
examples:
response:
value:
href: http://localhost/api/marketplace/v1/products/348
id: 348
uuid: c3775161-9ca4-4b5d-bf9f-3f8785063962
publishedApp: null
workingApp:
id: '347'
href: http://localhost/api/marketplace/v1/products/347
name: MockApp-4367741647933991053
type: WEB_APP
provider:
uuid: 4a74d22c-8391-4c8c-8fc5-807a193a613e
name: Appdirect
url: appdirect.com
listing:
myAppLogoIconUrl: null
imageUrl: null
profileImageUrl: null
blurb: App Blurb
overview: null
rating: null
reviewCount: 0
overview:
splashTitle: null
splashDescription: App Description
imageUrl: null
demoUrl: null
documentationUrl: null
downloadDocumentationUrl: null
systemRequirements: null
downloadFileSize: null
benefits: []
versions: {}
support:
email: null
phone: null
knowledgebaseUrl: null
description: null
privacyUrl: null
termsUrl: null
referUrl: null
hostedLocation: null
lastModified: 1461792768086
pricing:
pricingSummary: null
footnotes: []
bullets: []
editions:
- id: 348
uuid: e01e484b-4894-4136-8afc-8d1d50d8c04d
rank: 1
name: jEGpImFXPG
primary: false
trial:
length: 1
unit: MONTH
expiredTrialGracePeriod: null
bundleOnly: false
targetAudience: null
code: OS5WH
defaultFreeTrial: false
invisible: false
leadGen: false
lastModified: 1461792767969
revenueType: RECURRING
restricted: false
freeTrialDuration: 1
freeTrialType: MONTH
customerContractRestricted: false
plans:
- href: http://localhost/api/marketplace/v1/products/348/editions/348/paymentPlans/688
id: 688
uuid: null
frequency: MONTHLY
contract:
minimumServiceLength: 3
cancellationPeriodLimit: null
endOfContractGracePeriod: null
blockSwitchToShorterContract: false
blockContractDowngrades: false
blockContractUpgrades: false
gracePeriod: null
terminationFee: null
autoExtensionPricingId: 688
allowCustomUsage: false
keepBillDateOnUsageChange: false
separatePrepaid: false
isPrimaryPrice: false
costs:
- unit: USER
unitDependency: null
minUnits: 0
maxUnits: null
meteredUsage: false
increment: 1
pricePerIncrement: false
blockContractDecrease: false
blockContractIncrease: false
blockOriginalContractDecrease: false
amount:
USD: 10
discount: null
primaryPrice: false
- href: http://localhost/api/marketplace/v1/products/348/editions/348/paymentPlans/689
id: 689
uuid: null
frequency: MONTHLY
contract:
minimumServiceLength: 6
cancellationPeriodLimit: null
endOfContractGracePeriod: null
blockSwitchToShorterContract: false
blockContractDowngrades: false
blockContractUpgrades: false
gracePeriod: null
terminationFee: null
autoExtensionPricingId: 689
allowCustomUsage: false
keepBillDateOnUsageChange: false
separatePrepaid: false
isPrimaryPrice: false
costs:
- unit: USER
unitDependency: null
minUnits: 0
maxUnits: null
meteredUsage: false
increment: 1
pricePerIncrement: false
blockContractDecrease: false
blockContractIncrease: false
blockOriginalContractDecrease: false
amount:
USD: 10
discount: null
primaryPrice: false
bullets: []
items: []
customizations: []
publishedOn: 1461792767968
rating: null
numRatings: null
buyable: false
free: false
freeTrialOrEditionPresent: true
referable: false
hidePricings: false
collectLeads: false
collectLeadsWithPurchaseEnabled: false
newSubscriptionEnabled: true
changeSubscriptionAllowed: true
displayQuestions: true
displayReviews: true
oneClickPurchasable: false
autoUpgradeToPaid: false
downloadFileSize: null
startingPrice:
unit: USER
billingFrequency: MONTHLY
amount:
USD: 0
discount: null
highestPercentageDiscount: null
highestFixedDiscount: {}
bundledPlanIds: null
customIntegration: null
usageType: MULTI_USER
linkedImportableApplicationUuid: null
liveChatEnabled: false
liveChatAvailable: false
resources: []
screenshots: []
addonOfferings: []
featuredCustomers: []
featuredMedia: []
features: []
tags: []
supportedLanguages:
- en
orderFormFields: []
application/xml:
schema:
$ref: '#/components/schemas/ProductWS'
'429':
description: Too many requests
x-codeSamples:
- lang: Shell + Curl
source: "curl --request GET \\\n --url 'https://marketplace.appdirect.com/api/marketplace/v1/products/%7BapplicationId%7D?locale=SOME_STRING_VALUE'"
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/marketplace/v1/products/%7BapplicationId%7D',\n qs: {locale: 'SOME_STRING_VALUE'}\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Java + Okhttp
source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/marketplace/v1/products/%7BapplicationId%7D?locale=SOME_STRING_VALUE\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();"
/marketplace/v1/vendors/{vendorUuid}/products:
get:
description: Lists all products offered by the specified vendor. On the product profile page, the results appear in the Related Products list, in ascending order by product ID. To retrieve the vendor ID, use the [List all companies](#list-all-companies) endpoint (vendor companies have the "vendor" property set to "true").
tags:
- Product
summary: List all products by vendor
operationId: resource_Product_readVendorProducts_GET
parameters:
- description: ID of the vendor company
name: vendorUuid
in: path
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
description: Success
type: array
items:
$ref: '#/components/schemas/ProductListingWS'
examples:
response:
value:
- href: http://localhost/api/marketplace/v1/products/365
id: 365
uuid: f7a480c9-ddaf-4645-bbf2-94cdf94a476a
url: http://localhost/apps/365
name: MockApp3254535959504925520
productType: WEB_APP
iconUrl: null
profileLogoUrl: null
description: App Description
overview: null
startingPrice: $0.00/User/Mo
billingFrequency: MONTHLY
publishedOn: 1461792770306
developerName: Appdirect
vendorName: Appdirect
rating: null
numRatings: null
overviewImageUrl: null
blurb: App Blurb
buyable: false
free: false
freeTrialOrEditionPresent: true
referable: false
hasLyncToPhone: false
downloadFileSize: null
hidePricings: false
collectLeads: false
addon: false
featured: false
featuredSliderPosition: null
popular: false
popularity: null
staffPick: false
staffPickSliderPosition: null
discountDetails: null
lastModified: 1461792770406
sortRank: 5
tags: []
bundleUrls: []
supportedLanguages:
- en
application/xml:
schema:
description: Success
type: array
items:
$ref: '#/components/schemas/ProductListingWS'
'404':
description: Vendor not found
content:
application/json:
examples:
response:
value: {}
x-codeSamples:
- lang: Shell + Curl
source: "curl --request GET \\\n --url https://marketplace.appdirect.com/api/marketplace/v1/vendors/%7BvendorUuid%7D/products"
- lang: Node + Request
source: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'https://marketplace.appdirect.com/api/marketplace/v1/vendors/%7BvendorUuid%7D/products'\n};\n\nrequest(options, function (error, response, body) {\n if (error) throw new Error(error);\n\n console.log(body);\n});\n"
- lang: Java + Okhttp
source: "OkHttpClient client = new OkHttpClient();\n\nRequest request = new Request.Builder()\n .url(\"https://marketplace.appdirect.com/api/marketplace/v1/vendors/%7BvendorUuid%7D/products\")\n .get()\n .build();\n\nResponse response = client.newCall(request).execute();"
/marketplace/v1/products/{applicationId}/status:
get:
description: This call returns the status of a product on your marketplace.
tags:
- Product
summary: Retrieve a product status
operationId: resource_Product_readStatus_GET
parameters:
- description: Application id
name: applicationId
in: path
required: true
schema:
type: number
responses:
'200':
description: products status
content:
application/json:
schema:
$ref: '#/components/schemas/StatusWS'
examples:
response:
value:
assigned: false
pending: false
requested: false
pendingAppType: SUGGESTED
companyEntitlementId: null
editionId: null
ownerUuid: null
ownerFullName: null
ownerAdmin: false
partOfExistingBundle: false
companyEntitlementPending: fal
# --- truncated at 32 KB (209 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appdirect/refs/heads/main/openapi/appdirect-product-api-openapi.yml