Microsoft.Marketplace (stable:2025-01-01)

2025/04/08 • 45 new methods

PrivateStore_List (new)
Description :  Gets the list of available private stores.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores
{}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id ,
Required: False ,
}
string ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
collectionIds:
{
Description: Gets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
branding:
{
Description: Gets or sets list of branding characteristics ,
Required: False ,
}
object ,
notificationsSettings:
{
Description: Gets or sets notifications settings ,
Required: False ,
}
{
recipients:
{
Description: Gets or sets list of notified recipients for new requests ,
Required: False ,
}
[
{
principalId:
{
Description: Principal ID ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email Address ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
}
,
]
,
sendToAllMarketplaceAdmins:
{
Description: Gets or sets whether to send email to all marketplace admins for new requests ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PrivateStore list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Get (new)
Description :  Get information about the private store
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id ,
Required: False ,
}
string ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
collectionIds:
{
Description: Gets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
branding:
{
Description: Gets or sets list of branding characteristics ,
Required: False ,
}
object ,
notificationsSettings:
{
Description: Gets or sets notifications settings ,
Required: False ,
}
{
recipients:
{
Description: Gets or sets list of notified recipients for new requests ,
Required: False ,
}
[
{
principalId:
{
Description: Principal ID ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email Address ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
}
,
]
,
sendToAllMarketplaceAdmins:
{
Description: Gets or sets whether to send email to all marketplace admins for new requests ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateOrUpdate (new)
Description :  Changes private store properties
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The PrivateStore data structure. ,
Required: False ,
}
{
availability:
{
Description: Indicates private store availability ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
privateStoreId:
{
Description: Private Store id ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreName:
{
Description: Private Store Name ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant id ,
Required: False ,
}
string ,
isGov:
{
Description: Is government ,
Required: False ,
}
boolean ,
collectionIds:
{
Description: Gets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
branding:
{
Description: Gets or sets list of branding characteristics ,
Required: False ,
}
object ,
notificationsSettings:
{
Description: Gets or sets notifications settings ,
Required: False ,
}
{
recipients:
{
Description: Gets or sets list of notified recipients for new requests ,
Required: False ,
}
[
{
principalId:
{
Description: Principal ID ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email Address ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
}
,
]
,
sendToAllMarketplaceAdmins:
{
Description: Gets or sets whether to send email to all marketplace admins for new requests ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_Delete (new)
Description :  Deletes the private store. All that is not saved will be lost.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AnyExistingOffersInTheCollections (new)
Description :  Query whether exists any offer in the collections.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/anyExistingOffersInTheCollections
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Boolean answer, true if exists at least a single offer in an enabled collection, otherwise, false. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryOffers (new)
Description :  List of offers, regardless the collections
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryOffers
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PrivateStore list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryUserOffers (new)
Description :  List of user's approved offers for the provided offers and subscriptions
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryUserOffers
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Query user's offers details ,
Required: False ,
}
{
offerIds:
{
Description: List of offer IDs ,
Required: False ,
}
[
string ,
]
,
subscriptionIds:
{
Description: List of subscription IDs ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of PrivateStore list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
QueryUserRules (new)
Description :  All rules approved in the private store that are relevant for user subscriptions
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryUserRules
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Query user's rules details ,
Required: False ,
}
{
subscriptionIds:
{
Description: List of subscription IDs ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rules list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_BillingAccounts (new)
Description :  Tenant billing accounts names
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/billingAccounts
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
billingAccounts:
{
Description: Billing accounts list ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CollectionsToSubscriptionsMapping (new)
Description :  For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collectionsToSubscriptionsMapping
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Subscriptions ids list ,
Required: False ,
}
{
subscriptionIds:
{
Description: Subscriptions ids list ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
details:
{
Description: The map of collections subscriptions ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_List (new)
Description :  Gets private store collections list
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_Get (new)
Description :  Gets private store collection
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_CreateOrUpdate (new)
Description :  Create or update private store collection
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_Delete (new)
Description :  Delete a collection from the given private store.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_Post (new)
Description :  Delete Private store collection. This is a workaround.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}
{
payload:
{
Required: False ,
}
string ,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_TransferOffers (new)
Description :  transferring offers (copy or move) from source collection to target collection(s)
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/transferOffers
{
payload:
{
Required: False ,
}
{
properties:
{
Description: transfer offers properties details ,
Required: False ,
}
{
targetCollections:
{
Description: Target collections ids ,
Required: False ,
}
[
string ,
]
,
operation:
{
Description: Operation to perform (For example: Copy or Move) ,
Required: False ,
}
string ,
offerIdsList:
{
Description: Offers ids list to transfer from source collection to target collection(s) ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
succeeded:
{
Description: Succeeded collections ,
Required: False ,
}
[
{
collectionName:
{
Description: Collection name. ,
Required: False ,
}
string ,
collectionId:
{
Description: Collection id. ,
Required: False ,
}
string ,
}
,
]
,
failed:
{
Description: Failed collections ,
Required: False ,
}
[
{
collectionName:
{
Description: Collection name. ,
Required: False ,
}
string ,
collectionId:
{
Description: Collection id. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryApprovedPlans (new)
Description :  Get map of plans and related approved subscriptions.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryApprovedPlans
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Query approved plans details ,
Required: False ,
}
{
offerId:
{
Description: Offer id ,
Required: False ,
}
string ,
planIds:
{
Description: Offer plan ids ,
Required: False ,
}
[
string ,
]
,
subscriptionIds:
{
Description: List of subscription IDs ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
details:
{
Description: A list indicating for each plan which subscriptions are approved. Plan Id is unique ,
Required: False ,
}
[
{
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
subscriptionIds:
{
Description: Approved subscription ids list. In case all subscriptions are approved for a plan, allSubscriptions flag is true and list is empty ( else flag is set to false). In case both subscriptions list is empty and allSubscriptions flag is false, the plan is not approved for any subscription. ,
Required: False ,
}
[
string ,
]
,
allSubscriptions:
{
Description: Indicates whether all subscriptions are approved for this plan ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_BulkCollectionsAction (new)
Description :  Perform an action on bulk collections
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/bulkCollectionsAction
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: bulk collections properties details ,
Required: False ,
}
{
collectionIds:
{
Description: collection ids list that the action is performed on ,
Required: False ,
}
[
string ,
]
,
action:
{
Description: Action to perform (For example: EnableCollections, DisableCollections) ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
succeeded:
{
Description: Succeeded collections ,
Required: False ,
}
[
{
collectionName:
{
Description: Collection name. ,
Required: False ,
}
string ,
collectionId:
{
Description: Collection id. ,
Required: False ,
}
string ,
}
,
]
,
failed:
{
Description: Failed collections ,
Required: False ,
}
[
{
collectionName:
{
Description: Collection name. ,
Required: False ,
}
string ,
collectionId:
{
Description: Collection id. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_ApproveAllItems (new)
Description :  Delete all existing offers from the collection and enable approve all items.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/approveAllItems
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollection_DisableApproveAllItems (new)
Description :  Disable approve all items for the collection.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/disableApproveAllItems
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The collection data structure. ,
Required: False ,
}
{
collectionId:
{
Description: Gets collection Id. ,
Required: False ,
}
string ,
collectionName:
{
Description: Gets or sets collection name. ,
Required: False ,
}
string ,
claim:
{
Description: Gets or sets the association with Commercial's Billing Account. ,
Required: False ,
}
string ,
allSubscriptions:
{
Description: Indicating whether all subscriptions are selected (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItems:
{
Description: Indicating whether all items are approved for this collection (=true) or not (=false). ,
Required: False ,
}
boolean ,
approveAllItemsModifiedAt:
{
Description: Gets the modified date of all items approved. ,
Format: date-time ,
Required: False ,
}
string ,
subscriptionsList:
{
Description: Gets or sets subscription ids list. Empty list indicates all subscriptions are selected, null indicates no update is done, explicit list indicates the explicit selected subscriptions. On insert, null is considered as bad request ,
Required: False ,
}
[
string ,
]
,
enabled:
{
Description: Indicating whether the collection is enabled or disabled. ,
Required: False ,
}
boolean ,
numberOfOffers:
{
Description: Gets the number of offers associated with the collection. ,
Format: int64 ,
Required: False ,
}
integer ,
appliedRules:
{
Description: Gets list of collection rules ,
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_List (new)
Description :  Get a list of all private offers in the given private store and collection
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_ListByContexts (new)
Description :  Get a list of all offers in the given collection according to the required contexts.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/mapOffersToContexts
{
payload:
{
Required: False ,
}
{
properties:
{
Description: Subscriptions ids list ,
Required: False ,
}
{
subscriptionIds:
{
Description: Subscription ids list ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
context:
{
Description: Offer's context, e.g. subscription ID, tenant ID. ,
Required: False ,
}
string ,
offers:
{
Description: List of offers ,
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of offer list per context results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
SetCollectionRules (new)
Description :  Set rule for specific private store and collection
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/setRules
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
value:
{
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rules list results if there are any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
QueryRules (new)
Description :  Get a list of all private store rules in the given private store and collection
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/queryRules
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
type:
{
Description: Rule type ,
Enum:
{
PrivateProducts: No description available. ,
TermsAndCondition: No description available. ,
}
,
Required: False ,
}
enum ,
value:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of rules list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_Get (new)
Description :  Gets information about a specific offer.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_CreateOrUpdate (new)
Description :  Update or add an offer to a specific collection of the private store.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_Delete (new)
Description :  Deletes an offer from the given collection of private store.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_Post (new)
Description :  Delete Private store offer. This is a workaround.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}
{
payload:
{
Required: False ,
}
string ,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_ContextsView (new)
Description :  Retrieve offer information with plans under required contexts restrictions.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}/contextsView
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Subscriptions ids list ,
Required: False ,
}
{
subscriptionIds:
{
Description: Subscription ids list ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStoreCollectionOffer_UpsertOfferWithMultiContext (new)
Description :  Upsert an offer with multiple context details.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/collections/{collectionId}/offers/{offerId}/upsertOfferWithMultiContext
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
collectionId:
{
Description: The collection ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Object describes multiple context and plans. ,
Required: False ,
}
{
offerId:
{
Description: The offer ID which contains the plans. ,
Required: False ,
}
string ,
eTag:
{
Description: The offer's eTag. ,
Required: False ,
}
string ,
plansContext:
{
Required: False ,
}
[
{
context:
{
Description: Plan's context, e.g. subscription ID, tenant ID. ,
Required: False ,
}
string ,
planIds:
{
Description: List of plan IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore offer data structure. ,
Required: False ,
}
{
uniqueOfferId:
{
Description: Offers unique id ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: It will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
publisherDisplayName:
{
Description: Publisher name that will be displayed prominently in the marketplace ,
Required: False ,
}
string ,
eTag:
{
Description: Identifier for purposes of race condition ,
Required: False ,
}
string ,
privateStoreId:
{
Description: Private store unique id ,
Required: False ,
}
string ,
createdAt:
{
Description: Private store offer creation date ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Private store offer modification date ,
Required: False ,
}
string ,
specificPlanIdsLimitation:
{
Description: Plan ids limitation for this offer ,
Required: False ,
}
[
string ,
]
,
updateSuppressedDueIdempotence:
{
Description: Indicating whether the offer was not updated to db (true = not updated). If the allow list is identical to the existed one in db, the offer would not be updated. ,
Required: False ,
}
boolean ,
iconFileUris:
{
Description: Icon File Uris ,
Required: False ,
}
object ,
isStopSell:
{
Description: Indicating whether the offer is stop sell or not. ,
Required: False ,
}
boolean ,
plans:
{
Description: Offer plans ,
Required: False ,
}
[
{
skuId:
{
Description: Identifier for this plan ,
Required: False ,
}
string ,
planId:
{
Description: Text identifier for this plan ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Friendly name for the plan for display in the marketplace ,
Required: False ,
}
string ,
accessibility:
{
Description: Plan accessibility ,
Enum:
{
Unknown: No description available. ,
Public: No description available. ,
PrivateTenantOnLevel: No description available. ,
PrivateSubscriptionOnLevel: No description available. ,
}
,
Required: False ,
}
enum ,
altStackReference:
{
Description: Alternative stack type ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type (classic or arm) ,
Required: False ,
}
string ,
isStopSell:
{
Description: Indicating whether the plan is stop sell or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetApprovalRequestsList (new)
Description :  Get all open approval requests of current user
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets or sets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetRequestApproval (new)
Description :  Get open request approval details
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
requestApprovalId:
{
Description: The request approval ID to get create or update ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets or sets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_CreateApprovalRequest (new)
Description :  Create approval request
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}
{
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets or sets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
requestApprovalId:
{
Description: The request approval ID to get create or update ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
offerDisplayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
status:
{
Description: Gets the plan status ,
Enum:
{
Pending: No description available. ,
Rejected: No description available. ,
Approved: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
requestDate:
{
Description: Gets request date ,
Format: date-time ,
Required: False ,
}
string ,
justification:
{
Description: Gets or sets user's justification for the plan's request ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets or sets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets or sets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
isClosed:
{
Description: Gets a value indicating whether the request is closed ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the request approval message code ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryRequestApproval (new)
Description :  Get request statuses foreach plan, this api is used as a complex GET action.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/query
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
requestApprovalId:
{
Description: The request approval ID to get create or update ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: The details to get the request plans statuses ,
Required: False ,
}
{
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
planIds:
{
Description: Current plans list ,
Required: False ,
}
[
string ,
]
,
subscriptionId:
{
Description: Gets or sets the subscription id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
uniqueOfferId:
{
Description: Gets or sets unique offer id. ,
Required: False ,
}
string ,
plansDetails:
{
Description: Gets or sets the plans details ,
Required: False ,
}
object ,
etag:
{
Description: Gets or sets e-tag field ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AdminRequestApprovalsList (new)
Description :  Get list of admin request approvals
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
collectionIds:
{
Description: Gets or sets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
icon:
{
Description: The offer icon url. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of notifications list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_GetAdminRequestApproval (new)
Description :  Get open approval requests
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
adminRequestApprovalId:
{
Description: The admin request approval ID to get create or update ,
Required: True ,
}
string ,
publisherId:
{
Description: The publisher id of this offer. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
collectionIds:
{
Description: Gets or sets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
icon:
{
Description: The offer icon url. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_UpdateAdminRequestApproval (new)
Description :  Update the admin action, weather the request is approved or rejected and the approved plans
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/adminRequestApprovals/{adminRequestApprovalId}
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
adminRequestApprovalId:
{
Description: The admin request approval ID to get create or update ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
collectionIds:
{
Description: Gets or sets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
icon:
{
Description: The offer icon url. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The privateStore admin Approval request data structure. ,
Required: False ,
}
{
offerId:
{
Description: Gets or sets offer Id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher Id ,
Required: False ,
}
string ,
adminAction:
{
Description: Gets or sets admin action ,
Enum:
{
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
approvedPlans:
{
Description: Gets or sets Approved plans ids, empty in case of rejected ,
Required: False ,
}
[
string ,
]
,
comment:
{
Description: Gets or sets admin comment ,
Required: False ,
}
string ,
administrator:
{
Description: Gets or sets admin details ,
Required: False ,
}
string ,
plans:
{
Description: Gets list of plans with requesters details ,
Required: False ,
}
[
{
planId:
{
Description: Gets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets the plan display name ,
Required: False ,
}
string ,
requesters:
{
Description: Gets requesters details list ,
Required: False ,
}
[
{
user:
{
Description: Gets user id ,
Required: False ,
}
string ,
date:
{
Description: Gets request date ,
Required: False ,
}
string ,
justification:
{
Description: Gets justification ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Gets the subscription id that the user is requesting to add the plan to ,
Required: False ,
}
string ,
subscriptionName:
{
Description: Gets the subscription name that the user is requesting to add the plan to ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
collectionIds:
{
Description: Gets or sets list of associated collection ids ,
Required: False ,
}
[
string ,
]
,
icon:
{
Description: The offer icon url. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_QueryNotificationsState (new)
Description :  Get private store notifications state
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/queryNotificationsState
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
stopSellNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isEntire:
{
Description: Gets a value indicating whether entire offer is in stop sell or only few of its plans ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
newNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isFuturePlansEnabled:
{
Description: Gets a value indicating whether future plans is enabled. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
approvalRequests:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
publisherId:
{
Description: Gets or sets publisher id ,
Required: False ,
}
string ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_AcknowledgeOfferNotification (new)
Description :  Acknowledge notification for offer
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}/acknowledgeNotification
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
offerId:
{
Description: The offer ID to update or delete ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Notification update request payload details ,
Required: False ,
}
{
acknowledge:
{
Description: Gets or sets a value indicating whether acknowledge action flag is enabled ,
Required: False ,
}
boolean ,
dismiss:
{
Description: Gets or sets a value indicating whether dismiss action flag is enabled ,
Required: False ,
}
boolean ,
removeOffer:
{
Description: Gets or sets a value indicating whether remove offer action flag is enabled ,
Required: False ,
}
boolean ,
addPlans:
{
Description: Gets or sets added plans ,
Required: False ,
}
[
string ,
]
,
removePlans:
{
Description: Gets or sets remove plans ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_WithdrawPlan (new)
Description :  Withdraw a user request approval on specific plan
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/requestApprovals/{requestApprovalId}/withdrawPlan
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
requestApprovalId:
{
Description: The request approval ID to get create or update ,
Required: True ,
}
string ,
payload:
{
Required: False ,
}
{
properties:
{
Description: Withdraw properties details ,
Required: False ,
}
{
planId:
{
Description: Gets or sets Plan Id ,
Required: False ,
}
string ,
publisherId:
{
Description: The offer's publisher id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_FetchAllSubscriptionsInTenant (new)
Description :  Fetch all subscriptions in tenant, only for marketplace admin
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/fetchAllSubscriptionsInTenant
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
next-page-token:
{
Description: The skip token to get the next page. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of subscriptions. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
displayName:
{
Description: The subscription display name. ,
Required: False ,
}
string ,
state:
{
Description: The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. ,
Enum:
{
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
skipToken:
{
Description: The skip token to retrieve the next page. ,
Required: False ,
}
string ,
count:
{
Description: Number of subscriptions on the page ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_ListNewPlansNotifications (new)
Description :  List new plans notifications
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/listNewPlansNotifications
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
newPlansNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: Gets offer id ,
Required: False ,
}
string ,
displayName:
{
Description: Gets offer display name ,
Required: False ,
}
string ,
isFuturePlansEnabled:
{
Description: Gets a value indicating whether future plans is enabled. ,
Required: False ,
}
boolean ,
messageCode:
{
Description: Gets or sets the notification message id ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: Gets or sets the icon url ,
Required: False ,
}
string ,
plans:
{
Description: Gets or sets removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_ListStopSellOffersPlansNotifications (new)
Description :  List stop sell notifications for both stop sell offers and stop sell plans
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/listStopSellOffersPlansNotifications
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
stopSellSubscriptions:
{
Required: False ,
}
{
subscriptions:
{
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
stopSellNotifications:
{
Required: False ,
}
[
{
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
displayName:
{
Description: The offer display name ,
Required: False ,
}
string ,
isEntire:
{
Description: A value indicating whether entire offer is in stop sell or only few of its plans ,
Required: False ,
}
boolean ,
messageCode:
{
Description: The notification message code ,
Format: int64 ,
Required: False ,
}
integer ,
icon:
{
Description: The icon url ,
Required: False ,
}
string ,
plans:
{
Description: The list of removed plans notifications ,
Required: False ,
}
[
{
planId:
{
Description: Gets or sets the plan id ,
Required: False ,
}
string ,
planDisplayName:
{
Description: Gets or sets the plan display name ,
Required: False ,
}
string ,
}
,
]
,
publicContext:
{
Description: True if the offer has public plans ,
Required: False ,
}
boolean ,
subscriptionsIds:
{
Description: The subscriptions related to private plans ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
PrivateStore_ListSubscriptionsContext (new)
Description :  List all the subscriptions in the private store context
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Marketplace/privateStores/{privateStoreId}/listSubscriptionsContext
{
privateStoreId:
{
Description: The store ID - must use the tenant ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
subscriptionsIds:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Microsoft.Marketplace REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Marketplace/operations
{
api-version:
{
Description: The API version to use for the request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Marketplace operations supported by the Microsoft.Marketplace resource provider. ,
Required: False ,
}
[
{
id:
{
Description: Operation ID ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Marketplace ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed ,
Required: False ,
}
string ,
operation:
{
Description: Operation type ,
Required: False ,
}
string ,
description:
{
Description: Friendly description for the operation, ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the operation ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}