AppDirect AppResellerOpportunities API is one of 75 APIs that AppDirect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AppResellerOpportunities. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
23 operations
across 17 paths,
and defines 71 schemas.
It is described by OpenAPI 3.2.0, at version v296.0-SNAPSHOT.
Requests are made against 2 base URLs: https://marketplace.appdirect.com/api, https://virtserver.swaggerhub.com.
The identity and technical contract details declared by the specification.
CostType
string
Type of cost
CancellationPeriodUnit
string
Cancellation period unit. Time unit by which the contractCancellationPeriodLimit is measured.
UnitDefinition
object
Configuration details for a unit type that is part of a pricing plan
9 properties
OpportunityPage
object
2 properties
OpportunityCurrency
string
The currency using the ISO-4217 currency code
OpportunityErrorCode
string
The error code associated with the response
PriceRange
object
Price definition for an explicit unit range.
5 properties
2 required
OpportunityValidation
object
Failed and in-progress (pending) opportunity validations
2 properties
MinimumServiceLengthUnit
string
Time unit for contract length. This property must have the same value as the contract length unit configured for the pricing plan.
TotalRecurring
object
Represent recurring fee of a specfic billing cycle
4 properties
OpportunityPricingStrategy
string
Pricing strategy
OpportunityError
object
Opportunities API error description
4 properties
3 required
OpportunityShipping
object
Shipping information that applies to all physical goods on the opportunity
2 properties
Options
object
Field options
2 properties
PageMetadata
object
4 properties
4 required
CustomPrice
object
Custom price definition.
4 properties
2 required
Opportunity
object
14 properties
PriceRangeItem
object
2 properties
ProvisioningConfiguration
object
Determines when to send the service activation request to the vendor, either immediately after the opportunity is finalized (set the provisioning strategy to I…
2 properties
CostTypeCategory
string
Category of cost
RequiredFieldsUpdate
object
One or more items from the same vendor on an opportunity; and, the required fields and identical required field values to apply to all the items in the array.
2 properties
2 required
GracePeriodUnit
string
End-of-contract grace period unit. Time unit by which the endOfContractGracePeriod is measured.
AvailableAction
string
Only appears in responses. Actions that the API client has permission to complete for this opportunity. If an expected action does not appear in this list, che…
OpportunityItem
object
9 properties
CustomAttribute
object
Custom attributes as key-value pairs. Values must be a string array
PricingStrategy
string
Pricing strategy
TaxDetail
object
Opportunity tax detail
2 properties
OpportunityStatus
string
Opportunity status
ValidationDetail
object
Failed validation error codes and messages
4 properties
ContractConfiguration
object
Contract configuration options for subscriptions that customers purchase. For example: contract length and cancellation penalities.
16 properties
TerminationFeeAS
object
Termination fee
3 properties
Unit
object
Purchase item unit
2 properties
FeeType
string
Contract termination fee type
OpportunityClone
object
The response text containing the cloned opportunity ID.
1 property
ProvisioningStrategy
string
OpportunitySummary
object
Opportunity taxes, subtotals, totals and recurring totals
5 properties
OpportunityPricing
object
Pricing structure for an item
12 properties
6 required
OpportunityProduct
object
4 properties
BillingCycle
object
The billing cycle
2 properties
OpportunityUpdateRequest
object
3 properties
ActionRestriction
object
Only appear in opportunity call responses. Action restrictions occur when an opportunity does not meet a requirement for an available action to occur. After th…
1 property
RequiredFieldValidationDefinitions
object
Required field definitions. Used to validate field values.
5 properties
Suffix
object
The suffix label that appears to the right of the form field. For example, for a domain field, the suffix might be .com. Optional. The suffix can be populated…
2 properties
OpportunityLight
object
8 properties
OpportunityItemDetail
object
10 properties
PricingPlan
object
2 properties
DeliveryAddress
object
The shipping address
6 properties
Restriction
string
Opportunity action restrictions
OpportunityOwnerType
string
Opportunity owner type code
RequiredFields
object
Required field definitions for a specific product and edition
3 properties
OpportunityUpdateOwnerRequest
object
2 properties
2 required
RenewalConfiguration
string
Contract renewal configuration. Whether the contract is renewed and, if so, with what terms.
TerminationFeeGracePeriodUnit
string
Termination fee grace period unit. Time unit by which the terminationFeeGracePeriod is measured.
Field
object
8 properties
PricingPeriod
string
The pricing period. The billing frequency for the pricing plan.
OpportunityItemUpdateRequest
object
9 properties
2 required
ProductIds
object
A product ID and edition code
2 properties
2 required
PricingPlanCosts
object
Cost details of a pricing plan
4 properties
UnitContractTerms
object
Contract terms that restrict mid-contract quantity changes on subscriptions. unitTerms maps UnitContractTerms to a unit type (for example, user); enabled terms…
3 properties
Form
object
A group of required fields. Forms are used to organize required fields into meaningful groups.Required field definitions
5 properties
OpportunityCloneRequest
object
The parameters to be used when cloning the opportunity
7 properties
5 required
BillingConfiguration
object
Determines when the billing cycle starts. Set UPONSERVICEACTIVATION to start the billing cycle according to the specified provisioning strategy (either immedia…
2 properties
ValidationDetailParameter
object
Key value pairs for elements with failed validations and related error messages. For example, the name of a required field and the error message related to it
2 properties
Definition
object
Definition for flat/unit range prices.
2 properties
OpportunityErrorDetails
object
Additional error details returned after opportunity API call failure
3 properties
3 required
OpportunityCreationRequest
object
11 properties
5 required
Company
object
3 properties
DiscountRequest
object
Details about the discount to be applied to the product
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AppDirect publishes across the network.
